MapOptions

Enables OSM copyright auto hide after 5 sec

[DEPRECATED] This option is no longer supported and will be removed in the next major release.

Map center in geographical coordinates ([longitude, latitude]).

Sets padding for controls layout

Where to add copyright control during the map initialization. By default it's "bottomRight".

Sets default background color, while style is loading

Prevents the map from dragging.

Prevents users from pitching the map.

Prevents users from rotating the map.

Disables map zoom on scrolling over the map container.

Tracks changes of the map container size and automatically updates the size of the map.

Whether a floor control should be added during the map initialization. By default it's false. Set to true to add the floor control at "topRight" position.

Prevents center changing while user is zooming or rotating the map by touch.

The key that allows usage of the API.

The desired map language. short language code 'en', 'ru', ...etc

The map will be constrained to the given bounds, if set.

Maximum map pitch in degrees.

Maximum map styleZoom.

Minimum map pitch in degrees.

Minimum map styleZoom.

Dimensions in pixels applied on each side of the viewport for shifting the vanishing point. the padding on each side has a clamp to a positive value no larger than the map canvas size for either side

Map pitch in degrees.

Sets preserveDrawingBuffer option to WebGLRenderingContext.

Map rotation in degrees.

Whether a scale control should be added during the map initialization. By default it's false. Set to true to add the scale control at "bottomLeft" position.

The map style ID, that you can get at https://styles.2gis.com

Map style options. Containts path to style assets - icons and fonts.

Map style global variables

Map style zoom. Use this option if you want to set the same zoom that is used in the style settings. The styleZoom and zoom options set the same map scale but in different projections. If both options are set, the styleZoom has a higher priority than the zoom option.

Map rotation threshold with multitouch in degrees. 10 by default.

Whether a traffic control should be added during the map initialization. By default it's false. Set to true to add the traffic control at "topRight" position.

Enables map to download additional plugin for RTL-text rendering. Values are:

• 'always-on' - plugin will be downloaded at map initialization.
• 'always-off - plugin will not be downloaded.
• 'depends-on-language' - plugin will be downloaded only if "ar" language is selected.

Default value is 'depends-on-language'. If the language of the map is not rtl (eg. 'en') and tiles contain rtl labels, you should use 'always-on' to render rtl label properly.

Sets the map WebGL version. It can be helpful if you use CustomLayer with other WebGL libraries.

Map zoom.

Whether a zoom control should be added during the map initialization. By default it's "topRight". Set to false to not add the control.