Interface Tier2Descriptor

interface Tier2Descriptor {
    category?: string;
    id: string;
    inputs: readonly IndicatorInput[];
    name: string;
    placement: "onchart" | "pane";
    plots: readonly IndicatorPlot[];
    refetchOn?: readonly string[];
    fetch(ctx: Tier2Context): Promise<readonly Tier2Point[]>;
    levels(settings: Readonly<IndicatorSettings>): readonly IndicatorLevel[];
    range(
        settings: Readonly<IndicatorSettings>,
    ): null | { max: number; min: number };
    subscribe(ctx: Tier2Context, push: (point: Tier2Point) => void): () => void;
    supports(ctx: Tier2Context): boolean;
}

Index

Properties

category? id inputs name placement plots refetchOn?

Methods

fetch levels? range? subscribe? supports?

Properties

`Optional`category

category?: string

id

id: string

inputs

inputs: readonly IndicatorInput[]

name

name: string

placement

placement: "onchart" | "pane"

plots

plots: readonly IndicatorPlot[]

`Optional`refetchOn

refetchOn?: readonly string[]

Settings keys that invalidate the fetched data when they change (symbol, exchange, resolution). Changing anything else only re-runs alignment.

Methods

fetch

fetch(ctx: Tier2Context): Promise<readonly Tier2Point[]>
Load the series for the current window.
Parameters
- ctx: Tier2Context
Returns Promise<readonly Tier2Point[]>
- Defined in src/indicators/external.ts:59

`Optional`levels

levels(settings: Readonly<IndicatorSettings>): readonly IndicatorLevel[]
Parameters
- settings: Readonly<IndicatorSettings>
Returns readonly IndicatorLevel[]
- Defined in src/indicators/external.ts:70

`Optional`range

range(
settings: Readonly<IndicatorSettings>,
): null | { max: number; min: number }
Parameters
- settings: Readonly<IndicatorSettings>
Returns null | { max: number; min: number }
- Defined in src/indicators/external.ts:71

`Optional`subscribe

subscribe(ctx: Tier2Context, push: (point: Tier2Point) => void): () => void
Optional live subscription. Call push with each incoming point; return an unsubscribe function.
Parameters
- ctx: Tier2Context
- push: (point: Tier2Point) => void
Returns () => void
- Defined in src/indicators/external.ts:64

`Optional`supports

supports(ctx: Tier2Context): boolean
A host/provider can explicitly decline data it cannot supply.
Parameters
- ctx: Tier2Context
Returns boolean
- Defined in src/indicators/external.ts:57