ZoomCharts Documentation

Version: 1.21.1 (2024-11-08)

ZoomCharts.Configuration.NetChartSettingsLayout

Methods

This type does not define any methods.

Properties

advanced: anonymous type

Advanced chart settings. Be advised that they are subject to change, backwards compatibility is not guaranteed.

Properties
adaptiveFreezeTreshold: number
aspectRatio: boolean

Whether to fit network in aspect ratio of chart viewport. Useful for small networks that always fit in chart and are not intended to be zoomed in / out.

The style for the labels in category hierarchy

centerNodes: boolean

For hierarchy layout, whether to attempt to center nodes under their parent

globalLayoutOnChanges: boolean

Whether to perform global layout on network changes. Use it for better node placement at the cost of chart slowdown on network changes.

Introduced in version 1.17.0.

For dynamic layout, settings for gravity that pulls all nodes together.

groupSpacing: number
Introduced in version 1.16.0.

Desired horizontal distance between neighboring nodes with different parents in the hierarchy layout. By default 2*nodeSpacing

incrementalLayoutMaxTime: number

Maximum time to wait for incremental layout to be completed. Note that bigger value will get nicer placement on network updates at the cost of longer delay.

initialLayoutMaxTime: number

Maximum time to wait for initial layout to be completed. Note that bigger value will get nicer placement of big networks at the cost of long initial delay.

layoutFreezeMinTimeout: number

Dynamic layout can be stopped faster if no more movement is detected.

layoutFreezeTimeout: number

Dynamic layout is stopped after user is inactive for this time.

mode: "dynamic" | "radial" | "hierarchy" | "static" | "swimlane" | "categoryHierarchy"

Layout mode.

Valid values:
  • dynamic - incrementally update whole network when user moves nodes
  • radial - Position graph nodes in concentric rings, starting form initial node.
  • hierarchy - Position graph nodes top-down, starting from initial node
  • static - other nodes stay fixed while user moves nodes.
nodeSpacing: number

Desired distance between nodes.

onCycleDetect: (backLink: ItemsChartLink, cycle: Array<ItemsChartLink>) => void

Function executed by category hierarchy layout when it detects a link that creates a cycle in the graph

Parameters
rotation: number
Introduced in version 1.14.0.

For hierarchy layout, clockwise rotation of the tree(s), measured in degrees. 0 = top-down tree; 90 = right-left tree; 180 = bottom-up tree, etc. Also affects placement of multiple trees the same way.

rowSpacing: number

Desired vertical distance between node rows in the hierarchy layout.

scaleX: number

For hierarchy layout, scale the hierarchy on X, mainly used for mirroring and flipping

scaleY: number

For hierarchy layout, scale the hierarchy on Y, mainly used for mirroring and flipping

sortForestBySize: boolean

For hierarchy layout, whether to sort trees during layout

sortNodes: boolean

For hierarchy layout, whether to sort the nodes during layout

Settings for swimlane layout

twoRingRadialLayout: boolean
Introduced in version 1.12.0.

For radial layout, whether to lay out the first level in two rings, if necessary.

X