React VectorMap - markerSettings

A marker is a point on a map accompanied by text that helps you flag places on the map. For example, you can use markers to designate cities on the map. The appearance of the markers is specified by the options of the markerSettings configuration object. If these options are defined on the first level of the markerSettings object, they are applied to all the markers at once. However, you can specify several of these options for certain markers exclusively. See the customize option description to learn how.

This option supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors

This option supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors

If you need for the color of a specific map marker to depend on the value of one of its attributes, assign the name of this attribute to the colorGroupingField option. The attribute must contain numeric values. After that, specify groups into which attribute values must be classified. For this purpose, assign an array to the colorGroups option. Each group in this array will be assigned a color from the palette.

If you have specified the field that provides marker-coloring data, you need to specify groups into which this data must be classified. For this purpose, assign an array of numbers to the colorGroups option. Each pair of numbers in this array defines a range of data values.

For example, consider that the colorGroups array contains four items: [0, 1, 2, 3]. This array specifies three ranges, or groups: 0-1, 1-2 and 2-3. Thus, data values will be split up into three groups. Each group will be assigned a color from the palette in order to paint the corresponding markers. Markers of those data values that do not match either group will be drawn in a default color.

The customize function should return the object that contains options to be changed for a certain area. These options are listed below.

• borderColor
• borderWidth
• color
• hoveredBorderColor
• hoveredBorderWidth
• hoveredColor
• selectedBorderColor
• selectedBorderWidth
• selectedColor
• isSelected
  Specifies if a marker is selected when the map is created. To select a marker at runtime, use the selected(state) method.
• text
  Specifies the text that accompanies a marker.

This option supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors

This option supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors

If this option is set to true, you can specify colors for the hovered marker and its border using the hoveredColor and hoveredBorderColor options, respectively.

A marker label is a text that accompanies a map marker. Usually, a marker label displays the name of a certain geographical point. To specify a text for a marker label, assign it to the text field of an object from the markers array when you provide data for markers.

When you use bubble markers on your map, their sizes depend on their values. The biggest value will be represented by the largest bubble. Similarly, the smallest value will be represented by the smallest bubble. Bubbles that represent values in between will have sizes proportional to the represented values. To specify the sizes of the largest and smallest bubbles, use the maxSize and minSize properties of the markerSettings object.

View Demo

When you use bubble markers on your map, their sizes depend on their values. The biggest value will be represented by the largest bubble. Similarly, the smallest value will be represented by the smallest bubble. Bubbles that represent values in between will have sizes proportional to the represented values. To specify the sizes of the largest and smallest bubbles, use the maxSize and minSize properties of the markerSettings object.

View Demo

If you define markers of the pie type on your map, use the palette option to colorize them. Assign a set of colors or the name of one of the predefined palettes to this option. The colors listed in the palette will be used to paint pie slices. If the number of slices is greater than the number of colors in a palette, the colors are repeated, but slightly modified.

This option supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors

This option supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors

Several options and methods are connected with the selection operation. To specify whether a single or multiple markers can be selected at a time, use the selectionMode option. To determine whether a certain marker is selected when the widget is created, use the isSelected field of the object returned by the customize callback function.

At runtime, you can do the following operations.

• Obtain the current selection state of a marker using its selected() method.

• Change the current selection state of a marker using its selected(state) method. Pass true or false to this method.

• Deselect all the selected markers using the clearMarkerSelection() method of the map instance.

The change of the selection state invokes the callback function assigned to the onMarkerSelectionChanged option. Within this function you can handle the selection event in the manner you require.

If you need for the size of a bubble marker to depend on the value of one of its attributes, assign the name of this attribute to the sizeGroupingField option. The attribute must contain numeric values. After that, specify groups into which attribute values must be classified. For this purpose, assign an array to the sizeGroups option.

If you have specified the field that provides marker-sizing data, you need to specify groups into which this data must be classified. For this purpose, assign an array of numbers to the sizeGroups option. Each pair of numbers in this array defines a range of data values.

For example, consider that the sizeGroups array contains four items: [0, 1, 2, 3]. This array specifies three ranges, or groups: 0-1, 1-2 and 2-3. Thus, data values will be split up into three groups. Each group will be assigned a size correlating with the group values. This size will be calculated automatically taking into account the minSize and maxSize values. Markers of those data values that does not match neither group will have a default size.

View Demo

VectorMap supports markers of the following types.

• dot
  Markers are represented by dots bordered with a white line.
• bubble
  Markers are represented by bubbles of different sizes. The size of a bubble depends on the value of the value field specified in the object of the markers array.
• pie
  Markers are represented by pie charts. To specify values for pie slices, assign an array to the values field specified in the object of the markers array.
• image
  Markers are represented by custom images. To specify an image for a marker, assign a URL of this image to the url field specified in the object of the markers array.

View Demo