Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ILegendModifier3DOptions

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

Optional parameters used to configure a LegendModifier3D at construct time

Hierarchy

Index

Properties

Properties

Optional backgroundColor

backgroundColor: string

Sets the legend background color. Defaults to theme.legendBackgroundBrush

Optional excludedSeriesIds

excludedSeriesIds: string[]

A list of 3D renderable series to exclude from this modifier

remarks

Also see ChartModifierBase3D.includedSeries which has methods to include or exclude a series by instance

Optional executeCondition

executeCondition: TModifierExecuteCondition

The primary action execute condition that modifier should respond to

Optional id

id: string

A unique Id for the ChartModifierBase3D

Optional includedSeriesIds

includedSeriesIds: string[]

A list of 3D renderable series to include to this modifier

remarks

Also see ChartModifierBase3D.includedSeries which has methods to include or exclude a series by instance

Optional isCheckedChangedCallback

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

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

param
param

Type declaration

Optional legend

legend: SciChart3DLegend

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 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

Generated using TypeDoc