Interface IndicatorAttachContext

Optionalsignal

store

OptionaladdPrimitive

• addPrimitive(p: IPrimitive): void

• Attach a primitive to this indicator's pane, and detach it again.

  Parameters

  • p: IPrimitive

  Returns void

bars

• bars(): readonly Bar[]

• The bars the study computes on now: the chart's, or the underlying bars for a study set to them (IndicatorApi.setBarSource).

  Returns readonly Bar[]

OptionaldataContext

• dataContext(): undefined | Readonly<ChartDataContext>

• Optional host identity, independent of the indicator's own settings.

  Returns undefined | Readonly<ChartDataContext>

Optionalemit

• emit(event: string, payload: unknown): void

• Emit on the chart's own event bus, the one chart.on(name, cb) listens to.

  The declarative alerts slot covers a condition read off the bars; this is the imperative half, for an indicator whose signal arrives from outside the calculation entirely (a subscription its attach opened).

  Parameters

  • event: string
  • payload: unknown

  Returns void

Optionalinterval

• interval(): undefined | string

• The chart's timeframe ('5m', '1d'), on the same terms as symbol.

  Returns undefined | string

Optionalnow

• now(): number

• Chart wall clock in UTC seconds, the same clock the countdown row uses.

  Returns number

OptionalpaneIndex

• paneIndex(): number

• The pane this instance drew into. Moves when panes are reordered.

  Returns number

OptionalremovePrimitive

• removePrimitive(p: IPrimitive): void

• Parameters

  • p: IPrimitive

  Returns void

OptionalrequestBars

• requestBars(request: IndicatorBarsRequest): Promise<readonly Bar[]>

• Ask the host for another instrument's (or interval's) bars. Always present under chart.addIndicator; it rejects when the host has registered no provider (chart.setBarsProvider), so a study can treat the rejection as "unsupported here" and say so through setDataStatus.

  Parameters

  • request: IndicatorBarsRequest

  Returns Promise<readonly Bar[]>

requestRecompute

• requestRecompute(): void

• Re-run calc and repaint: call when external data arrives.

  Returns void

OptionalrequestSnapshot

• requestSnapshot(
      request: IndicatorSnapshotRequest,
  ): Promise<RequestedBarsSnapshot>

• Request explicit confirmation and availability without inferring either from raw bars.

  Parameters

  • request: IndicatorSnapshotRequest

  Returns Promise<RequestedBarsSnapshot>

OptionalrequestState

• requestState(): Readonly<IndicatorRequestState>

• Native source, provider and replay identity, read at request time.

  Returns Readonly<IndicatorRequestState>

OptionalsetDataRetry

• setDataRetry(retry: null | () => void): void

• Parameters

  • retry: null | () => void

  Returns void

OptionalsetDataStatus

• setDataStatus(status: IndicatorDataStatus): void

• Publish status and an explicit retry action for this instance.

  Parameters

  • status: IndicatorDataStatus

  Returns void

settings

• settings(): Readonly<IndicatorSettings>

• Current settings (live: read at call time, not captured).

  Returns Readonly<IndicatorSettings>

OptionalsubscribeDataChanges

• subscribeDataChanges(
      listener: (change: IndicatorDataChange) => void,
  ): () => void

• Read bars and identity again when the host publishes a change.

  Parameters

  • listener: (change: IndicatorDataChange) => void

  Returns () => void

OptionalsubscribeRequestChanges

• subscribeRequestChanges(listener: () => void): () => void

• Includes source revisions, provider changes and within-bar replay clock movement.

  Parameters

  • listener: () => void

  Returns () => void

Optionalsymbol

• symbol(): undefined | string

• The instrument the chart is showing, when the host knows it.

  Hosts can supply this through IndicatorHost or Chart's explicit data context. Without a configured identity it stays undefined. External studies read dataContext to include the exchange as well.

  Returns undefined | string

Optionaltimezone

• timezone(): string

• The chart's IANA zone, the one its axis is labelled in.

  Returns string