Defines how ViewportLimiter should limit the suggested viewport.
Remarks
This policy defines how viewport limits should be treated if the current viewport is not within the limits.
Type Details
- yFiles module
- view
Constants
If the current viewport lies outside the bounds the ViewportLimiter allows for changes towards the bounds but forbids changes away from them.
Remarks
In case the viewport happens to be outside the limits, all following viewport changes will be forced to move the viewport in the direction of the limits.
While the viewport will not comply with the limits right away, this policy avoids the visible "jump" which can happen with the STRICT policy.
This policy strictly limits the viewport to ensure that bounds always is contained at least within the viewportContentMargins.
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 - ViewportLimitingPolicy
- The value to convert to an enum constant.
Returns
- ↪ViewportLimitingPolicy
- 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 - ViewportLimitingPolicy
- 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.