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

    Interface TradeVolumeIndexOptions<S, Output>

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

    Type Parameters

    • S extends SeriesSchema
    • Output extends string
    Index

    Properties

    column? minTick output? volume?

    Properties

    column?: NumericColumnNameForSchema<S>

    Price column the tick direction is read from. Default 'close'.

    minTick: number

    Required.* The instrument's minimum tick — how far the price must move for the trade to count as a new direction, in the price's own units. There is no default; see the study docstring for why. Must be positive and finite.

    output?: Output

    Name of the appended column. Default 'tvi'.

    volume?: NumericColumnNameForSchema<S>

    Volume column. Default 'volume'.

    Settings

    Member Visibility

    On This Page

    Properties