Skip to content

charton API


charton API / @chart-on/core / index / ClusterOptions

Interface: ClusterOptions ​

Defined in: packages/core/src/annotations/types.ts:406

Overlapping order labels folded into one, from annotations.applyOptions({ overlap: 'cluster' }).

Properties ​

mergeGapPx ​

mergeGapPx: number

Defined in: packages/core/src/annotations/types.ts:408

Labels closer than this (css px between blocks; negative = overlapping) fold together. Default 0.


minLines ​

minLines: number

Defined in: packages/core/src/annotations/types.ts:412

Fewest lines that form a cluster. Default 2.


splitGapPx ​

splitGapPx: number

Defined in: packages/core/src/annotations/types.ts:410

A folded cluster splits only once its labels are this far apart, so it does not flicker. Default 6.