Options
All
  • Public
  • Public/Protected
  • All
Menu

Optional parameters used to configure a LegendModifier at construct time

Hierarchy

Index

Properties

Optional backgroundColor

backgroundColor: string

Sets the legend background color. Defaults to theme.legendBackgroundBrush

Optional executeOn

executeOn: EExecuteOn

Defines the operation that modifier should respond to

Optional id

id: string

A unique Id for the ChartModifierBase2D

Optional isCheckedChangedCallback

isCheckedChangedCallback: (series: IRenderableSeries, isChecked: boolean) => void

Callback when a legend item checkbox is checked or unchecked (by default, this corresponds to IRenderableSeries.isVisible

param
param

Type declaration

Optional legend

Set this only if you need to pass in a custom legend instance. showCheckboxes, showSeriesMarkers and isCheckedChangedCallback will be set on the instance you pass if specified in the options.

Optional margin

margin: number

Sets the margin for the legend control

Optional modifierGroup

modifierGroup: string

Defines the Modifier Group string - a grouping by ID for sharing mouse events across charts

Optional orientation

orientation: ELegendOrientation

Sets the initial orientation of the legend. See ELegendOrientation for a list of values

Optional placement

placement: ELegendPlacement

Sets the initial legend placement in the parent chart surface. See ELegendPlacement for a list of values

Optional placementDivId

placementDivId: string | HTMLDivElement

The parent div element Id or reference, the Legend will be appended to this element

Optional showCheckboxes

showCheckboxes: boolean

Sets whether the legend has visibility checkboxes in it or not

Optional showLegend

showLegend: boolean

Sets whether the legend is initially visible or not

Optional showSeriesMarkers

showSeriesMarkers: boolean

Sets whether Series markers are visible or not

Optional textColor

textColor: string

Sets the legend text color. Defaults to theme.labelForegroundBrush

Optional xAxisId

xAxisId: string

The XAxis Id to be used by annotations internal to the modifier. Set if you have multiple x axes and need to distinguish between horizontal/vertical, or stacked axes

Optional xyDirection

xyDirection: EXyDirection

Defines the Xy Direction - whether the modifier works in X, Y or XY or neither direction, for vertical charts the behaviour could be inverted, for example for vertical chart with RubberBandXyZoomModifier and EXyDirection.XDirection the modifier works on Y axis

Optional yAxisId

yAxisId: string

The YAxis Id to be used by annotations internal to the modifier. Set if you have multiple y axes and need the modifier to use something other than the first one.

Generated using TypeDoc