TreeVertex class

This holds TreeLayout-specific information about Nodes.

This class inherits from LayoutVertex.

Implemented types

• LayoutVertex

Available extensions

• LayoutVertex$Typings
• TreeVertex$Typings

Annotations

• @JS()
• @staticInterop

Constructors

TreeVertex.new(TreeNetwork network)

factory

Properties

alignment ↔ EnumValue

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets how this parent node should be aligned relative to its children.

getter/setter pair

angle ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the absolute angle at which this subtree should grow from this vertex.

getter/setter pair

bounds ↔ Rect

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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

breadthLimit ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets how broad a node and its descendants should be.

getter/setter pair

centerX ↔ num

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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

childPortSpot ↔ Spot

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the spot that children nodes' ports get as their ToSpot, if #setsChildPortSpot is true and the node has only a single port.

getter/setter pair

children ↔ Array<TreeVertex>

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the logical children for this node.

getter/setter pair

childrenCount ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

This read-only property returns the number of immediate children this node has.

getter/setter pair

commentMargin ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the space to leave between the node and the comments.

getter/setter pair

comments ↔ Array<Node>

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets an array of Nodes that will be positioned near this node.

getter/setter pair

commentSpacing ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the space to leave between consecutive comments.

getter/setter pair

compaction ↔ EnumValue

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets how the children of this node should be packed together.

getter/setter pair

comparer ↔ num Function(TreeVertex, TreeVertex)

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets how the children should be sorted.

getter/setter pair

data ↔ Object?

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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

descendantCount ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the number of descendants this node has.

getter/setter pair

destinationEdges ↔ Iterator<LayoutEdge>

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

This read-only property returns an iterator for all of the edges that go out of this vertex.

getter/setter pair

destinationEdgesArrayAccess ↔ Array<LayoutEdge>

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

(undocumented)

getter/setter pair

destinationVertexes ↔ Iterator<LayoutVertex>

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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>

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

This read-only property returns the total number of edges that are connected with this vertex in either direction.

getter/setter pair

focus ↔ Point

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

Gets or sets the relative X position of the "center" point, the focus.

getter/setter pair

focusY ↔ num

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

Gets or sets the relative Y position of the "center" point, the focus.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

height ↔ num

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

Gets or sets the height of this vertex. This is always the vertical distance reserved for the node.

getter/setter pair

initialized ↔ bool

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets whether this node has been initialized as part of TreeLayout#doLayout when building the tree structures.

getter/setter pair

layerSpacing ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the distance between this node and its children.

getter/setter pair

layerSpacingParentOverlap ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the fraction of this node's depth that may overlap with the children's layer.

getter/setter pair

level ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the number of single-parent ancestors this node has.

getter/setter pair

maxChildrenCount ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the maximum number of children of any descendant of this node.

getter/setter pair

maxGenerationCount ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the maximum depth of the subtrees below this node.

getter/setter pair

network ↔ LayoutNetwork

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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?

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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

nodeIndent ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the distance the first child should be indented.

getter/setter pair

nodeIndentPastParent ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets whether the first child should be indented past the parent node's breadth.

getter/setter pair

nodeSpacing ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the distance between child nodes.

getter/setter pair

parent ↔ TreeVertex

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the logical parent for this node.

getter/setter pair

portSpot ↔ Spot

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the spot that this node's port gets as its FromSpot, if #setsPortSpot is true and the node has only a single port.

getter/setter pair

relativePosition ↔ Point

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the position of this node relative to its parent node.

getter/setter pair

rowIndent ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the distance the first child of each row should be indented.

getter/setter pair

rowSpacing ↔ num

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the distance between rows within one layer, all sharing the same parent.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

setsChildPortSpot ↔ bool

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets whether the TreeLayout should set the ToSpot for each child node port.

getter/setter pair

setsPortSpot ↔ bool

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets whether the TreeLayout should set the FromSpot for this parent node port.

getter/setter pair

sorting ↔ EnumValue

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets whether and in what order the children should be sorted.

getter/setter pair

sourceEdges ↔ Iterator<LayoutEdge>

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

This read-only property returns an iterator for all of the edges that come into this vertex.

getter/setter pair

sourceEdgesArrayAccess ↔ Array<LayoutEdge>

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

(undocumented)

getter/setter pair

sourceVertexes ↔ Iterator<LayoutVertex>

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

This read-only property returns an iterator for all of the vertexes that are connected with edges coming into this vertex.

getter/setter pair

subtreeOffset ↔ Point

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the offset of this parent node relative to its whole subtree.

getter/setter pair

subtreeSize ↔ Size

Available on TreeVertex, provided by the TreeVertex$Typings extension

Gets or sets the size of the subtree (including all descendants) parented by this node.

getter/setter pair

vertexes ↔ Iterator<LayoutVertex>

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

Gets or sets the width of this vertex. This is always the horizontal distance reserved for the node.

getter/setter pair

x ↔ num

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

Gets or sets the left point of this vertex.

getter/setter pair

y ↔ num

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

Gets or sets the top point of this vertex.

getter/setter pair

Methods

addDestinationEdge(LayoutEdge edge) → void

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

Moves the Node corresponding to this vertex so that its position is at the current #bounds point.

copyInheritedPropertiesFrom(TreeVertex copy) → void

Available on TreeVertex, provided by the TreeVertex$Typings extension

Copy inherited properties from another TreeVertex to this one. @expose @param {TreeVertex} copy

deleteDestinationEdge(LayoutEdge edge) → void

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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

Available on LayoutVertex, provided by the LayoutVertex$Typings extension

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited