Documentation menu

Interface

ChartState

Saved view, layout and drawings (saveState); plain JSON.

Properties

NameTypeDescription
versionnumber
barSpacingnumber
rightOffsetnumber
crosshairMode'normal' | 'magnet' | 'hidden'
panes{ stretch: number; priceScale: { mode: 'normal' | 'logarithmic' | 'percentage' | 'indexedTo100'; inverted: boolean; margins: { top: number; bottom: number; }; range: { low: number; high: number; } | null; }; }[]
drawings{ pane: number; visible: boolean; locked: boolean; data: DrawingData; }[]

Declaration

export interface ChartState {
    version: number;
    barSpacing: number;
    rightOffset: number;
    crosshairMode: 'normal' | 'magnet' | 'hidden';
    panes: {
        stretch: number;
        priceScale: {
            mode: 'normal' | 'logarithmic' | 'percentage' | 'indexedTo100';
            inverted: boolean;
            margins: {
                top: number;
                bottom: number;
            };
            range: {
                low: number;
                high: number;
            } | null;
        };
    }[];
    drawings: {
        pane: number;
        visible: boolean;
        locked: boolean;
        data: DrawingData;
    }[];
}

Used by

FerroChart