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

    Interface AtrBandsOptions<S, Prefix>

    interface AtrBandsOptions<S extends SeriesSchema, Prefix extends string> {
        close?: NumericColumnNameForSchema<S>;
        column?: NumericColumnNameForSchema<S>;
        high?: NumericColumnNameForSchema<S>;
        low?: NumericColumnNameForSchema<S>;
        multiplier?: number;
        period?: number;
        prefix?: Prefix;
    }

    Type Parameters

    • S extends SeriesSchema
    • Prefix extends string
    Index

    Properties

    close? column? high? low? multiplier? period? prefix?

    Properties

    close?: NumericColumnNameForSchema<S>

    Close column (ATR input). Default 'close'.

    column?: NumericColumnNameForSchema<S>

    The field the bands are drawn around. Default: whatever close resolves to ('close' unless redirected), so redirecting close moves the bands with the true range.

    high?: NumericColumnNameForSchema<S>

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

    low?: NumericColumnNameForSchema<S>

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

    multiplier?: number

    Band half-width in ATRs. Default 2.

    period?: number

    ATR look-back in bars. Default 14 (Wilder's own).

    prefix?: Prefix

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

    Settings

    Member Visibility

    On This Page

    Properties