ZoomCharts Documentation

ZoomCharts.Configuration.ItemsChartNode

A visible node.

Inheritance hierarchy

This type inherits from ItemsChartSettingsNodeStyle.

Methods

This type does not define any methods.

Properties

Node anchor mode.

anchorX: number

Node anchor y position. If not set, initial position will be calculated automatically and conserved. The coordinate space is dependant on anchorMode value.

  • anchorMode = "Scene" - the value is in scene coordinates.
  • anchorMode = "Display" - the value is in pixels from top-left corner of the chart area.
anchorY: number

Node anchor y position. If not set, initial position will be calculated automatically and conserved. The coordinate space is dependant on anchorMode value.

  • anchorMode = "Scene" - the value is in scene coordinates.
  • anchorMode = "Fixed" - the value is in pixels from top-left corner of the chart area.
aspectRatio: number

When display="rectangle", this setting determines the width/height ratio of the rectangle. The longest edge of the rectangle will be set to "radius" and the shortest will be calculated from this variable.

Introduced in version 1.15.0.

The ID of one or more auras to which the node belongs. Nodes with the same aura ID will be visually grouped together.

Note that if multiple auras for a single node are specified, auras.overlap setting should be set to true.

background: boolean

Whether or not the node is a background node. This flag is set only by user code.

coordinates: Array<number> | Array<Array<number>>
cursor: string

Cursor to show when node is hovered.

Custom shape settings supplied, if display == "customShape"

Data object that this node represents

display: string

Valid values: circle (default), text, roundtext, droplet, rectangle, customShape

draggable: boolean
Introduced in version 1.18.0.

Controls if node is draggable; Values: draggable false - node cannot be dragged; draggable true - node can be dragged; Default is true.

expanded: boolean

Whether or not the node is expanded. A node counts as "expanded" if all its links are visible.

fillColor: string
focused: boolean
hovered: boolean

Whether or not the mouse cursor is hovering over the node.

id: string

ID of the node

image: string
imageCropping: "fit" | boolean | "crop" | "letterbox"

Specifies the image cropping method. Valid values are false (disable cropping), true (default cropping mode), "crop", "letterbox" and "fit".

invisible: boolean

Specifies if the node is invisible - thus completely skipping the drawing and hit testing. However the node is not removed. This flag is set only by user code.

A list of additional items for the particular node. To add or remove items, change this array.

label: string

The label text that is displayed below the node. Set to an empty string "" to remove the label if it has been added before.

lineColor: string
lineDash: Array<number>
lineWidth: number
opacity: number

Node opacity.

radius: number
relevance: number

Node relevance is used in NetChart when the navigation mode is focusnodes and is intended to be a rough measure of how "interesting" a node is. For information about what relevance is and how it's calculated, see the Focusnodes algorithm.

See also
removed: number | boolean

If this is false, then the node is visible. If it is true or a non-zero a number (a "truthy" value), then the removal animation is in progress. After the removal animation completes, the node will be hidden.

selected: boolean

Whether or not the node is selected.

shadowBlur: number
shadowColor: string
shadowOffsetX: number
shadowOffsetY: number
userLock: boolean

If true, the node is fixed in place and does not get affected by layout algorithms. This gets set automatically after the user drags a node in NetChart.

X