Skip to content

charton API


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

Interface: ClusterClickEvent ​

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

A click on a cluster's summary label: the folded trade lines and where the label sits. Call preventDefault() to replace the UI package's order list.

Properties ​

anchor ​

anchor: Point

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

The summary label's centre, in chart-root css px.


defaultPrevented ​

readonly defaultPrevented: boolean

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


lines ​

lines: TradeLine[]

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

The trade lines in the cluster, top to bottom.

Methods ​

preventDefault() ​

preventDefault(): void

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

Stop the UI package's default list of the clustered orders.

Returns ​

void