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

    Interface VortexOptions<S, Prefix>

    interface VortexOptions<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

    Look-back for the three sums, in bars. Default 14.

    prefix?: Prefix

    Column-family prefix — appends ${prefix}Plus / ${prefix}Minus. Default 'vi'.

    Settings

    Member Visibility

    On This Page

    Properties