All docs
V24.1
24.2
24.1
23.2
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.

JavaScript/jQuery Funnel - Legend

Configures the legend.

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

customizeHint

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

Type:

Function

Function parameters:
itemInfo:

Object

Information on the funnel item and its corresponding legend item.

Object structure:
Name Type Description
item

Funnel Item

The Item object.

text

String

The legend item's text.

Return Value:

String

The text to be displayed in the hint.

customizeItems

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

Type:

Function

Function parameters:

Legend items before customizations.

Return Value:

Array<FunnelLegendItem>

Legend items after customizations.

customizeText

Customizes the text displayed by legend items.

Type:

Function

Function parameters:
itemInfo:

Object

Information on the funnel item and its corresponding legend item.

Object structure:
Name Type Description
item

Funnel Item

The Item object.

text

String

The legend item's original text.

Return Value:

String

The text for the legend item to display.

Cannot be used in themes.

markerTemplate

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

Type:

template

Template Data:

FunnelLegendItem

Information about a legend item.

Default Name: undefined

visible

Specifies whether the legend is visible.

Type:

Boolean

Default Value: false