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

    Interface RelativeVolatilityIndexOptions<S, Output>

    interface RelativeVolatilityIndexOptions<
        S extends SeriesSchema,
        Output extends string,
    > {
        column?: NumericColumnNameForSchema<S>;
        output?: Output;
        period?: number;
        stdevPeriod?: number;
    }

    Type Parameters

    • S extends SeriesSchema
    • Output extends string
    Index

    Properties

    column?: NumericColumnNameForSchema<S>

    Source column. Default 'close'.

    output?: Output

    Name of the appended column. Default 'relVol' — deliberately not rvi, which is relativeVigorIndex's prefix, so the two studies can sit on one series.

    period?: number

    Wilder-smoothing look-back in bars. Default 14.

    stdevPeriod?: number

    Standard-deviation window in bars. Default 10.