Class BuySellButtons

Implements

IPrimitive

Index

Constructors

Methods

attached autoscaleInfo detached draw hitTest setColors setMark setPrices setQty zOrder

Constructors

constructor

new BuySellButtons(options?: BuySellButtonsOptions): BuySellButtons
Parameters
- options: BuySellButtonsOptions = {}
Returns BuySellButtons
- Defined in src/primitives/buy-sell-buttons.ts:63

Methods

attached

attached(host: PrimitiveHost): void
Parameters
- host: PrimitiveHost
Returns void
Implementation of IPrimitive.attached
- Defined in src/primitives/buy-sell-buttons.ts:77

autoscaleInfo

autoscaleInfo(): null
Optional: expand the pane's autoscale range so this primitive isn't clipped.

Returns null
Implementation of IPrimitive.autoscaleInfo
- Defined in src/primitives/buy-sell-buttons.ts:80

detached

detached(): void
Returns void
Implementation of IPrimitive.detached
- Defined in src/primitives/buy-sell-buttons.ts:78

draw

draw(ctx: CanvasRenderingContext2D, rc: PrimitiveRenderContext): void
Parameters
- ctx: CanvasRenderingContext2D
- rc: PrimitiveRenderContext
Returns void
Implementation of IPrimitive.draw
- Defined in src/primitives/buy-sell-buttons.ts:117

hitTest

hitTest(x: number, y: number, _rc: PrimitiveRenderContext): null | PrimitiveHit
Optional: topmost hit under (x,y) in media px (relative to the pane plot).
Parameters
- x: number
- y: number
- _rc: PrimitiveRenderContext
Returns null | PrimitiveHit
Implementation of IPrimitive.hitTest
- Defined in src/primitives/buy-sell-buttons.ts:203

setColors

setColors(buyColor?: string, sellColor?: string): void
Parameters
- OptionalbuyColor: string
- OptionalsellColor: string
Returns void
- Defined in src/primitives/buy-sell-buttons.ts:96

setMark

setMark(price: number): void
Single mark price shown on both buttons (when there is no bid/ask).
Parameters
- price: number
Returns void
- Defined in src/primitives/buy-sell-buttons.ts:89

setPrices

setPrices(bid: number, ask: number): void
Distinct bid/ask (shows a spread on the two buttons).
Parameters
- bid: number
- ask: number
Returns void
- Defined in src/primitives/buy-sell-buttons.ts:83

setQty

setQty(qty: string | number): void
Parameters
- qty: string | number
Returns void
- Defined in src/primitives/buy-sell-buttons.ts:91

zOrder

zOrder(): ZOrder
Layer order vs series: 'bottom' (behind), 'normal' (over), 'top' (overlay).

Returns ZOrder
Implementation of IPrimitive.zOrder
- Defined in src/primitives/buy-sell-buttons.ts:79