Package | com.yworks.graph.input.snapLines |
Class | public class NodeBasedSnapLine |
Inheritance | NodeBasedSnapLine SnapLine Object |
SnapLine
that carries an INode
as additional information
that can be used for the visualization.
See also
Property | Defined By | ||
---|---|---|---|
coordinates : IPoint [read-only]
The coordinates of the center point of the snap line. | SnapLine | ||
from : Number
The smaller value of the coordinate that delimits this snap line. | SnapLine | ||
node : INode [read-only]
The node that is associated with this snap line. | NodeBasedSnapLine | ||
orientation : SnapLineOrientation [read-only]
The orientation of the snap line as defined in SnapLineOrientation. | SnapLine | ||
resourceKey : ResourceKey [read-only]
The resource key which determines the visual appearance of the snap line. | SnapLine | ||
snapType : uint [read-only]
The type of the line that describes how other items will snap to this line. | SnapLine | ||
tag : Object [read-only]
The tag that is associated with this snap line. | SnapLine | ||
to : Number
The greater value of the coordinate that delimits this snap line. | SnapLine | ||
weight : Number [read-only]
The weight/importance of this snap line. | SnapLine |
Method | Defined By | ||
---|---|---|---|
NodeBasedSnapLine(node:INode, orientation:SnapLineOrientation, snapType:uint, resourceKey:ResourceKey, coordinates:IPoint, tag:Object, weight:Number, from:Number, to:Number)
Initializes a new instance of the NodeBasedSnapLine class. | NodeBasedSnapLine |
node | property |
node:INode
[read-only] The node that is associated with this snap line. Usually this is the instance that induced this snap line.
public function get node():INode
NodeBasedSnapLine | () | Constructor |
public function NodeBasedSnapLine(node:INode, orientation:SnapLineOrientation, snapType:uint, resourceKey:ResourceKey, coordinates:IPoint, tag:Object, weight:Number, from:Number, to:Number)
Initializes a new instance of the NodeBasedSnapLine
class.
node:INode — The node to assign to node .
| |
orientation:SnapLineOrientation — The orientation of the snap line. This is one of SnapLineOrientation.HORIZONTAL
or SnapLineOrientation.VERTICAL .
| |
snapType:uint — The type of the line that describes how other items will snap to this line.
This is one of SnapLineSnapType.TOP , SnapLineSnapType.BOTTOM ,
SnapLineSnapType.LEFT , SnapLineSnapType.RIGHT or SnapLineSnapType.CENTER .
| |
resourceKey:ResourceKey — A resource key which determines the visual representation of this snap line.
| |
coordinates:IPoint — The coordinates of the center point of the snap line.
| |
tag:Object — A tag that is associated with this snap line - see SnapLine.tag for a typical use of this value.
| |
weight:Number — The weight (importance) of this snap line. If more than one snap line is snapped to, the one
with the greater weight will be used.
| |
from:Number (default = NaN ) — The smaller value of the coordinate that delimits this snap line.
| |
to:Number (default = NaN ) — The greater value of the coordinate that delimits this snap line.
|
See also