Represents a legend in a DataChartComponent control.
The Legend helps end-user identify visuals of chart series with contextual information related to the data plotted in the chart control.
Constructors
Section titled "Constructors"IgcLegendComponent
new IgcLegendComponent(): IgcLegendComponentReturns IgcLegendComponent
Properties
Section titled "Properties"container
Section titled "container"container: WebComponentWrapperhtmlTagName
Section titled "htmlTagName"htmlTagName: stringlegendItemMouseEnter
Section titled "legendItemMouseEnter"Inherited from: IgcLegendBaseComponent
legendItemMouseEnter: objectlegendItemMouseLeave
Section titled "legendItemMouseLeave"Inherited from: IgcLegendBaseComponent
legendItemMouseLeave: objectlegendItemMouseLeftButtonDown
Section titled "legendItemMouseLeftButtonDown"Inherited from: IgcLegendBaseComponent
legendItemMouseLeftButtonDown: objectlegendItemMouseLeftButtonUp
Section titled "legendItemMouseLeftButtonUp"Inherited from: IgcLegendBaseComponent
legendItemMouseLeftButtonUp: objectlegendItemMouseMove
Section titled "legendItemMouseMove"Inherited from: IgcLegendBaseComponent
legendItemMouseMove: objectlegendTextContentChanged
Section titled "legendTextContentChanged"Inherited from: IgcLegendBaseComponent
legendTextContentChanged: objectorientation
Section titled "orientation"orientation: LegendOrientationtextColor
Section titled "textColor"textColor: stringtextStyle
Section titled "textStyle"textStyle: stringAccessors
Section titled "Accessors"get i(): LegendReturns Legend
isFinancial
Section titled "isFinancial"Inherited from: IgcLegendBaseComponent
Gets if the legend is a financial legend.
get isFinancial(): booleanReturns boolean
isItemwise
Section titled "isItemwise"Inherited from: IgcLegendBaseComponent
Gets if the legend is item-wise.
get isItemwise(): booleanReturns boolean
observedAttributes
Section titled "observedAttributes"get observedAttributes(): string[]Returns string[]
Methods
Section titled "Methods"attributeChangedCallback
Section titled "attributeChangedCallback"Inherited from: IgcLegendBaseComponent
attributeChangedCallback(name: string, oldValue: string, newValue: string): voidParameters
- name:
string - oldValue:
string - newValue:
string
Returns void
connectedCallback
Section titled "connectedCallback"connectedCallback(): voidReturns void
destroy
Section titled "destroy"destroy(): voidReturns void
disconnectedCallback
Section titled "disconnectedCallback"disconnectedCallback(): voidReturns void
exportSerializedVisualData
Section titled "exportSerializedVisualData"Inherited from: IgcLegendBaseComponent
Returns the legend visuals expressed as a serialized string.
exportSerializedVisualData(): stringReturns string
findByName
Section titled "findByName"Inherited from: IgcLegendBaseComponent
findByName(name: string): anyParameters
- name:
string
Returns any
flushTextContentChangedCheck
Section titled "flushTextContentChangedCheck"Inherited from: IgcLegendBaseComponent
Use to force the Legend to check for differences in text content.
flushTextContentChangedCheck(): voidReturns void
simulateClick
Section titled "simulateClick"Inherited from: IgcLegendBaseComponent
simulateClick(point: IgPoint): voidParameters
- point:
IgPoint
Returns void
simulateHover
Section titled "simulateHover"Inherited from: IgcLegendBaseComponent
simulateHover(point: IgPoint): voidParameters
- point:
IgPoint
Returns void
simulateMouseLeave
Section titled "simulateMouseLeave"Inherited from: IgcLegendBaseComponent
simulateMouseLeave(): voidReturns void
register
Section titled "register"register(): void