Options

Required type

auto-adapt-label

Behavior type

enable

boolean | ((event: IGraphLifeCycleEvent | IAnimateEvent | IElementLifeCycleEvent | IViewportEvent | IPointerEvent | IWheelEvent | IKeyboardEvent | IDragEvent) => boolean) Default: ``

Whether to enable

padding

number | number[] Default: 0

Set the padding of the label to determine whether the label overlaps to avoid the label being displayed too densely

sort

(elementA: NodeData | EdgeData | ComboData, elementB: NodeData | EdgeData | ComboData) => -1 | 0 | 1

Sort elements by their importance in descending order; elements with higher importance have higher label display priority; usually combo > node > edge

sortCombo

(comboA: ComboData, comboB: ComboData) => -1 | 0 | 1

Sort combos by importance in descending order; combos with higher importance have higher label display priority. By default, they are sorted according to the data. It should be noted that if sort is set, sortCombo will not take effect

sortEdge

(edgeA: EdgeData, edgeB: EdgeData) => -1 | 0 | 1

Sort edges by importance in descending order; edges with higher importance have higher label display priority. By default, they are sorted according to the data. It should be noted that if sort is set, sortEdge will not take effect

sortNode

Sort nodes by importance in descending order; nodes with higher importance have higher label display priority. Several centrality algorithms are built in, and custom sorting functions can also be defined. It should be noted that if sort is set, sortNode will not take effect

throttle

number Default: 32

Throttle time

API

AutoAdaptLabel.destroy()

destroy(): void;

AutoAdaptLabel.update(options)

update(options: Partial<AutoAdaptLabelOptions>): void;