Class Pane

constructor

• new Pane(doc: Document): Pane

• Parameters

  • doc: Document

  Returns Pane

Readonlybase

Readonlyelement

ReadonlypriceScale

Readonlytop

weight

addPrimitive

• addPrimitive(primitive: IPrimitive, host: PrimitiveHost): void

• Parameters

  • primitive: IPrimitive
  • host: PrimitiveHost

  Returns void

addSeries

• addSeries(record: SeriesRecord): void

• Parameters

  • record: SeriesRecord

  Returns void

autoscale

• autoscale(ctx: PaneRenderContext): void

• Autoscale each active price scale from its own series (independent axes).

  Parameters

  • ctx: PaneRenderContext

  Returns void

destroy

• destroy(): void

• Detach every primitive (lifecycle cleanup) and remove the pane element.

  Returns void

hasLeftScale

• hasLeftScale(): boolean

• True when a left-axis scale is active (some series maps to it).

  Returns boolean

hitTestPrimitives

• hitTestPrimitives(
      x: number,
      y: number,
      ctx: PaneRenderContext,
  ): null | PrimitiveHit

• Topmost primitive hit at media-px (x,y) relative to this pane's plot.

  Parameters

  • x: number
  • y: number
  • ctx: PaneRenderContext

  Returns null | PrimitiveHit

paintBase

• paintBase(ctx: PaneRenderContext): void

• Paint background + grid + series + axes on the base canvas.

  Parameters

  • ctx: PaneRenderContext

  Returns void

paintTop

• paintTop(
      cross: null | { showTimeTag: boolean; x: number; yLocal: null | number },
      ctx: PaneRenderContext,
  ): void

• Top (overlay) canvas: top-layer primitives + crosshair. Cheap repaint on cursor moves. cross.x is the shared plot x (vertical line, drawn in every pane for a global crosshair); cross.yLocal is the price-line y for the hovered pane only (null elsewhere); cross.showTimeTag draws the date tag on the bottom pane's axis strip.

  Parameters

  • cross: null | { showTimeTag: boolean; x: number; yLocal: null | number }
  • ctx: PaneRenderContext

  Returns void

primitives

• primitives(): readonly IPrimitive[]

• Primitives attached to this pane, in draw order.

  Returns readonly IPrimitive[]

removePrimitive

• removePrimitive(primitive: IPrimitive): boolean

• Remove a primitive if present; returns true if it was found.

  Parameters

  • primitive: IPrimitive

  Returns boolean

removeSeries

• removeSeries(record: SeriesRecord): boolean

• Remove a series record if present; returns true if it was found.

  Parameters

  • record: SeriesRecord

  Returns boolean

resize

• resize(width: number, height: number, dpr: number): void

• Parameters

  • width: number
  • height: number
  • dpr: number

  Returns void

scaleOf

• scaleOf(record: SeriesRecord): PriceScale

• The price scale a series maps to (for the series handle's priceScale()).

  Parameters

  • record: SeriesRecord

  Returns PriceScale

series

• series(): readonly SeriesRecord[]

• Returns readonly SeriesRecord[]

setScaleHeights

• setScaleHeights(plotHeight: number): void

• Give every scale on this pane its plot height. Height is a layout property, but it used to be set only inside the autoscale pass — so any y↔price conversion before the first paint divided by zero and returned ±Infinity. Layout is when the height is actually known.

  Parameters

  • plotHeight: number

  Returns void

yToPrice

• yToPrice(y: number): number

• Price at a media-px y on this pane (for crosshair magnet).

  Parameters

  • y: number

  Returns number