Skip to content

SiCustomLegendComponent documentation

selector
si-custom-legend

Input Properties

Name Type Default Description
customLegend
 CustomLegend The data and configuration rendered by the custom legend.
subTitle
 string The legend subtitle.
subTitleColor
 string The color of the legend subtitle.
textColor
 string The color of the legend text.
title
 string The legend title.
titleColor
 string The color of the legend title.

Output Properties

Name Type Description
legendClickEvent
 CustomLegendItem The event emitted when a legend is clicked.
legendHoverEndEvent
 CustomLegendItem The event emitted when the mouse leaves a legend.
legendHoverStartEvent
 CustomLegendItem The event emitted when the mouse enters a legend.
legendIconClickEvent
 CustomLegendItem The event emitted when a legend icon is clicked.

Types Documentation
Properties
customLegends: [ { list: CustomLegendItem[], unit: string }, { list: CustomLegendItem[], unit: string } ]
gridIndex?: number
legendAxis: string
top?: (string | number)
Properties
alternativeNaming?: boolean
color?: string
displayName?: string
name: string
selected: boolean
symbol?: string
tooltip?: string

Except where otherwise noted, content on this site is licensed under MIT License.