Interface SeriesTransformSpec

A transform choice: which one, and the options it was given. JSON-safe, so saved state carries it as it is.

interface SeriesTransformSpec {
    options?: Readonly<Record<string, string | number>>;
    type: string;
}

Properties

Properties

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

The options the transform declares (SeriesTransformDefinition.inputs), by the names its class takes: boxSize, range, lines, reversal. An omitted option takes its default, and a size left at 0 is taken from the history loaded with each setData.

type: string

A registered transform: heikin-ashi, renko, range-bars, line-break, point-figure or kagi once the transform tier is imported.