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

    Interface RelativeVigorIndexOptions<S, Prefix>

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

    Type Parameters

    • S extends SeriesSchema
    • Prefix extends string
    Index

    Properties

    close? high? low? open? period? prefix?

    Properties

    close?: NumericColumnNameForSchema<S>

    Close column. Default 'close'.

    high?: NumericColumnNameForSchema<S>

    High column. Default 'high'.

    low?: NumericColumnNameForSchema<S>

    Low column. Default 'low'.

    open?: NumericColumnNameForSchema<S>

    Open column. Default 'open'.

    period?: number

    Summation look-back in bars. Default 10.

    prefix?: Prefix

    Column-family prefix — appends ${prefix} and ${prefix}Signal. Default 'rvi'. Note rvi is also the usual abbreviation of the Relative Volatility Index, which is a different study and now ships as relativeVolatilityIndex; it takes relVol as its default output precisely so the two can coexist on one series.

    Settings

    Member Visibility

    On This Page

    Properties