Interface ChartObjectSnapshot

One immutable row in a chart's object inventory.

interface ChartObjectSnapshot {
    band?: ChartObjectBand;
    capabilities: ChartObjectCapabilities;
    dataStatus?: Readonly<IndicatorDataStatus>;
    groupId?: string;
    hiddenOnInterval?: boolean;
    id: string;
    kind: ChartObjectKind;
    locked?: boolean;
    name: string;
    paneIndex: number;
    selected: boolean;
    sourceId: string;
    stackAbove?: string;
    visible: boolean;
}

Properties

band? capabilities dataStatus? groupId? hiddenOnInterval? id kind locked? name paneIndex selected sourceId stackAbove? visible

Properties

Optional Readonlyband

band?: ChartObjectBand

The band it paints in, for a row that is part of its pane's stack (see stack).

Readonlycapabilities

capabilities: ChartObjectCapabilities

Optional ReadonlydataStatus

dataStatus?: Readonly<IndicatorDataStatus>

Optional ReadonlygroupId

groupId?: string

Optional ReadonlyhiddenOnInterval

hiddenOnInterval?: boolean

True for a drawing whose interval range leaves out the chart's interval, and for a group all of whose drawings it leaves out: kept and listed so it can be found, but not on the chart. visible stays the user's switch.

Readonlyid

id: string

Readonlykind

kind: ChartObjectKind

Optional Readonlylocked

locked?: boolean

Readonlyname

name: string

ReadonlypaneIndex

paneIndex: number

Readonlyselected

selected: boolean

ReadonlysourceId

sourceId: string

Optional ReadonlystackAbove

stackAbove?: string

For a drawing in the series band: the id of the source or study row it paints directly above.

Readonlyvisible

visible: boolean

Settings

Member Visibility

On This Page

Properties