LayoutVertex$Typings extension
Properties
-
bounds
↔ Rect
-
Gets or sets the bounds of this vertex, in document coordinates.
Setting this property does not directly modify the position of any Node,
but it will modify the value of #centerX and #centerY,
as well as the subsidiary convenience properties #x, #y, #width, and #height.
getter/setter pair
-
centerX
↔ num
-
Gets or sets the center Point#x of this vertex, in document coordinates.
This property depends on both #bounds and #focus.
Setting this property does not modify the position of any Node,
but it will modify the value of #bounds.
getter/setter pair
-
centerY
↔ num
-
Gets or sets the center Point#y of this vertex, in document coordinates.
This property depends on both #bounds and #focus.
Setting this property does not modify the position of any Node,
but it will modify the value of #bounds.
getter/setter pair
-
data
↔ Object?
-
Gets or sets the data object in the model that should be associated with this vertex, if any.
The value will be non-null if this vertex is virtualized,
not represented by a real Node in the Diagram.
Each data object should have a 'bounds' property that is a Rect
or any JavaScript Object with 'x', 'y', 'width', and 'height' properties that are real numbers,
and non-negative numbers for the width and the height.
Setting this data property will also set the #bounds and #focus properties.
getter/setter pair
-
destinationEdges
↔ Iterator<LayoutEdge>
-
This read-only property returns an iterator for all of the edges that go out of this vertex.
getter/setter pair
-
destinationEdgesArrayAccess
↔ Array<LayoutEdge>
-
(undocumented)
getter/setter pair
-
destinationVertexes
↔ Iterator<LayoutVertex>
-
This read-only property returns an iterator for all of the vertexes that are connected with edges going out of this vertex.
getter/setter pair
-
edges
↔ Iterator<LayoutEdge>
-
This read-only property returns an iterator for all of the edges that are connected with this vertex in either direction.
getter/setter pair
-
edgesCount
↔ num
-
This read-only property returns the total number of edges that are connected with this vertex in either direction.
getter/setter pair
-
focus
↔ Point
-
Gets or sets the offset of the #focusX and #focusY
from the #bounds position.
Setting this property does not directly modify the position of any Node,
but it does affect the value of #centerX and #centerY.
getter/setter pair
-
focusX
↔ num
-
Gets or sets the relative X position of the "center" point, the focus.
getter/setter pair
-
focusY
↔ num
-
Gets or sets the relative Y position of the "center" point, the focus.
getter/setter pair
-
height
↔ num
-
Gets or sets the height of this vertex.
This is always the vertical distance reserved for the node.
getter/setter pair
-
network
↔ LayoutNetwork
-
Gets the LayoutNetwork that owns this vertex.
The default value is null.
It is set automatically for you in LayoutNetwork#createVertex.
getter/setter pair
-
node
↔ Node?
-
Gets or sets the Node associated with this vertex, if any.
The value may be null if this vertex is a "dummy" vertex,
not represented by a real Node in the Diagram.
getter/setter pair
-
sourceEdges
↔ Iterator<LayoutEdge>
-
This read-only property returns an iterator for all of the edges that come into this vertex.
getter/setter pair
-
sourceEdgesArrayAccess
↔ Array<LayoutEdge>
-
(undocumented)
getter/setter pair
-
sourceVertexes
↔ Iterator<LayoutVertex>
-
This read-only property returns an iterator for all of the vertexes that are connected with edges coming into this vertex.
getter/setter pair
-
vertexes
↔ Iterator<LayoutVertex>
-
This read-only property returns an iterator for all of the vertexes that are connected in either direction with this vertex.
getter/setter pair
-
width
↔ num
-
Gets or sets the width of this vertex.
This is always the horizontal distance reserved for the node.
getter/setter pair
-
x
↔ num
-
Gets or sets the left point of this vertex.
getter/setter pair
-
y
↔ num
-
Gets or sets the top point of this vertex.
getter/setter pair
Methods
-
addDestinationEdge(LayoutEdge edge)
→ void
-
Adds a LayoutEdge to the list of successors
(the edge will be going out from this vertex).
Calling this method does not modify the LayoutEdge#fromVertex of the LayoutEdge.
@param {LayoutEdge} edge
-
addSourceEdge(LayoutEdge edge)
→ void
-
Adds a LayoutEdge to the list of predecessors
(the edge will be coming into this vertex).
Calling this method does not modify the LayoutEdge#toVertex of the LayoutEdge.
@param {LayoutEdge} edge
-
commit()
→ void
-
Moves the Node corresponding to this vertex
so that its position is at the current #bounds point.
-
deleteDestinationEdge(LayoutEdge edge)
→ void
-
Deletes a LayoutEdge from the list of successors
(the edge was going out from this vertex).
Calling this method does not modify the LayoutEdge#fromVertex of the LayoutEdge.
@param {LayoutEdge} edge
-
deleteSourceEdge(LayoutEdge edge)
→ void
-
Deletes a LayoutEdge from the list of predecessors
(the edge was coming into this vertex).
Calling this method does not modify the LayoutEdge#toVertex of the LayoutEdge.
@param {LayoutEdge} edge
