I

ILabelOwnerGridConstraintProvider

Show Usages
This is a flagging interface for instances of IGridConstraintProvider<T> that can snap coordinates of ILabelOwners to a grid.

Remarks

An implementation of this interface can be queried using the lookup of a IInputModeContext.

Members

Show:

Properties

gridOrigin

: Point
readonlyabstract
Gets the canonical origin of the grid.
readonlyabstract

horizontalGridWidth

: number
readonlyabstract
Gets the canonical grid width in horizontal direction.
readonlyabstract

verticalGridWidth

: number
readonlyabstract
Gets the canonical grid width in vertical direction.
readonlyabstract

Methods

snapToGrid

(
context: IInputModeContext
item: ILabelOwner
location: IMutablePoint
xSnapPolicy: SnapPolicy
ySnapPolicy: SnapPolicy
): boolean
abstract
Performs the actual snapping to grid coordinates.
abstract

Parameters

context: IInputModeContext
The context in which the snapping should occur.
item: ILabelOwner
The item of which the coordinates should be snapped.
location: IMutablePoint
The coordinates to snap.
xSnapPolicy: SnapPolicy
The policy for the x-coordinate.
ySnapPolicy: SnapPolicy
The policy for the y-coordinate.

Return Value

boolean
Whether the point has been snapped.

Static Methods

static

Parameters

Return Value

ILabelOwnerGridConstraintProvider