Represents a legend in a IgxDataChartComponent control.

The Legend helps end-user identify visuals of chart series with contextual information related to the data plotted in the chart control.

<IgrDataChart
dataSource={this.data}
ref={this.onChartRef} width="100%" height="400px">
<IgrCategoryXAxis name="xAxis" label="Country" />
<IgrNumericYAxis name="yAxis" minimumValue={0} />

<IgrLegend ref={this.onLegendRef}
orientation="Horizontal" />
public onChartRef(chart: IgrDataChart) {
this.chart = chart;
if (this.legend) {
this.chart.legend = this.legend;
}
}

public onLegendRef(legend: IgrLegend) {
this.legend = legend;
if (this.chart) {
this.chart.legend = this.legend;
}
}

Hierarchy

Hierarchy

Constructors

Properties

container: ReactWrapper
context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<IIgrLegendProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get i(): Legend
  • Returns Legend

  • get isFinancial(): boolean
  • Gets if the legend is a financial legend.

    Returns boolean

  • get isItemwise(): boolean
  • Gets if the legend is item-wise.

    Returns boolean

  • get orientation(): LegendOrientation
  • Gets or sets the current Legend object's orientation.

    <IgrLegend ref={this.onLegendRef}
    orientation="Horizontal" />

    Returns LegendOrientation

  • set orientation(v): void
  • Parameters

    Returns void

  • get textColor(): string
  • Gets or sets color of text

     <IgrLegend ref={this.onLegendRef}
    textColor= "red" />

    Returns string

  • set textColor(v): void
  • Parameters

    • v: string

    Returns void

  • get textStyle(): string
  • Gets or sets style of text.

     <IgrLegend ref={this.onLegendRef}
    textStyle= "9pt Verdana" />

    Returns string

  • set textStyle(v): void
  • Parameters

    • v: string

    Returns void

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<IIgrLegendProps>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Returns void

  • Returns the legend visuals expressed as a serialized string.

    Returns string

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

  • Returns DetailedReactHTMLElement<{
        className: string;
        ref: ((div) => void);
    }, HTMLDivElement>

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean