Node
23 Sep 20255 minutes to read
Defines the behavior of nodes
Properties
addInfo Object
Allows the user to save custom information/data about a node/connector
Defaults to undefined
annotations ShapeAnnotationModel[]
Defines the collection of textual annotations of nodes/connectors
Defaults to undefined
backgroundColor string
Sets the background color of the shape
Defaults to ‘transparent’
borderColor string
Sets the border color of the node
Defaults to ‘none’
borderWidth number
Sets the border width of the node
Defaults to 0
branch BranchTypes
Set the branch for the mind map
Defaults to ’’
children string[]
Defines the children of group element
Defaults to undefined
collapseIcon IconShapeModel
Defines the collapsed state of a node
Defaults to {}
columnIndex number
Used to define a index of column in the grid
Defaults to undefined
columnSpan number
Merge the column use the property in the grid container
Defaults to undefined
columns ColumnDefinition[]
Used to define the column for the grid container
Defaults to undefined
constraints NodeConstraints
Enables/Disables certain features of nodes
- None - Disable all node Constraints
- Select - Enables node to be selected
- Drag - Enables node to be Dragged
- Rotate - Enables node to be Rotate
- Shadow - Enables node to display shadow
- PointerEvents - Enables node to provide pointer option
- Delete - Enables node to delete
- InConnect - Enables node to provide in connect option
- OutConnect - Enables node to provide out connect option
- Individual - Enables node to provide individual resize option
- Expandable - Enables node to provide Expandable option
- AllowDrop - Enables node to provide allow to drop option
- Inherit - Enables node to inherit the interaction option
- ResizeNorthEast - Enable ResizeNorthEast of the node
- ResizeEast - Enable ResizeEast of the node
- ResizeSouthEast - Enable ResizeSouthEast of the node
- ResizeSouth - Enable ResizeSouthWest of the node
- ResizeSouthWest - Enable ResizeSouthWest of the node
- ResizeSouth - Enable ResizeSouth of the node
- ResizeSouthWest - Enable ResizeSouthWest of the node
- ResizeWest - Enable ResizeWest of the node
- ResizeNorth - Enable ResizeNorth of the node
- Resize - Enables the Aspect ratio fo the node
- AspectRatio - Enables the Aspect ratio fo the node
- Tooltip - Enables or disables tool tip for the Nodes
- InheritTooltip - Enables or disables tool tip for the Nodes
- ReadOnly - Enables the ReadOnly support for Annotation
Defaults to ‘Default’
container ChildContainerModel
Defines the type of the container
Defaults to null
data Object
Sets the data source of the node
dragSize SymbolSizeModel
Defines the size of a drop symbol
Defaults to undefined
excludeFromLayout boolean
Defines whether the node should be automatically positioned or not. Applicable, if layout option is enabled.
Defaults to false
expandIcon IconShapeModel
Defines the expanded state of a node
Defaults to {}
fixedUserHandles NodeFixedUserHandleModel[]
Specifies the collection of the fixed user handle
Defaults to undefined
flip FlipDirection
Flip the element in Horizontal/Vertical directions
Defaults to None
flipMode FlipMode
Allows you to flip only the node or along with port and label.
This functionality is applicable only for nodes.
Defaults to All
height number
Sets the height of the node
Defaults to undefined
horizontalAlignment HorizontalAlignment
Sets the horizontalAlignment of the node
Defaults to ‘Stretch’
id string
Represents the unique id of nodes/connectors
Defaults to ’’
isExpanded boolean
Defines whether the node is expanded or not
Defaults to true
layoutInfo LayoutInfo
Sets the layout properties using node property
Defaults to new NodeLayoutInfo()
margin MarginModel
Defines the space to be left between the node and its immediate parent
Defaults to {}
maxHeight number
Sets the maximum height of the node
Defaults to undefined
maxWidth number
Sets the maximum width of the node
Defaults to undefined
minHeight number
Sets the minimum height of the node
Defaults to undefined
minWidth number
Sets the minimum width of the node
Defaults to undefined
offsetX number
Sets the x-coordinate of the position of the node
Defaults to 0
offsetY number
Sets the y-coordinate of the position of the node
Defaults to 0
padding MarginModel
Defines the space between the group node edges and its children
Defaults to 0
pivot PointModel
Sets the reference point, that will act as the offset values(offsetX, offsetY) of a node
Defaults to new Point(0.5,0.5)
ports PointPortModel[]
Defines the collection of connection points of nodes/connectors
Defaults to undefined
previewSize SymbolSizeModel
Defines the size of the symbol preview
Defaults to undefined
rotateAngle number
Sets the rotate angle of the node
Defaults to 0
rowIndex number
Used to define a index of row in the grid
Defaults to undefined
rowSpan number
Merge the row use the property in the grid container
Defaults to undefined
rows RowDefinition[]
Used to define the rows for the grid container
Defaults to undefined
shadow ShadowModel
Defines the shadow of a shape/path
Defaults to null
shape ShapeModel|FlowShapeModel|BasicShapeModel|ImageModel|PathModel|TextModel|BpmnShapeModel|NativeModel|HtmlModel|UmlActivityShapeModel|UmlClassifierShapeModel|SwimLaneModel|DiagramShapeModel|ContainerModel
Defines the shape of a node
Defaults to Basic Shape
style ShapeStyleModel|TextStyleModel
Sets the shape style of the node
Defaults to new ShapeStyle()
symbolInfo SymbolPaletteInfoModel
Defines the symbol info of a connector
Defaults to undefined
tooltip DiagramTooltipModel
defines the tooltip for the node
Defaults to {}
verticalAlignment VerticalAlignment
Sets the verticalAlignment of the node
Defaults to ‘Stretch’
visible boolean
Sets the visibility of the node/connector
Defaults to true
width number
Sets the width of the node
Defaults to undefined
wrapper GroupableView
Sets or gets the UI of a node
Defaults to null
zIndex number
Defines the visual order of the node/connector in DOM
Defaults to Number.MIN_VALUE