Determines the policy whether and how Visuals are cached when they are removed temporarily from the CanvasComponent's render tree.
Remarks
Visuals are temporarily removed when they are moved outside the visual part of the canvas (the viewport) and re-added when they enter the viewport again. Caching prevents the need to re-build the visuals from scratch.
In order to be cached a dispose visual callback has to be registered during creation.
Type Details
- yFiles module
- view
See Also
Constants
Visuals will always be cached.
Remarks
The cached reference will be kept until the corresponding IRenderTreeElement is removed.
Disables caching of Visuals completely.
Static Methods
Converts the given argument to an enum constant of this enum type.
Remarks
Most notably, this method can convert an enum constant's name into the enum constant itself.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - VisualCachingPolicy
- The value to convert to an enum constant.
Returns
- ↪VisualCachingPolicy
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - VisualCachingPolicy
- The numeric value of an enum constant.
Returns
- ↪string
- The name of the enum constant.
Throws
- Exception({ name: 'Error' })
- If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.