General Information

.NET Subscription

What's Included

DevExpress Installation

DevExpress Code Examples

Common Tools

Project Converter

Assembly Deployment Tool

Localization Service

Quality Assurance and Productivity

CodeRush for Visual Studio (FREE)

TestCafe Studio

Desktop

Controls

WinForms

WPF

VCL

WinUI

Tools

WinForms Skin Editor

WPF Theme Designer

WPF Theme Editor (Legacy)

Coded UI Test Extension

Frameworks and Libraries

XAF - Cross-Platform .NET App UI

XPO - .NET ORM Library (FREE)

XPO Profiler

Core Libraries

Drawing Graphics Library

.NET App Security & Web API Service (FREE)

Web

Mobile

Xamarin UI Controls (FREE)

.NET MAUI (FREE)

Enterprise and Analytic Tools

Reporting

Report and Dashboard Server

BI Dashboard

Office File API

End-User Documentation

Interface Elements for Desktop

Interface Elements for Web

Dashboard for Desktop

Dashboard for Web

JavaScript/jQuery BarGauge - Legend

Configures the legend.

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

customizeHint

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

Type:

Function

Function parameters:

arg:

Object

Information on the bar and its corresponding legend item.

Object structure:

Name	Type	Description
item	BarGaugeBarInfo	Information on the bar.
text	String	The legend item's text.

Name

Type

Description

item

BarGaugeBarInfo

Information on the bar.

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:

items:

Array<BarGaugeLegendItem>

Legend items before customizations.

Return Value:

Array<BarGaugeLegendItem>

Legend items after customizations.

customizeText

Customizes the text displayed by legend items.

Type:

Function

Function parameters:

arg:

Object

Information on the bar and its corresponding legend item.

Object structure:

Name	Type	Description
item	BarGaugeBarInfo	Information on the bar.
text	String	The legend item's text.

Name

Type

Description

item

BarGaugeBarInfo

Information on the bar.

text

String

The legend item's text.

Return Value:

String

The text to be displayed in the hint.

Cannot be used in themes.

itemTextFormat

Formats the item text before it is displayed. Accepts only numeric formats. When unspecified, it inherits the label's format.

Type:

Format

| undefined

Default Value: undefined

markerTemplate

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

Type:

template

| undefined

Function parameters:

legendItem:

BarGaugeLegendItem

Information about a legend item.

element:

SVGGElement

A marker's container.

Return Value:

String

SVGElement

jQuery

One of the following:

Template name
SVG markup as a string
SVGElement
jQuery element that contains an SVGElement

Default Value: undefined

visible

Specifies whether the legend is visible.

Type:

Boolean

Default Value: false

Feedback

Was this page helpful?

Thanks for your feedback!
Any other suggestions? Tell us here.

Additional Feedback

General Information

.NET Subscription

Common Tools

Quality Assurance and Productivity

Desktop

Controls

Tools

Frameworks and Libraries

Web

Controls and Extensions

Tools

Maintenance Mode

Mobile

Enterprise and Analytic Tools

End-User Documentation

General Information

.NET Subscription

Common Tools

Quality Assurance and Productivity

Desktop

Controls

Tools

Frameworks and Libraries

Web

Controls and Extensions

Tools

Maintenance Mode

Mobile

Enterprise and Analytic Tools

End-User Documentation

JavaScript/jQuery BarGauge - Legend

customizeHint

customizeItems

customizeText

itemTextFormat

markerTemplate

visible