Interface PaneLegendOptions

interface PaneLegendOptions {
    actions?: readonly PaneLegendAction[];
    color?: string;
    font?: number;
    hidden?: boolean;
    id: string;
    left?: number;
    maximized?: boolean;
    params?: string;
    row?: number;
    title: string;
    top?: number;
    valueColor?: string;
}

Properties

actions? color? font? hidden? id left? maximized? params? row? title top? valueColor?

Properties

Optionalactions

actions?: readonly PaneLegendAction[]

Which inline action buttons to draw, left to right. Each hit-tests as ${id}::<action>:

  • up / down — move this pane one slot (::up / ::down)
  • hide — toggle visibility (::hide)
  • maximize — expand this pane to fill the chart (::maximize)
  • close — remove the source, and its pane if it empties (::close)

Defaults to ['up', 'down', 'hide', 'maximize', 'close'] for pane sources and ['hide', 'close'] for overlays (pass explicitly to override).

Optionalcolor

color?: string

Swatch color; omitted draws no swatch.

Optionalfont

font?: number

Text size in media px. Default 11.

Optionalhidden

hidden?: boolean

Rendered as hidden (dimmed, eye hollow).

id

id: string

Stable id; buttons hit-test as ${id}::close etc.

Optionalleft

left?: number

Left inset from the plot edge in media px. Default 8.

Optionalmaximized

maximized?: boolean

Rendered as maximized (the maximize glyph becomes restore).

Optionalparams

params?: string

Dimmed parameter summary after the title, e.g. 14 close.

Optionalrow

row?: number

Vertical slot on the pane (0 = topmost).

title

title: string

Bold source name, e.g. RSI.

Optionaltop

top?: number

Top inset in media px. Default 6.

OptionalvalueColor

valueColor?: string

Color for the live value. Defaults to color, then the theme's text — so a row can tint its reading (an up/down change) without being forced to show a swatch in that same color.

Settings

Member Visibility

On This Page

Properties