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

    Interface VolumeIndexOptions<S, Output>

    interface VolumeIndexOptions<S extends SeriesSchema, Output extends string> {
        column?: NumericColumnNameForSchema<S>;
        output?: Output;
        start?: number;
        volume?: NumericColumnNameForSchema<S>;
    }

    Type Parameters

    • S extends SeriesSchema
    • Output extends string
    Index

    Properties

    column?: NumericColumnNameForSchema<S>

    Price column the return is taken over. Default 'close'.

    output?: Output

    Name of the appended column. Default 'nvi' / 'pvi'.

    start?: number

    The index's starting level. Default 1000 (Fosback's).

    volume?: NumericColumnNameForSchema<S>

    Volume column. Default 'volume'.