Interface LegendStatusLineOptions

Per-field switches for the status line. Every one defaults to on, so the absent option object reproduces the row exactly as it drew before these existed. A field whose data is missing draws nothing whether it is on or off.

interface LegendStatusLineOptions {
    background?: boolean;
    backgroundColor?: string;
    backgroundOpacity?: number;
    barChange?: boolean;
    chartValues?: boolean;
    lastDayChange?: boolean;
    lastValueLabel?: boolean;
    logo?: boolean;
    marketStatus?: boolean;
    title?: boolean;
    titleMode?: LegendTitleMode;
    volume?: boolean;
}

Properties

background? backgroundColor? backgroundOpacity? barChange? chartValues? lastDayChange? lastValueLabel? logo? marketStatus? title? titleMode? volume?

Properties

Optionalbackground

background?: boolean

Plate behind the row's text, for legibility over candles. Off by default: the row has never had one, and turning it on is a deliberate choice.

OptionalbackgroundColor

backgroundColor?: string

Plate color. Defaults to the theme background.

OptionalbackgroundOpacity

backgroundOpacity?: number

Plate opacity, 0..1. Default 0.8, matching the hover plate.

OptionalbarChange

barChange?: boolean

Change over the hovered bar: readings tagged field: 'change'.

OptionalchartValues

chartValues?: boolean

The OHLC readout: readings tagged field: 'ohlc'.

OptionallastDayChange

lastDayChange?: boolean

Change since the previous close, from status.lastDayChange.

OptionallastValueLabel

lastValueLabel?: boolean

The source's own reading (untagged values). This is the scales-and-lines "last value label" control, which lands here because the legend is what draws that number on this row.

Optionallogo

logo?: boolean

Symbol logo, when status supplies one.

OptionalmarketStatus

marketStatus?: boolean

Session state from status.marketStatus.

Optionaltitle

title?: boolean

The bold name. Also the "name label" switch for an indicator row.

OptionaltitleMode

titleMode?: LegendTitleMode

Which name the title shows. Default symbol.

Optionalvolume

volume?: boolean

Readings tagged field: 'volume'.

Settings

Member Visibility

On This Page

Properties