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

    Interface BalanceOfPowerOptions<S, Output>

    interface BalanceOfPowerOptions<S extends SeriesSchema, Output extends string> {
        close?: NumericColumnNameForSchema<S>;
        high?: NumericColumnNameForSchema<S>;
        low?: NumericColumnNameForSchema<S>;
        maType?: MaType;
        open?: NumericColumnNameForSchema<S>;
        output?: Output;
        period?: number;
    }

    Type Parameters

    • S extends SeriesSchema
    • Output extends string
    Index

    Properties

    close?: NumericColumnNameForSchema<S>

    Close column. Default 'close'.

    high?: NumericColumnNameForSchema<S>

    High column. Default 'high'.

    low?: NumericColumnNameForSchema<S>

    Low column. Default 'low'.

    maType?: MaType

    Which moving average smooths the per-bar ratio — any of the shared MaType menu. Only meaningful with period, and passing it without one throws rather than silently doing nothing.

    open?: NumericColumnNameForSchema<S>

    Open column. Default 'open'.

    output?: Output

    Name of the appended column. Default 'bop'.

    period?: number

    Optional smoothing length in bars. Omitted by default — the study is TA-Lib's raw per-bar BOP unless this is set. See the docstring's "one indicator, two conventions" note.