IForceDirectedDataItem

Type interface

Sources

IForceDirectedDataItem is an interface: it describes a shape of data and is not imported on its own.

Inheritance

IForceDirectedDataItem extends ILinkedHierarchyDataItem.

IForceDirectedDataItem is not extended by any other symbol.

Properties

#children

Type Array

Data items of the child nodes.

#parent

Type DataItem

Data item of the parent node.

#x

Type number | undefined

Fixed X position of the node, from xField.

#y

Type number | undefined

Fixed Y position of the node, from yField.

37 inherited items

#category

Type stringInherited from IHierarchyDataItem

The node's category name.

#childData

Type ArrayInherited from IHierarchyDataItem

Raw data of the node's children.

#childLinks

Type ArrayInherited from ILinkedHierarchyDataItem

Links that start at this node: to its children and to the nodes in its linkWith.

#circle

Type CircleInherited from ILinkedHierarchyDataItem

The node's circle.

#customValue

Type undefined | numberInherited from ISeriesDataItem

#customValueChange

Type undefined | numberInherited from ISeriesDataItem

#customValueChangePercent

Type undefined | numberInherited from ISeriesDataItem

#customValueChangePrevious

Type undefined | numberInherited from ISeriesDataItem

#customValueChangePreviousPercent

Type undefined | numberInherited from ISeriesDataItem

#customValueChangeSelection

Type undefined | numberInherited from ISeriesDataItem

#customValueChangeSelectionPercent

Type undefined | numberInherited from ISeriesDataItem

#customValueWorking

Type undefined | numberInherited from ISeriesDataItem

#depth

Type numberInherited from IHierarchyDataItem

Depth of the node in the hierarchy: 0 for the root.

#disabled

Type booleanInherited from IHierarchyDataItem

true while the node is collapsed, with its children hidden.

#fill

Type ColorInherited from IHierarchyDataItem

The node's color: from data (fillField), or else the next of colors for a first-level node and the parent's color for a deeper one.

#fillPattern

Type PatternInherited from IHierarchyDataItemSince 5.10.0

Node's auto-assigned pattern.

More info: Patterns

#id

Type undefined | stringInherited from ISeriesDataItem

#label

Type LabelInherited from IHierarchyDataItem

The node's label.

#links

Type ArrayInherited from ILinkedHierarchyDataItem

All links that start or end at this node, linkWith ones included.

#linkWith

Type ArrayInherited from ILinkedHierarchyDataItem

IDs of other nodes this node is linked with, besides its parent and children.

#node

Type LinkedHierarchyNodeInherited from ILinkedHierarchyDataItem

The node element.

#outerCircle

Type CircleInherited from ILinkedHierarchyDataItem

The ring around the node's circle, shown when the node has children.

#parentLink

Type HierarchyLinkInherited from ILinkedHierarchyDataItem

The link to the parent node.

#sum

Type numberInherited from IHierarchyDataItem

The node's total: its own value if the data gives one, or else the sum of its children's.

#url

Type undefined | stringInherited from ISeriesDataItemSince 5.20.7

A URL to open when the data item's element is clicked.

#value

Type numberInherited from IHierarchyDataItem

Value of the node as set in data.

#valueChange

Type undefined | numberInherited from ISeriesDataItem

#valueChangePercent

Type undefined | numberInherited from ISeriesDataItem

#valueChangePrevious

Type undefined | numberInherited from ISeriesDataItem

#valueChangePreviousPercent

Type undefined | numberInherited from ISeriesDataItem

#valueChangeSelection

Type undefined | numberInherited from ISeriesDataItem

#valueChangeSelectionPercent

Type undefined | numberInherited from ISeriesDataItem

#valuePercent

Type numberInherited from IHierarchyDataItemSince 5.2.21

The node's value as a percent of its parent's (25 for 25%).

#valuePercentTotal

Type numberInherited from IHierarchyDataItem

The node's value as a percent of the root node's total (25 for 25%).

#valueWorkingClose

Type undefined | numberInherited from ISeriesDataItem

#valueWorkingOpen

Type undefined | numberInherited from ISeriesDataItem

#visible

Type undefined | false | trueInherited from IComponentDataItem