MarkerLabelOptions | MapGL | 2GIS Documentation
MapGL JS API

MarkerLabelOptions

Options for the label of marker.

Properties
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.

Text color in hexadecimal RGB (#ff0000) or RGBA (#ff0000ff) format.

undefinednumber

Text size.

Background color of letters (when haloRadius is specified). The same format as for color.

undefinednumber

Use haloRadius to add background behind each letter.

Background image for the label.

undefinednumber

Space between each letter.

undefinednumber

For multiline label lineHeight specify how far lines between each other.

undefinednumber

Maximum display styleZoom of the label. Note that the label's zoom-dependent visibility is constrained by the marker's minZoom and maxZoom options, if specified.

undefinednumber

Minimum display styleZoom of the label. Note that the label's zoom-dependent visibility is constrained by the marker's minZoom and maxZoom options, if specified.

number[]

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

number[]

Coordinates (from 0 to 1 in each dimension) 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.

string

Label's text.

undefinednumber

Draw order.