All docs
V20.2
21.1
20.2
20.1
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
Box
Map
Vue

source

Specifies the source of data for the legend.

Type:

Object

Cannot be used in themes.

grouping

Specifies the type of the legend grouping.

Type:

String

Cannot be used in themes.

The VectorMap's legend supports three grouping types.

  • color
    Can be used if you have grouped map markers or areas in several differently-colored groups. For more information, refer to the layers's colorGroupingField and colorGroups property descriptions.

  • size
    Available for markers of a bubble type only. Can be used if you have grouped bubble markers in several groups and specified a size for bubbles in each group. For more information, refer to the sizeGroupingField and sizeGroups property descriptions.

View Demo

layer

Specifies a layer to which the legend belongs.

Type:

String

Cannot be used in themes.

Pass a layer name to this property.