Interface PrimitiveRenderContext

interface PrimitiveRenderContext {
    bars?: () => readonly Bar[];
    dataLayer: DataLayer;
    dpr: number;
    dragId?: null | string;
    hoverId?: null | string;
    plotHeight: number;
    plotWidth: number;
    priceAxisWidth: number;
    priceScale: PriceScale;
    readoutPriceScale?: PriceScale;
    theme: ChartTheme;
    timeScale: TimeScale;
}

Properties

bars? dataLayer dpr dragId? hoverId? plotHeight plotWidth priceAxisWidth priceScale readoutPriceScale? theme timeScale

Properties

Optionalbars

bars?: () => readonly Bar[]

The pane's primary price series, for a primitive that needs what price actually did rather than just the scales — a forecast scoring itself, say. Lazy, so nothing pays for it unless asked. Absent on synthetic contexts.

dataLayer

dataLayer: DataLayer

dpr

dpr: number

OptionaldragId

dragId?: null | string

externalId of the line being dragged (active state), if any.

OptionalhoverId

hoverId?: null | string

externalId of the primitive hit under the pointer (hover state), if any.

plotHeight

plotHeight: number

plotWidth

plotWidth: number

priceAxisWidth

priceAxisWidth: number

priceScale

priceScale: PriceScale

OptionalreadoutPriceScale

readoutPriceScale?: PriceScale

The pane's primary visible price series scale, including a moved left axis.

theme

theme: ChartTheme

timeScale

timeScale: TimeScale

Settings

Member Visibility

On This Page

Properties