charton API / @chart-on/core / index / DraftLineOptions
Interface: DraftLineOptions
Defined in: packages/core/src/annotations/types.ts:322
Options of an order draft (annotations.startOrderDraft): an order the user is still composing. Its price, take-profit and stop-loss drag freely; nothing reaches the app until commit().
Extends
Pick<LineLabelOptions,"labelAnchor"|"priceAxisLabel">
Properties
color?
optionalcolor?:string
Defined in: packages/core/src/annotations/types.ts:331
Default: the theme's up colour for buys, down for sells.
labelAnchor?
optionallabelAnchor?:LabelAnchor
Defined in: packages/core/src/annotations/types.ts:160
Where the label block sits: right (default, next to the price axis), center or left. Brackets follow their order.
Inherited from
lineStyle
lineStyle:
LineStyle
Defined in: packages/core/src/annotations/types.ts:333
lineWidth
lineWidth:
number
Defined in: packages/core/src/annotations/types.ts:332
price
price:
number
Defined in: packages/core/src/annotations/types.ts:323
priceAxisLabel?
optionalpriceAxisLabel?:boolean
Defined in: packages/core/src/annotations/types.ts:162
The price label on the axis. Default true.
Inherited from
LineLabelOptions.priceAxisLabel
quantity?
optionalquantity?:number
Defined in: packages/core/src/annotations/types.ts:326
Omitted until the user sets one.
series?
optionalseries?:Series<object>
Defined in: packages/core/src/annotations/types.ts:335
Series whose price scale and pane the draft follows. Default: the main series.
side
side:
OrderSide
Defined in: packages/core/src/annotations/types.ts:324
stopLoss?
optionalstopLoss?:number|null
Defined in: packages/core/src/annotations/types.ts:329
takeProfit?
optionaltakeProfit?:number|null
Defined in: packages/core/src/annotations/types.ts:328
tickSize?
optionaltickSize?:number
Defined in: packages/core/src/annotations/types.ts:337
Dragged prices snap to multiples of this. Default: one unit of the series precision.
type
type:
OrderType
Defined in: packages/core/src/annotations/types.ts:327