@pond-ts/financial API Reference
    Preparing search index...

    Interface RainbowOscillatorOptions<S, Prefix>

    interface RainbowOscillatorOptions<
        S extends SeriesSchema,
        Prefix extends string,
    > {
        column?: NumericColumnNameForSchema<S>;
        lookback?: number;
        period?: number;
        prefix?: Prefix;
        type?: MaType;
    }

    Type Parameters

    • S extends SeriesSchema
    • Prefix extends string
    Index

    Properties

    column?: NumericColumnNameForSchema<S>

    Source column — read as the price, as the stack's input, and as the range the reading is normalised by. Default 'close'.

    lookback?: number

    Look-back for the highest/lowest of column, in bars. Default 10.

    period?: number

    Length of each average in the stack, in bars. Default 2.

    prefix?: Prefix

    Column-family prefix — appends ${prefix}, ${prefix}Upper and ${prefix}Lower. Default 'rbo'.

    type?: MaType

    Which moving average the stack uses. Default 'sma'. Spelled type, not maType, by deliberate exception to the package's rule (type when the columns ARE the averages, maType when an average sits inside a study): this option IS rainbow's type, passed through unchanged to the same ten-stage stack, and a consumer who runs both studies passes one spelling to both.