GoJS API
/ to search
    Preparing search index...

    Class LayeredDigraphVertexUnindexed

    GoJS® Diagramming Components
    version 4.0.0
    by Northwoods Software®

    This holds LayeredDigraphLayout-specific information about Nodes.

    This class inherits from LayoutVertex.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    bounds centered centerX centerY column component data destinationEdges destinationVertexes edges edgesCount focus focusX focusY height index layer near network node sourceEdges sourceVertexes vertexes width x y

    Methods

    smartComparer standardComparer

    Constructors

    Accessors

    • get 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.

      Returns Rect

    • get centered(): boolean

      Gets or sets whether the Node (if any) is positioned aligned to the center of its layer or to the left side (if direction == 0) or top side (if direction == 90) of its layer.

      The default value is true but gets the value of LayeredDigraphLayout.centered.

      Returns boolean

      since

      3.1

    • get centerX(): number

      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.

      Returns number

    • get centerY(): number

      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.

      Returns number

    • get column(): number

      Gets or sets the column to which the node is assigned. The default value is -1.

      This property is not used during straightening and packing of nodes when using LayeredDigraphLayout.alignOption.

      Returns number

    • get component(): number

      Gets or sets the connected component to which the node is assigned. The default value is NaN.

      This property is not used during straightening and packing of nodes when using LayeredDigraphLayout.alignOption.

      Returns number

    • get data(): ObjectData | null

      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.

      Returns ObjectData | null

    • get destinationEdges(): Iterator<LayoutEdge>

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

      Returns Iterator<LayoutEdge>

    • get 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.

      Note that this is inefficient compared to iterating over the edges (destinationEdges) due to the need to avoid duplicate vertexes if there happen to be multiple edges connecting with the same vertex.

      Returns Iterator<LayoutVertex>

    • get edges(): Iterator<LayoutEdge>

      This read-only property returns an iterator for all of the edges that are connected with this vertex in either direction.

      Note that this is inefficient compared to iterating over the edges: sourceEdges and destinationEdges.

      Returns Iterator<LayoutEdge>

    • get edgesCount(): number

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

      Returns number

    • get 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.

      The "focus" is normally the center of the Node's Part.locationObject.

      Returns Point

    • get focusX(): number

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

      Returns number

    • get focusY(): number

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

      Returns number

    • get height(): number

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

      Returns number

    • get index(): number

      Gets or sets the index to which the node is assigned. The default value is -1.

      Returns number

    • get layer(): number

      Gets or sets the layer to which the node is assigned. The default value is -1.

      Returns number

    • get node(): Node | null

      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.

      This property setter also sets the bounds and focus properties according to the value of the Node's actualBounds and its Part.locationObject's center point.

      Returns Node | null

    • get sourceEdges(): Iterator<LayoutEdge>

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

      Returns Iterator<LayoutEdge>

    • get sourceVertexes(): Iterator<LayoutVertex>

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

      Note that this is inefficient compared to iterating over the edges (sourceEdges) due to the need to avoid duplicate vertexes if there happen to be multiple edges connecting with the same vertex.

      Returns Iterator<LayoutVertex>

    • get vertexes(): Iterator<LayoutVertex>

      This read-only property returns an iterator for all of the vertexes that are connected in either direction with this vertex.

      Note that this is inefficient compared to iterating over the edges (sourceEdges and destinationEdges) due to the need to avoid duplicate vertexes if there happen to be multiple edges connecting with the same vertex.

      Returns Iterator<LayoutVertex>

    • get width(): number

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

      Returns number

    • get x(): number

      Gets or sets the left point of this vertex.

      Returns number

    • get y(): number

      Gets or sets the top point of this vertex.

      Returns number

    Methods

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods