Skip to content

charton API


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

Interface: Trade ​

Defined in: packages/core/src/annotations/trades.ts:16

One fill of the account, e.g. from an execution report.

Properties ​

color? ​

optional color?: string

Defined in: packages/core/src/annotations/trades.ts:27

Default: the theme's up colour for buys, down for sells.


id ​

id: string

Defined in: packages/core/src/annotations/trades.ts:18

Unique within its source; addTrade with a known id replaces that fill.


label? ​

optional label?: string

Defined in: packages/core/src/annotations/trades.ts:25

Shown in badges and tooltips instead of Buy / Sell.


price ​

price: number

Defined in: packages/core/src/annotations/trades.ts:22

The traded price; under the chart's adjustment option it draws at its bar's adjusted price.


quantity ​

quantity: number

Defined in: packages/core/src/annotations/trades.ts:23


side ​

side: OrderSide

Defined in: packages/core/src/annotations/trades.ts:20


time ​

time: number

Defined in: packages/core/src/annotations/trades.ts:19


tooltip? ​

optional tooltip?: string | string[]

Defined in: packages/core/src/annotations/trades.ts:29

Tooltip rows for this fill. Default: side, quantity and price.