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

    Interface SwingIndexOptions<S, Output>

    interface SwingIndexOptions<S extends SeriesSchema, Output extends string> {
        close?: NumericColumnNameForSchema<S>;
        high?: NumericColumnNameForSchema<S>;
        limit: number;
        low?: NumericColumnNameForSchema<S>;
        open?: NumericColumnNameForSchema<S>;
        output?: Output;
    }

    Type Parameters

    • S extends SeriesSchema
    • Output extends string
    Index

    Properties

    close? high? limit low? open? output?

    Properties

    close?: NumericColumnNameForSchema<S>

    Close column. Default 'close'.

    high?: NumericColumnNameForSchema<S>

    High column. Default 'high'.

    limit: number

    Required.* The instrument's limit move T — the largest price change one bar is allowed to make, in the price's own units. There is no default; see the study docstring for why. Must be positive and finite.

    low?: NumericColumnNameForSchema<S>

    Low column. Default 'low'.

    open?: NumericColumnNameForSchema<S>

    Open column. Default 'open'.

    output?: Output

    Appended column name. Default 'si' ('asi' for accumulativeSwingIndex).

    Settings

    Member Visibility

    On This Page

    Properties