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"

IgrLegend 

new IgrLegend(props: IIgrLegendProps): IgrLegend

Returns IgrLegend

Properties

Section titled "Properties"

container

Section titled "container" 
container: ReactWrapper

Accessors

Section titled "Accessors"

i

Section titled "i" 
get i(): Legend

Returns Legend

isFinancial

Section titled "isFinancial"

Inherited from: IgrLegendBase

Gets if the legend is a financial legend.

 
get isFinancial(): boolean

Returns boolean

isItemwise

Section titled "isItemwise"

Inherited from: IgrLegendBase

Gets if the legend is item-wise.

 
get isItemwise(): boolean

Returns boolean

orientation

Section titled "orientation"

Gets or sets the current Legend object's orientation.

``

 
get orientation(): LegendOrientation

Returns LegendOrientation 

set orientation(v: LegendOrientation): void

Parameters

Returns void

textColor

Section titled "textColor"

Gets or sets color of text

``

 
get textColor(): string

Returns string 

set textColor(v: string): void

Parameters

  • v: string

Returns void

textStyle

Section titled "textStyle"

Gets or sets style of text.

``

 
get textStyle(): string

Returns string 

set textStyle(v: string): void

Parameters

  • v: string

Returns void

Methods

Section titled "Methods"

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): void

Returns void

destroy

Section titled "destroy" 
destroy(): void

Returns void

exportSerializedVisualData

Section titled "exportSerializedVisualData"

Inherited from: IgrLegendBase

Returns the legend visuals expressed as a serialized string.

 
exportSerializedVisualData(): string

Returns string

findByName

Section titled "findByName"

Inherited from: IgrLegendBase 

findByName(name: string): any

Parameters

  • name: string

Returns any

flushTextContentChangedCheck

Section titled "flushTextContentChangedCheck"

Inherited from: IgrLegendBase

Use to force the Legend to check for differences in text content.

 
flushTextContentChangedCheck(): void

Returns void

render

Section titled "render" 
render(): DetailedReactHTMLElement<object, HTMLDivElement>

Returns DetailedReactHTMLElement<object, HTMLDivElement>

shouldComponentUpdate

Section titled "shouldComponentUpdate"

Inherited from: IgrLegendBase 

shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

simulateClick

Section titled "simulateClick"

Inherited from: IgrLegendBase 

simulateClick(point: IgPoint): void

Parameters

  • point: IgPoint

Returns void

simulateHover

Section titled "simulateHover"

Inherited from: IgrLegendBase 

simulateHover(point: IgPoint): void

Parameters

  • point: IgPoint

Returns void

simulateMouseLeave

Section titled "simulateMouseLeave"

Inherited from: IgrLegendBase 

simulateMouseLeave(): void

Returns void