E

ViewportLimitingPolicy

Show Usages
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.

Members

No filters for this type

Constants

STRICT

static
Strictly applies the bounds.
In case the viewport happens to be outside the limits, this might result in a noticeable "jump" upon the first pan or zoom gesture.
static

See Also

Developer's Guide

TOWARDS_LIMIT

static
If the current viewport lies outside the bounds the ViewportLimiter allows for changes towards the bounds but forbids changes away from them.

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.

static

See Also

Developer's Guide

UNRESTRICTED

static
This policy basically disables limiting of the viewport.
static

See Also

Developer's Guide

WITHIN_MARGINS

static
This policy strictly limits the viewport to ensure that bounds always is contained at least within the viewportContentMargins.
static

See Also

Developer's Guide

Static Methods

from

(value: ViewportLimitingPolicy): ViewportLimitingPolicy
static
Converts the given argument to an enum constant of this enum type.
Most notably, this method can convert an enum constant's name into the enum constant itself.
static

Parameters

value: ViewportLimitingPolicy
The value to convert to an enum constant.

Return Value

ViewportLimitingPolicy
The enum constant that corresponds to the given argument.

getName

(value: ViewportLimitingPolicy): string
static
Returns the name of the given enum constant.
static

Parameters

value: ViewportLimitingPolicy
The numeric value of an enum constant.

Return Value

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.