Class TGMMapOptions

Class constructor.

Creates a TGMCustomMapOptions object.

Parameters

AOwner

Owner of the object.

Converts all class properties values to a string separated by comma used to send values to a JavaScript function.

Returns

string with all properties.

Call Assign to copy the properties or other attributes form an object to another.

The standard form of a call to Assign method is
     Destination.Assign(Source);
which tells the Destination object to copy the contents of the Source object to itself.

Parameters

Source

Object to copy the content.

Color used for the background of the Map div.

This color will be visible when tiles have not yet loaded as the user pans.

In order to take effect the change of this property, you must to restart the map.

Contains the lat/lng coordinates with the center of the map.

When false, map icons are not clickable.

A map icon represents a point of interest, also known as a POI. By default map icons are clickable.

Enables/disables zoom and center on double click.

In order to take effect the change of this property, you must to restart the map.

The name or url of the cursor to display when mousing over a draggable map.

This property uses the css cursor attribute to change the icon. As with the css property, you must specify at least one fallback cursor that is not a URL. For example: draggableCursor: 'url(http://www.example.com/icon.png), auto;'.

In order to take effect the change of this property, you must to restart the map.

The name or url of the cursor to display when the map is being dragged.

This property uses the css cursor attribute to change the icon. As with the css property, you must specify at least one fallback cursor that is not a URL. For example: draggingCursor: 'url(http://www.example.com/icon.png), auto;'.

In order to take effect the change of this property, you must to restart the map.

The enabled/disabled state of the Fullscreen control.

In order to take effect the change of this property, you must to restart the map.

The display options for the Fullscreen control.

More info at FullscreenControlOptions interface

This setting controls how the API handles gestures on the map.

Allowed values: "cooperative": Scroll events and one-finger touch gestures scroll the page, and do not zoom or pan the map. Two-finger touch gestures pan and zoom the map. Scroll events with a ctrl key or key pressed zoom the map. In this mode the map cooperates with the page. "greedy": All touch gestures and scroll events pan or zoom the map. "none": The map cannot be panned or zoomed by user gestures. "auto": (default) Gesture handling is either cooperative or greedy, depending on whether the page is scrollable or in an iframe.

The heading for aerial imagery in degrees measured clockwise from cardinal direction North.

Headings are snapped to the nearest available angle for which imagery is available.

In order to take effect the change of this property, you must to restart the map.

Default: true for vector maps and false for raster maps.

If false, prevents the map from being controlled by the keyboard.

In order to take effect the change of this property, you must to restart the map.

The initial enabled/disabled state of the Map type control.

In order to take effect the change of this property, you must to restart the map.

The initial display options for the Map type control.

In order to take effect the change of this property, you must to restart the map.

More info at MapTypeControlOptions interface

The initial Map mapTypeId.

The maximum zoom level which will be displayed on the map.

The minimum zoom level which will be displayed on the map.

If true, do not clear the contents of the Map div.

Defines a boundary that restricts the area of the map accessible to users.

When set, a user can only pan and zoom while the camera view stays inside the limits of the boundary.

The enabled/disabled state of the Rotate control.

The display options for the Rotate control.

More info at RotateControlOptions interface

The initial enabled/disabled state of the Scale control.

The initial display options for the Scale control.

More info at ScaleControlOptions interface

The initial enabled/disabled state of the Street View Pegman control.

This control is part of the default UI, and should be set to false when displaying a map type on which the Street View road overlay should not appear (e.g. a non-Earth map type).

The initial display options for the Street View Pegman control.

More info at StreetViewControlOptions interface

Controls the automatic switching behavior for the angle of incidence of the map.

The only allowed values are 0 and 45. The value 0 causes the map to always use a 0° overhead view regardless of the zoom level and viewport. The value 45 causes the tilt angle to automatically switch to 45 whenever 45° imagery is available for the current zoom level and viewport, and switch back to 0 whenever 45° imagery is not available (this is the default behavior). 45° imagery is only available for SATELLITE and HYBRID map types, within some locations, and at some zoom levels. Note: getTilt returns the current tilt angle, not the value specified by this option. Because getTilt and this option refer to different things, do not bind() the tilt property; doing so may yield unpredictable effects.

The enabled/disabled state of the Zoom control.

The initial Map zoom level.

The display options for the Zoom control.

More info at ZoomControlOptions interface