Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface node

OptionsMethodsInterfaces

The OrgChart node model

var chart = new OrgChart('#tree', {});
chart.onInit(() => {
 let node = chart.getNode(2);
 console.log(node);
});
chart.load(nodes)

Hierarchy

  • node

Index

Properties

Properties

Optional children

children?: node[]

array of children nodes, initialized on demand if all children are collpased it will be empty array

Optional childrenIds

childrenIds?: (string | number)[]

array of ids, always initialized

Optional cids

cids?: (string | number)[]

An array of child node ids.

Optional collapsed

collapsed?: boolean

true if the node is collpased, false if it is not and undefined if not initalized

Optional collapsedChildrenIds

collapsedChildrenIds?: (string | number)[]

Array of collapsed direct child node IDs.

Contains the IDs of child nodes whose collapsed state is true. Always initialized as an array.

Optional deepChildCount

deepChildCount?: number

Total number of descendant nodes (children at all levels).

Optional deepCollapsedChildCount

deepCollapsedChildCount?: number

Total number of collapsed descendant nodes (collapsed at any depth).

Optional h

h?: number

height of the node, default value undefined

Optional id

id?: string | number

the same id you provided in the source node

Optional isAssistant

isAssistant?: boolean

if the node is assistant is true if not false if the node is not initialized is undefined

Optional isChildOfPartner

isChildOfPartner?: boolean

indicates if the node is child of partner node

Optional isPartner

isPartner?: boolean

Optional isSplit

isSplit?: boolean

for assistant nodes and mixed layout we create dynamic nodes called splits, default value undefined

Optional isTreeListItem

isTreeListItem?: boolean

Indicates whether this node is rendered as a Tree List item.

When true, the node is displayed using the Tree List layout instead of the standard chart layout.

Optional lcn

lcn?: string

layout configuration name, default value undefined

Optional leftNeighbor

leftNeighbor?: node

a reference to the left node neighbor, the default value is undefined

Optional level

level?: number

a level of the node starting from zero

Optional min

min?: boolean

true if the node is minimized, default value undefined

Optional movex

movex?: number

move the the node on x axis

Optional movey

movey?: number

move the the node on y axis

Optional order

order?: number

it is set only if you define order option, default value undefined

Optional padding

padding?: number

set only if the node contains sub trees and padding is defined in the template, default value undefined

Optional parent

parent?: node

a reference to the parent node, default value is null, if the nodes is collapse this proprty is not initalized and can be null even if pid is not null

Optional partnerSeparation

partnerSeparation?: number

Optional pid

pid?: string | number

partner parent id, it is the partner parent node id of the partner node, it is the same ppid you provided in the source node, the default value is undefined.

Optional ppid

ppid?: string | number

parent id, it is the parent node id, it is the same pid you provided in the source node, the default value is undefined.

Optional rightNeighbor

rightNeighbor?: node

a reference to the right node neighbor, the default value is undefined

Optional stChildren

stChildren?: node[]

array of sub tree children root nodes, initialized on demand if the node is minimized it will be empty array

Optional stChildrenIds

stChildrenIds?: (string | number)[]

array of sub tree children root node ids, always initialized

Optional stContainerNodes

stContainerNodes?: node[]

sub tree container nodes array, property only for the root node, default value undefined

Optional stParent

stParent?: node
  • a reference to the parent node of a sub tree, default value is null, if the parent node is minimized this proprty is not initalized and can be null even if we have stpid

Optional stpid

stpid?: string | number

ub tree parent id, it is the parent node id of the root node of the sub tree, it is the same stpid you provided in the source node, the default value is null if not provided or if node with the same id does not exist.

Optional subLevels

subLevels?: number

sub levels, default value undefined

Optional tags

tags?: string[]

array of string values, the same array you provided in the source node

Optional templateName

templateName?: string

template name, you can specify multiple templates with tags in one chart

Optional treeList

treeList?: { maxHeight?: number; pinnedIds?: []; scrollTop?: number; scrollTopMax?: number }

TreeList layout state and configuration. Available only when using OrgChart.layout.treeList.

Type declaration

  • Optional maxHeight?: number

    Max height, comes from the template treeListMaxHeight

  • Optional pinnedIds?: []

    Pinned nodes at the top in TreeList layout, works with OrgChart.layout. By default is undefined it is initialized only with OrgChart.layout.treeList lyouts.

  • Optional scrollTop?: number

    Gets the number of pixels by which the TreeList content is scrolled from its top edge. By default is undefined it is initialized only with OrgChart.layout.treeList lyouts.

  • Optional scrollTopMax?: number

    Gets the max number of pixels by which the TreeList content can be scrolled from its top edge. By default is undefined it is initialized only with OrgChart.layout.treeList lyouts.

Optional w

w?: number

width of the node, default value undefined

Optional x

x?: number

x position, default value undefined

Optional y

y?: number

y position, default value undefined

Legend

  • Constructor
  • Property
  • Method
  • Static property
  • Static method
  • Property

Settings

Theme

Generated using TypeDoc