Interface RenderLegendOptions

Options accepted by renderLegend.

interface RenderLegendOptions {
    emptyText?: string;
    layout?: LegendLayout;
    items: readonly LegendItem[];
    separator?: string;
    width?: number;
}

Hierarchy (View Summary)

RenderLegendOptions
- LegendData

Index

Properties

emptyText? layout? items separator? width?

Properties

`Optional`emptyText

emptyText?: string

Text rendered when items is empty.

Default Value

'No legend items'

`Optional`layout

layout?: LegendLayout

Arrangement of legend entries.

Default Value

'horizontal'

items

items: readonly LegendItem[]

Ordered legend items.

`Optional`separator

separator?: string

Separator between horizontally rendered entries.

Default Value

' '

`Optional`width

width?: number

Optional maximum width of each rendered line.