C

SnapReference
abstract

A snap reference represents a reference to which other items (lines or points) snap during interactive movements.
Inheritance Hierarchy

Remarks

GraphSnapContext makes use of this class to interactively snap moving elements to snap references.

Members

Show:

Constructors

Creates a new snap reference using the provided attributes.
protected

Parameters

weight?: number
The weight (importance) of this snap reference. If more than one snap reference is snapped to, the one with the greater weight will be used.
snappableItems?: GraphItemTypes
The graph item types that may snap to this snap reference.
tag?: any
A tag that is associated with this snap reference - see tag for a typical use of this value.

Properties

Gets which types of items may snap to this snap reference.
readonlyfinal
Gets the tag that is associated with this snap reference.
The tag is most commonly used for the snap result tag.
readonlyfinal
Gets the weight/importance of this snap reference.
Greater values indicate greater importance.
readonlyfinal