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

# Class TGMCustomMapOptions

Description
Hierarchy
Fields
Methods
Properties

## Unit

GMLib.Map

## Declaration

`type TGMCustomMapOptions = class(TGMPersistentStr, IGMControlChanges)`

## Description

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

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

## Hierarchy

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

## Overview

### Methods

| `constructor Create(AOwner: TPersistent); override;`
| `destructor Destroy; override;`
| `function PropToString: string; override;`
| `procedure Assign(Source: TPersistent); override;`
| `procedure PropertyChanged(Prop: TPersistent; PropName: string);`

### Properties

| `property APIUrl;`
| `property Center: TGMLatLng read FCenter write FCenter;`
| `property ClickableIcons: Boolean read FClickableIcons write SetClickableIcons;`
| `property DisableDoubleClickZoom: Boolean read FDisableDoubleClickZoom write SetDisableDoubleClickZoom default True;`
| `property DraggableCursor: string read FDraggableCursor write SetDraggableCursor;`
| `property DraggingCursor: string read FDraggingCursor write SetDraggingCursor;`
| `property FullScreenControl: Boolean read FFullScreenControl write SetFullScreenControl default True;`
| `property FullScreenControlOptions: TGMFullScreenControlOptions read FFullScreenControlOptions write FFullScreenControlOptions;`
| `property GestureHandling: TGMGestureHandling read FGestureHandling write SetGestureHandling;`
| `property Heading: Integer read FHeading write SetHeading default 0;`
| `property IsFractionalZoomEnabled: Boolean read FIsFractionalZoomEnabled write SetIsFractionalZoomEnabled;`
| `property KeyboardShortcuts: Boolean read FKeyboardShortcuts write SetKeyboardShortcuts default True;`
| `property MapTypeControl: Boolean read FMapTypeControl write SetMapTypeControl default True;`
| `property MapTypeControlOptions: TGMMapTypeControlOptions read FMapTypeControlOptions write FMapTypeControlOptions;`
| `property MapTypeId: TGMMapTypeId read FMapTypeId write SetMapTypeId default mtROADMAP;`
| `property MaxZoom: Integer read FMaxZoom write SetMaxZoom default 0;`
| `property MinZoom: Integer read FMinZoom write SetMinZoom default 0;`
| `property NoClear: Boolean read FNoClear write SetNoClear default False;`
| `property Restriction: TGMRestriction read FRestriction write FRestriction;`
| `property RotateControl: Boolean read FRotateControl write SetRotateControl default True;`
| `property RotateControlOptions: TGMRotateControlOptions read FRotateControlOptions write FRotateControlOptions;`
| `property ScaleControl: Boolean read FScaleControl write SetScaleControl default True;`
| `property ScaleControlOptions: TGMScaleControlOptions read FScaleControlOptions write FScaleControlOptions;`
| `property StreetViewControl: Boolean read FStreetViewControl write SetStreetViewControl default True;`
| `property StreetViewControlOptions: TGMStreetViewControlOptions read FStreetViewControlOptions write FStreetViewControlOptions;`
| `property Tilt: Integer read FTilt write SetTilt default 0;`
| `property Zoom: Integer read FZoom write SetZoom default 8;`
| `property ZoomControl: Boolean read FZoomControl write SetZoomControl default True;`
| `property ZoomControlOptions: TGMZoomControlOptions read FZoomControlOptions write FZoomControlOptions;`

## Description

### Methods

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

| `destructor Destroy; override;`
Destructor class.

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

| `procedure PropertyChanged(Prop: TPersistent; PropName: string);`
Method to call into the owner object when changes a property into the current object. ###### Parameters Prop Object property that has changed. PropName Name of the property that has changed.

### Properties

| `property APIUrl;`
URL to Google Maps API page.

| `property Center: TGMLatLng read FCenter write FCenter;`
Contains the lat/lng coordinates with the center of the map.

| `property ClickableIcons: Boolean read FClickableIcons write SetClickableIcons;`
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: Boolean read FDisableDoubleClickZoom write SetDisableDoubleClickZoom default True;`
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: string read FDraggableCursor write SetDraggableCursor;`
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: string read FDraggingCursor write SetDraggingCursor;`
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: Boolean read FFullScreenControl write SetFullScreenControl default True;`
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: TGMFullScreenControlOptions read FFullScreenControlOptions write FFullScreenControlOptions;`
The display options for the Fullscreen control. More info at FullscreenControlOptions interface

| `property GestureHandling: TGMGestureHandling read FGestureHandling write SetGestureHandling;`
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: Integer read FHeading write SetHeading default 0;`
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: Boolean read FIsFractionalZoomEnabled write SetIsFractionalZoomEnabled;`
Default: true for vector maps and false for raster maps.

| `property KeyboardShortcuts: Boolean read FKeyboardShortcuts write SetKeyboardShortcuts default True;`
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: Boolean read FMapTypeControl write SetMapTypeControl default True;`
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: TGMMapTypeControlOptions read FMapTypeControlOptions write FMapTypeControlOptions;`
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: TGMMapTypeId read FMapTypeId write SetMapTypeId default mtROADMAP;`
The initial Map mapTypeId.

| `property MaxZoom: Integer read FMaxZoom write SetMaxZoom default 0;`
The maximum zoom level which will be displayed on the map.

| `property MinZoom: Integer read FMinZoom write SetMinZoom default 0;`
The minimum zoom level which will be displayed on the map.

| `property NoClear: Boolean read FNoClear write SetNoClear default False;`
If `true`, do not clear the contents of the Map div.

| `property Restriction: TGMRestriction read FRestriction write FRestriction;`
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: Boolean read FRotateControl write SetRotateControl default True;`
The enabled/disabled state of the Rotate control.

| `property RotateControlOptions: TGMRotateControlOptions read FRotateControlOptions write FRotateControlOptions;`
The display options for the Rotate control. More info at RotateControlOptions interface

| `property ScaleControl: Boolean read FScaleControl write SetScaleControl default True;`
The initial enabled/disabled state of the Scale control.

| `property ScaleControlOptions: TGMScaleControlOptions read FScaleControlOptions write FScaleControlOptions;`
The initial display options for the Scale control. More info at ScaleControlOptions interface

| `property StreetViewControl: Boolean read FStreetViewControl write SetStreetViewControl default True;`
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: TGMStreetViewControlOptions read FStreetViewControlOptions write FStreetViewControlOptions;`
The initial display options for the Street View Pegman control. More info at StreetViewControlOptions interface

| `property Tilt: Integer read FTilt write SetTilt default 0;`
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: Integer read FZoom write SetZoom default 8;`
The enabled/disabled state of the Zoom control.

| `property ZoomControl: Boolean read FZoomControl write SetZoomControl default True;`
The initial Map zoom level.

| `property ZoomControlOptions: TGMZoomControlOptions read FZoomControlOptions write FZoomControlOptions;`
The display options for the Zoom control. More info at ZoomControlOptions interface

Generated by PasDoc 0.15.0.