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

    Interface DirectionalMovementOptions<S, Prefix>

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

    Type Parameters

    • S extends SeriesSchema
    • Prefix extends string
    Index

    Properties

    close? high? low? period? prefix?

    Properties

    close?: NumericColumnNameForSchema<S>

    Close column. Default 'close'.

    high?: NumericColumnNameForSchema<S>

    High column. Default 'high'.

    low?: NumericColumnNameForSchema<S>

    Low column. Default 'low'.

    period?: number

    Wilder smoothing length in bars, used for all three smooths. Default 14.

    prefix?: Prefix

    Column-family prefix — appends ${prefix}PlusDi / ${prefix}MinusDi / ${prefix}Dx / ${prefix}Adx / ${prefix}Adxr. Default 'dmi'.

    Settings

    Member Visibility

    On This Page

    Properties