All docs
V23.1
23.2 (CTP)
23.1
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
The page you are viewing does not exist in version 19.2.
19.1
The page you are viewing does not exist in version 19.1.
18.2
The page you are viewing does not exist in version 18.2.
18.1
The page you are viewing does not exist in version 18.1.
17.2
The page you are viewing does not exist in version 17.2.

jQuery PieChart - Legend

Specifies PieChart legend properties.

import { Legend } from "devextreme/viz/pie_chart"

customizeHint

Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item.

Type:

Function

Function parameters:
pointInfo:

Object

Information on the series point.

Object structure:
Name Type Description
pointColor

String

The point's color.

pointIndex

Number

The point's index.

pointName any

The point's name.

Return Value:

String

The text for the hint to display.

customizeItems

Allows you to change the order, text, and visibility of legend items.

Type:

Function

Function parameters:

Legend items before customizations.

Return Value:

Array<PieChartLegendItem>

Legend items after customizations.

customizeText

Specifies a callback function that returns the text to be displayed by a legend item.

Type:

Function

Function parameters:
pointInfo:

Object

Information on the series point.

Object structure:
Name Type Description
pointColor

String

The point's color.

pointIndex

Number

The point's index.

pointName any

The point's name.

Return Value:

String

The text for the legend item to display.

Cannot be used in themes.

hoverMode

Specifies what chart elements to highlight when a corresponding item in the legend is hovered over.

Default Value: 'allArgumentPoints'

markerTemplate

Specifies an SVG element that serves as a custom legend item marker.

Type:

template

Template Data:

PieChartLegendItem

Information about a legend item.

Default Name: undefined