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

    Interface EnvelopeOptions<S, Prefix>

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

    Type Parameters

    • S extends SeriesSchema
    • Prefix extends string
    Index

    Properties

    column? maType? percent? period prefix?

    Properties

    column?: NumericColumnNameForSchema<S>

    Source column. Default 'close'.

    maType?: MaType

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

    percent?: number

    Band half-width as a percent of the centre line. Default 2.5.

    period: number

    Window length in bars.

    prefix?: Prefix

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

    Settings

    Member Visibility

    On This Page

    Properties