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

    Interface StarcBandsOptions<S, Prefix>

    interface StarcBandsOptions<S extends SeriesSchema, Prefix extends string> {
        atrPeriod?: number;
        close?: NumericColumnNameForSchema<S>;
        high?: NumericColumnNameForSchema<S>;
        low?: NumericColumnNameForSchema<S>;
        maType?: MaType;
        multiplier?: number;
        period?: number;
        prefix?: Prefix;
    }

    Type Parameters

    • S extends SeriesSchema
    • Prefix extends string
    Index

    Properties

    atrPeriod? close? high? low? maType? multiplier? period? prefix?

    Properties

    atrPeriod?: number

    ATR look-back in bars. Default 15 (Stoller's own).

    close?: NumericColumnNameForSchema<S>

    Close column — the centre line's input and an ATR input. Default 'close'.

    high?: NumericColumnNameForSchema<S>

    High column (ATR input). Default 'high'.

    low?: NumericColumnNameForSchema<S>

    Low column (ATR input). Default 'low'.

    maType?: MaType

    Centre-line moving average — any of the shared MaType menu. Default 'sma' (Stoller's definition names a simple average).

    multiplier?: number

    Band half-width in ATRs. Default 2.

    period?: number

    Centre-line look-back in bars. Default 20.

    prefix?: Prefix

    Column-family prefix — appends ${prefix}Middle / ${prefix}Upper / ${prefix}Lower. Default 'starc'.

    Settings

    Member Visibility

    On This Page

    Properties