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

    Interface ZigZagOptions<S, Prefix>

    interface ZigZagOptions<S extends SeriesSchema, Prefix extends string> {
        deviation?: number;
        high?: NumericColumnNameForSchema<S>;
        low?: NumericColumnNameForSchema<S>;
        prefix?: Prefix;
    }

    Type Parameters

    • S extends SeriesSchema
    • Prefix extends string
    Index

    Properties

    deviation?: number

    The reversal threshold, in percent of the leg's extreme. Default 5. A leg ends when price retraces this far from its running extreme — see the study docstring for which side the percent is measured against.

    high?: NumericColumnNameForSchema<S>

    High column — the up-legs' extreme. Default 'high'.

    low?: NumericColumnNameForSchema<S>

    Low column — the down-legs' extreme. Default 'low'.

    prefix?: Prefix

    Column-family prefix — appends ${prefix}Pivot, ${prefix}Direction and ${prefix}Line. Default 'zz'.