documentationfor yFiles for HTML 2.6

SnapPolicy

The policy constants used by IGridConstraintProvider<T>

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.input.SnapPolicy

Constants

NO_SNAPPING

: number

Don't perform snapping.

TO_GREATER

: number

Snap to the nearest grid coordinate whose value is not less than the current coordinate.

TO_NEAREST

: number

Snap to the nearest grid coordinate.

TO_SMALLER

: number

Snap to the nearest grid coordinate whose value is not greater than the current coordinate.

Static Methods

from

(value: SnapPolicy) : SnapPolicy

Converts the argument to SnapPolicy.

Parameters

options - Object
A map of options to pass to the method.

value - SnapPolicy: The value to convert to SnapPolicy.

Returns

↪SnapPolicy: Either value if it is already a SnapPolicy or an appropriate converted value.