Skip to content

charton API


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

Interface: AnnotationOptions ​

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

Options of the annotation layer as a whole.

Properties ​

cluster ​

cluster: ClusterOptions

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


markerCluster ​

markerCluster: MarkerClusterOptions

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

Bar markers: fold crowded bars into one marker with a count.


onClusterClick? ​

optional onClusterClick?: (e) => void

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

The summary label of a cluster was clicked.

Parameters ​

e ​

ClusterClickEvent

Returns ​

void


overlap ​

overlap: "none" | "cluster"

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

cluster folds overlapping order labels into one summary label. Default none.