Interface: SizeLegendConfigInterface

Extends

• DisplayStateConfigInterface

Properties

noDataMessage?

optional noDataMessage: string | false

Text to display when there is no data. When set to false, this message will not be displayed.

Default

'No data'

Inherited from

DisplayStateConfigInterface.noDataMessage

loadingMessage?

optional loadingMessage: string | false

Text to display when data is loading. When set to false, this message will not be displayed.

Default

'Data loading...'

Inherited from

DisplayStateConfigInterface.loadingMessage

disableStateMessages?

optional disableStateMessages: boolean

Whether to disable all messages in the DisplayState element.

Default

false

Inherited from

DisplayStateConfigInterface.disableStateMessages

allowPointerEvents?

optional allowPointerEvents: boolean

Whether to allow pointer events on the DisplayState element when message is visible.

Default

false

Inherited from

DisplayStateConfigInterface.allowPointerEvents

label?

optional label: string | (accessor?) => string

The label for the size legend. Can be a string or a function that returns a string based on an accessor.

Default

''

labelFormatter()?

optional labelFormatter: (n) => string

The label formatter function to format the size legend label.

Parameters

Returns

string

The formatted label string.

Default

undefined

extent?

optional extent: [number, number]

The extent of the size legend, represented as a tuple of [min, max] values.

Default

undefined

extentLabels?

optional extentLabels: [number, number]

The labels for the extent of the size legend, represented as a tuple of [min, max] values.

Default

undefined

enableEvents?

optional enableEvents: boolean

Whether to enable events for the size legend.

Default

true

form?

optional form: "line" | "point"

The form of the size legend, either ‘point’ or ‘line’.

Default

'point'

showSublabels?

optional showSublabels: boolean

Whether to show sublabels for the size legend.

Default

false

minSubLabel?

optional minSubLabel: string

The label for the minimum value in the size legend.

Default

'min'

maxSubLabel?

optional maxSubLabel: string

The label for the maximum value in the size legend.

Default

'max'

sizeMultiplier?

optional sizeMultiplier: number

The size multiplier to apply to the size legend.

Default

undefined

onClick()?

optional onClick: (e) => void

Callback function that is called when the size legend is clicked.

Parameters

Returns

void

onMinClick()?

optional onMinClick: (size, value, e) => void

Callback function that is called when the minimum value in the size legend is clicked.

Parameters

Returns

void

onMaxClick()?

optional onMaxClick: (size, value, e) => void

Callback function that is called when the maximum value in the size legend is clicked.

Parameters

Returns

void

onHover()?

optional onHover: (e) => void

Callback function that is called when the size legend is hovered over.

Parameters

Returns

void