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

    Interface IchimokuOptions<S, Prefix>

    interface IchimokuOptions<S extends SeriesSchema, Prefix extends string> {
        basePeriod?: number;
        close?: NumericColumnNameForSchema<S>;
        conversionPeriod?: number;
        displacement?: number;
        high?: NumericColumnNameForSchema<S>;
        low?: NumericColumnNameForSchema<S>;
        prefix?: Prefix;
        spanBPeriod?: number;
    }

    Type Parameters

    • S extends SeriesSchema
    • Prefix extends string
    Index

    Properties

    basePeriod? close? conversionPeriod? displacement? high? low? prefix? spanBPeriod?

    Properties

    basePeriod?: number

    Kijun-sen (base line) window, in bars. Default 26.

    close?: NumericColumnNameForSchema<S>

    Close column — the Chikou span. Default 'close'.

    conversionPeriod?: number

    Tenkan-sen (conversion line) window, in bars. Default 9.

    displacement?: number

    How many bars a chart plots the two spans forward and the Chikou span back. Default 26.

    This option changes no value in any appended column — it is metadata, validated here and echoed by ichimokuOffsets, and the study deliberately does not displace its own data. See "Displacement is data-only" on the study docstring for why.

    high?: NumericColumnNameForSchema<S>

    High column. Default 'high'.

    low?: NumericColumnNameForSchema<S>

    Low column. Default 'low'.

    prefix?: Prefix

    Column-family prefix — appends ${prefix}Tenkan, ${prefix}Kijun, ${prefix}SenkouA, ${prefix}SenkouB and ${prefix}Chikou. Default 'ichi'.

    spanBPeriod?: number

    Senkou Span B window, in bars. Default 52.

    Settings

    Member Visibility

    On This Page

    Properties