Interface SeriesTransformDefinition

What the transform tier registers for one transform.

interface SeriesTransformDefinition {
    inputs: readonly IndicatorInput[];
    name: string;
    renderer: SeriesType;
    create(
        options: Readonly<Record<string, string | number>>,
    ): SeriesTransformRun;
}

Properties

inputs name renderer

Methods

create

Properties

inputs

inputs: readonly IndicatorInput[]

The options it takes, described the way a study describes its inputs, so create checks a spec against them and a settings dialog renders them. Only number and select inputs are used.

name

name: string

Display name, for a settings group or a menu.

renderer

renderer: SeriesType

The renderer its elements draw with.

Methods

create

  • create(options: Readonly<Record<string, string | number>>): SeriesTransformRun

  • Build a run. Throws a TypeError naming an option the transform does not take or a value outside what its input allows, before anything is built: how a host checks a spec from outside (a saved layout).

    Parameters

    • options: Readonly<Record<string, string | number>>

    Returns SeriesTransformRun

Settings

Member Visibility

On This Page

Properties
Methods