Specifies the mode used by the viewport limiter in the limitViewport call.
Remarks
Callers of limitViewport use this to communicate their intent and the purpose of the limiting.
Type Details
- yFiles module
- view
Constants
When the CanvasComponent was resized externally, which affects the viewport and possibly requires calculating new limits or adjusting the viewport.
When the bounds or contentBounds changed to give the limiter a chance to react to the new bounds.
Potentially larger navigation steps towards a known or anticipated target, like keyboard navigation, "zoom to item", or for calculating scrollbar large increments.
Remarks
This will be used to calculate end points for an animated pan/page scroll, too, but not the intermediate steps.
Calculating a specific target viewport regardless of the current viewport.
Remarks
E.g. to compute the limited target bounds for a viewport animation during layout, or for "fit content". Similar to interactive navigation, but not triggered by an immediate user gesture that directly interacts with the viewport. Typically used to calculate the end point of an animation, where both viewpoint and zoom change.
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 - ViewportLimitingMode
- The value to convert to an enum constant.
Returns
- ↪ViewportLimitingMode
- 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 - ViewportLimitingMode
- 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.