cadetill's blog | Copyright © Xavier Martínez (cadetill)

# Class TGMMapOptions

Description
Hierarchy
Fields
Methods
Properties

## Unit

GMLib.Map.Vcl

## Declaration

`type TGMMapOptions = class(TGMCustomMapOptions)`

## Description

Base class for `google.maps.MapOptions` object from Google Maps API.

{$IFDEF CEF4Delphi} {$ENDIF} {$IFDEF DELPHIALEXANDRIA} {$ENDIF}

This class implements `IGMControlChanges` interface. More information at google.maps.MapOptions interface

## Hierarchy

- TObject
- TPersistent
- TInterfacedPersistent
- TGMInterfacedOwnedPersistent
- TGMPersistent
- TGMPersistentStr
- TGMCustomMapOptions
- TGMMapOptions

## Overview

### Methods

| `constructor Create(AOwner: TPersistent); override;`
| `function PropToString: string; override;`
| `procedure Assign(Source: TPersistent); override;`

### Properties

| `property BackgroundColor: TColor read FBackgroundColor write SetBackgroundColor default clBlack;`
| `property Center;`
| `property ClickableIcons;`
| `property DisableDoubleClickZoom;`
| `property DraggableCursor;`
| `property DraggingCursor;`
| `property FullScreenControl;`
| `property FullScreenControlOptions;`
| `property GestureHandling;`
| `property Heading;`
| `property IsFractionalZoomEnabled;`
| `property KeyboardShortcuts;`
| `property MapTypeControl;`
| `property MapTypeControlOptions;`
| `property MapTypeId;`
| `property MaxZoom;`
| `property MinZoom;`
| `property NoClear;`
| `property Restriction;`
| `property RotateControl;`
| `property RotateControlOptions;`
| `property ScaleControl;`
| `property ScaleControlOptions;`
| `property StreetViewControl;`
| `property StreetViewControlOptions;`
| `property Tilt;`
| `property Zoom;`
| `property ZoomControl;`
| `property ZoomControlOptions;`

## Description

### Methods

| `constructor Create(AOwner: TPersistent); override;`
Class constructor. Creates a TGMCustomMapOptions object. ###### Parameters AOwner Owner of the object.

| `function PropToString: string; override;`
Converts all class properties values to a string separated by comma used to send values to a JavaScript function. ###### Returns string with all properties.

| `procedure Assign(Source: TPersistent); override;`
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.

### Properties

| `property BackgroundColor: TColor read FBackgroundColor write SetBackgroundColor default clBlack;`
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.

| `property Center;`
Contains the lat/lng coordinates with the center of the map.

| `property ClickableIcons;`
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.

| `property DisableDoubleClickZoom;`
Enables/disables zoom and center on double click. In order to take effect the change of this property, you must to restart the map.

| `property DraggableCursor;`
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.

| `property DraggingCursor;`
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.

| `property FullScreenControl;`
The enabled/disabled state of the Fullscreen control. In order to take effect the change of this property, you must to restart the map.

| `property FullScreenControlOptions;`
The display options for the Fullscreen control. More info at FullscreenControlOptions interface

| `property GestureHandling;`
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.

| `property Heading;`
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.

| `property IsFractionalZoomEnabled;`
Default: true for vector maps and false for raster maps.

| `property KeyboardShortcuts;`
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.

| `property MapTypeControl;`
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.

| `property MapTypeControlOptions;`
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

| `property MapTypeId;`
The initial Map mapTypeId.

| `property MaxZoom;`
The maximum zoom level which will be displayed on the map.

| `property MinZoom;`
The minimum zoom level which will be displayed on the map.

| `property NoClear;`
If `true`, do not clear the contents of the Map div.

| `property Restriction;`
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.

| `property RotateControl;`
The enabled/disabled state of the Rotate control.

| `property RotateControlOptions;`
The display options for the Rotate control. More info at RotateControlOptions interface

| `property ScaleControl;`
The initial enabled/disabled state of the Scale control.

| `property ScaleControlOptions;`
The initial display options for the Scale control. More info at ScaleControlOptions interface

| `property StreetViewControl;`
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).

| `property StreetViewControlOptions;`
The initial display options for the Street View Pegman control. More info at StreetViewControlOptions interface

| `property Tilt;`
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.

| `property Zoom;`
The enabled/disabled state of the Zoom control.

| `property ZoomControl;`
The initial Map zoom level.

| `property ZoomControlOptions;`
The display options for the Zoom control. More info at ZoomControlOptions interface

Generated by PasDoc 0.15.0.