BuyLog In
DevExtreme
All docs
V 24.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.
All docs
V24.1

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

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

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
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.
Full-text search
Overview
Getting Started
UI Components
Accordion
ActionSheet
Autocomplete
BarGauge
Box
Bullet
Button
ButtonGroup
Calendar
Chart
CheckBox
CircularGauge
ColorBox
ContextMenu
DataGrid
DateBox
DateRangeBox
DeferRendering
Diagram
Draggable
Drawer
DropDownBox
DropDownButton
FileManager
FileUploader
FilterBuilder
Floating Action Button
Form
Funnel
Gallery
Gantt
HtmlEditor
LinearGauge
List
LoadIndicator
LoadPanel
Lookup
Map
Menu
MultiView
NumberBox
PieChart
PivotGrid
PivotGridFieldChooser
PolarChart
Popover
Popup
ProgressBar
RadioGroup
RangeSelector
RangeSlider
Resizable
ResponsiveBox
Sankey
Scheduler
ScrollView
SelectBox
Slider
Sortable
Sparkline
Splitter
Switch
TabPanel
Tabs
TagBox
TextArea
TextBox
TileView
Toast
Toolbar
Tooltip
TreeList
TreeMap
TreeView
VectorMap
Overview
How To
API
Configuration
Methods
Events
Map Elements
Interfaces
Types
CenterChangedEvent
ClickEvent
DisposingEvent
DrawnEvent
ExportedEvent
ExportingEvent
FileSavingEvent
IncidentOccurredEvent
InitializedEvent
Legend
customizeHint
customizeItems
customizeText
markerColor
markerShape
markerSize
markerTemplate
OptionChangedEvent
SelectionChangedEvent
Tooltip
TooltipHiddenEvent
TooltipShownEvent
VectorMapLayerType
VectorMapMarkerShape
VectorMapMarkerType
VectorMapProjection
ZoomFactorChangedEvent
Demos
Common Types
Utilities
Data Binding
Data Validation
TypeScript Guides
Localization and Globalization
UI Customization
Integration Guides
DevExtreme CLI
Data Analytics and BI
.NET Backend Solutions
Advanced Topics
Troubleshooting
Migrate to the New Version

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

Controls and Extensions

ASP.NET Web Forms Controls
ASP.NET MVC Extensions
ASP.NET Core Controls
ASP.NET Bootstrap Controls
DevExtreme
DevExtreme ASP.NET MVC Controls
Blazor Components

Tools

ASP.NET Theme Builder
ASP.NET Theme Deployer

Maintenance Mode

ASP.NET Core Bootstrap Controls

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 VectorMap - Legend

Configures map legends.

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

customizeHint

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

Type:

Function

Function parameters:
itemInfo:

Object

Information on a legend item.

Object structure:
Name Type Description
color

String

The legend item's color. This field is undefined if the source is 'markerSizeGroups'.
end

Number

The end value of the group indicated by the legend item.
index

Number

The group's index.
size

Number

The diameter of the legend item in pixels. This field is undefined if the source is 'areaColorGroups' or 'markerColorGroups'.
start

Number

The start value of the group indicated by the legend item.
Return Value:

String

The text for the hint to display.

Cannot be used in themes.

customizeItems

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

Type:

Function

Function parameters:
items:

Array<VectorMapLegendItem>

Legend items before customizations.

Return Value:

Array<VectorMapLegendItem>

Legend items after customizations.

customizeText

Specifies text for legend items.

Type:

Function

Function parameters:
itemInfo:

Object

Information on a legend item.

Object structure:
Name Type Description
color

String

The legend item's color. This field is undefined if the source is 'markerSizeGroups'.
end

Number

The end value of the group indicated by the legend item.
index

Number

The group's index.
size

Number

The diameter of the legend item in pixels. This field is undefined if the source is 'areaColorGroups' or 'markerColorGroups'.
start

Number

The start value of the group indicated by the legend item.
Return Value:

String

The text for the legend item to display.

Cannot be used in themes.

markerColor

Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source.

Type:

String

Default Value: undefined

markerShape

Specifies the shape of item markers.

Type:

VectorMapMarkerShape

Default Value: 'square'

markerSize

Specifies the marker's size in a legend item in pixels.

Type:

Number

Default Value: 12

markerTemplate

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

Type:

template

Template Data:

VectorMapLegendItem

Information about a legend item.

Default Name: undefined