Class Instrument

constructor

• new Instrument(input: unknown): Instrument

• Parameters

  • input: unknown

  Returns Instrument

Readonlymetadata

ReadonlytickSchedule

applyTo

• applyTo(chart: Chart, interval: string): void

• The host clears old bars and owns source loading; only metadata is applied here.

  Parameters

  • chart: Chart
  • interval: string

  Returns void

formatPrice

• formatPrice(value: number): string

• Formats display only. The source bars retain their unrounded values.

  Parameters

  • value: number

  Returns string

marketStatusAt

• marketStatusAt(utcSeconds: number): MarketStatus

• The market status at an instant: pass Date.now() / 1000 for now.

  Parameters

  • utcSeconds: number

  Returns MarketStatus

phaseAt

• phaseAt(utcSeconds: number): SessionPhase

• The part of the trading day an instant falls in.

  Parameters

  • utcSeconds: number

  Returns SessionPhase

phaseSpans

• phaseSpans(
      fromUtcSeconds: number,
      toUtcSeconds: number,
  ): readonly SessionPhaseSpan[]

• The phases from one instant to another, as consecutive spans clipped to the range, which may be at most 400 days long.

  Parameters

  • fromUtcSeconds: number
  • toUtcSeconds: number

  Returns readonly SessionPhaseSpan[]

sessionAt

• sessionAt(utcSeconds: number): null | InstrumentSession

• Resolve an active window. Closed dates and breaks return null, never inferred hours.

  Parameters

  • utcSeconds: number

  Returns null | InstrumentSession

sessionFrom

• sessionFrom(utcSeconds: number): null | InstrumentSession

• The window active at an instant, or else the next one to open, looking at most about a year ahead. Null when nothing opens in that time.

  Parameters

  • utcSeconds: number

  Returns null | InstrumentSession

supportsInterval

• supportsInterval(code: string): boolean

• Provider tokens are exact: a feed may distinguish monthly M from minute m.

  Parameters

  • code: string

  Returns boolean