documentationfor yFiles for HTML 3.0.0.3

Usages of SnapReference

Properties

snapReferencesin GraphSnapContextGets the collection of snapReferences other than OrthogonalSnapLines.
referencein SnapResultGets the reference instance that was used to create this result.

Method Parameters

addSnapReference (SnapReference)in CollectSnapReferencesEventArgsAdds a snap reference for the GraphSnapContext.
SnapResult (SnapConstraint, number, any?, IModelItem?, Point?, SnapReference?, IObjectRenderer<SnapResult>?)in SnapResultInitializes the tag, weight and constraint with the given values.
createSnapResult (SnapConstraint, number, any?, IModelItem?, Point?, SnapReference?, IObjectRenderer<SnapResult>?)in SnapResultFactory method that creates a SnapResult using the given constraint.

Extending Types

SnapCircleA SnapCircle represents a circle in the world coordinate system to which other items snap during interactive movements.
SnapGridA SnapReference to snap to locations on a grid.
SnapLineA snap line is a line segment in the world coordinate system to which other items (lines or points) snap during interactive movements.
SnapSizeA SnapReference to snap the width or height of an item to the size of other rectangles.