ClusterStyle | MapGL | 2GIS Documentation

ClusterStyle

An object describing a cluster style.

Properties
number[]

The position of the "tip" of the icon (relative to its top left corner). The icon will be aligned so that this point is at the cluster's geographical location. Centered by default if anchor is not specified and custom icon is provided.

number[]

Cluster icon anchor in hovered state.

undefinedstring

Cluster icon URL in hovered state.

number[]

Cluster icon size [width, height] in hovered state in pixels.

undefinedstring

Cluster icon URL.

number[]

The offset distance of text box from its relativeAnchor. Positive values indicate left and up, while negative values indicate right and down.

DEPRECATED! Will be removed in the next major release, use the offset option instead.

undefinedstring

Label's text color of a cluster in CSS hexadecimal RGB format (e.g. #ff0000).

undefinednumber

Label's text font size of a cluster.

undefinedstring

Label's text background color of a cluster in CSS hexadecimal RGB format (e.g. #ff0000).

undefinednumber

Label's text background radius of a cluster. The background is set for each letter of the text.

undefinednumber

Label's text letter spacing of a cluster.

number[]

The offset distance of text box from its relativeAnchor. Positive values indicate right and down, while negative values indicate left and up.

number[]

The relative, from 0 to 1 in each dimension, coordinates of the text box "tip". relative to its top left corner, for example: [0, 0] value is the top left corner, [0.5, 0.5] — center point, and [1, 1] is the bottom right corner of the box. The label will be placed so that this point is at geographical coordinates respects the absolute offset.

undefinedstring

Label's text of a cluster. By default, it's the size of the cluster.

number[]

Cluster icon size [width, height] in pixels.