MAIDR JavaScript API
    Preparing search index...

    Interface LightweightChartsOptions

    Options for reading a Lightweight Charts chart.

    interface LightweightChartsOptions {
        id?: string;
        title?: string;
        subtitle?: string;
        caption?: string;
        axes?: { x?: string; y?: string };
        formatTime?: (time: LwcTime) => string;
        live?: boolean;
        maxWidth?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id? title? subtitle? caption? axes? formatTime? live? maxWidth?

    Properties

    id?: string

    The MAIDR figure id; it must be unique on the page, and is what the live API addresses the chart by. Defaults to the chart container's id, or a generated one when the container has none.

    title?: string

    Chart title announced on focus.

    subtitle?: string
    caption?: string
    axes?: { x?: string; y?: string }

    Axis labels. x labels the time axis of every layer (default Time). y labels any series without a title option of its own (default Price for candlestick and OHLC bar series, Value otherwise).

    formatTime?: (time: LwcTime) => string

    Turns a horizontal-scale item into the label MAIDR announces. By default a business day or a yyyy-mm-dd string is read as it is written, and a timestamp as its UTC date -- with the time of day as well when any bar on the chart falls other than at midnight.

    live?: boolean

    Mark the figure live, which enables monitor mode (M) and in-place data updates. bindLightweightChart defaults it to true, since it keeps MAIDR in step with the chart; fromLightweightChart, which does not, defaults it to false.

    maxWidth?: number

    Keep only the newest maxWidth points of each series.

    Settings

    Member Visibility

    On This Page

    Properties