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

    Interface HighLowBandsOptions<S, Prefix>

    interface HighLowBandsOptions<S extends SeriesSchema, Prefix extends string> {
        high?: NumericColumnNameForSchema<S>;
        low?: NumericColumnNameForSchema<S>;
        maType?: MaType;
        percent?: number;
        period?: number;
        prefix?: Prefix;
    }

    Type Parameters

    • S extends SeriesSchema
    • Prefix extends string
    Index

    Properties

    high? low? maType? percent? period? prefix?

    Properties

    high?: NumericColumnNameForSchema<S>

    High column. Default 'high'.

    low?: NumericColumnNameForSchema<S>

    Low column. Default 'low'.

    maType?: MaType

    Centre-line moving average — any of the shared MaType menu. Default 'trima'.

    percent?: number

    Band half-width as a percent of the centre line. Default 1. (envelope spells the same quantity percent; see the docstring.)

    period?: number

    Centre-line look-back in bars. Default 10.

    prefix?: Prefix

    Column-family prefix — appends ${prefix}Middle / ${prefix}Upper / ${prefix}Lower. Default 'hlb'.

    Settings

    Member Visibility

    On This Page

    Properties