### dragstart Source: https://developers.google.com/maps/documentation/javascript/reference/marker Fired when the user starts dragging the Marker. ```APIDOC ## dragstart ### Description This event is fired when the user starts dragging the `Marker`. ### Method `function(event)` ### Arguments * `event`: `MapMouseEvent optional` - An object containing information about the event. ``` -------------------------------- ### dragstart Source: https://developers.google.com/maps/documentation/javascript/reference/map This event is fired when the user starts dragging the map. ```APIDOC ## dragstart ### Description This event is fired when the user starts dragging the map. ### Method `function()` ### Arguments None ``` -------------------------------- ### Display Place Search Results Source: https://developers.google.com/maps/documentation/javascript/reference/places-widget This example shows how to set up a Place Search Element to display results from a text search query. It includes specifying the search request and content configuration. ```html ``` -------------------------------- ### DefaultMarkerSetupOptions Interface (Deprecated) Source: https://developers.google.com/maps/documentation/javascript/reference/journey-sharing-ui-customization DefaultMarkerSetupOptions interface for deprecated marker setup. ```APIDOC ## DefaultMarkerSetupOptions interface `google.maps.journeySharing.DefaultMarkerSetupOptions` interface **Deprecated:** Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. MarkerSetup default options. ### Properties --- `defaultMarkerOptions` | **Type:** `MarkerOptions` Default marker options. ``` -------------------------------- ### MarkerSetupOptions Interface (Deprecated) Source: https://developers.google.com/maps/documentation/javascript/reference/journey-sharing-ui-customization MarkerSetupOptions interface for deprecated marker setup. ```APIDOC ## MarkerSetupOptions interface `google.maps.journeySharing.MarkerSetupOptions` interface **Deprecated:** Marker setup is deprecated. Use the `MarkerCustomizationFunction` methods for your location provider instead. MarkerSetup options. ### Properties --- `markerOptions` optional | **Type:** `MarkerOptions optional` Marker options. ``` -------------------------------- ### PlaceDetailsElement Usage Example Source: https://developers.google.com/maps/documentation/javascript/reference/places-widget Demonstrates how to use the PlaceDetailsElement in HTML, including specifying the place to display and configuring the content. ```APIDOC ## PlaceDetailsElement Usage Example ### HTML Structure ```html ``` ### JavaScript Initialization ```javascript const {PlaceDetailsElement} = await google.maps.importLibrary("places"); ``` ``` -------------------------------- ### Get KmlLayer Status Source: https://developers.google.com/maps/documentation/javascript/reference/kml Get the status of the KML Layer after it has loaded. The status indicates whether the layer loaded successfully or if there were errors. ```javascript const status = kmlLayer.getStatus(); ``` -------------------------------- ### Basic PlaceDetailsElement Usage Source: https://developers.google.com/maps/documentation/javascript/reference/places-widget This example shows how to use the PlaceDetailsElement to display place details. You can append child elements like PlaceDetailsPlaceRequestElement and PlaceContentConfigElement to configure the displayed information. ```html ``` -------------------------------- ### MVCObject get Method Source: https://developers.google.com/maps/documentation/javascript/reference/event Retrieve the value of a property from an MVCObject. This is often used to get values that have been set using the 'set' method. ```javascript const value = mvcoObject.get('propertyName'); ``` -------------------------------- ### Create a GroundOverlay Source: https://developers.google.com/maps/documentation/javascript/reference/image-overlay Instantiate a `GroundOverlay` object with a URL for the image and its geographical bounds. The image will be scaled to fit the bounds. ```javascript const groundOverlay = new GroundOverlay(url, bounds[, opts]); ``` -------------------------------- ### Get KmlLayer Default Viewport Source: https://developers.google.com/maps/documentation/javascript/reference/kml Get the default viewport for the KML Layer, which is the bounding box of the layer's content. This is useful for automatically centering the map on the KML data. ```javascript const bounds = kmlLayer.getDefaultViewport(); ``` -------------------------------- ### Get Elevation Along Path Source: https://developers.google.com/maps/documentation/javascript/reference/elevation Make an elevation request along a path to get elevation data sampled at equidistant points. The number of samples must be between 2 and 512. ```javascript getElevationAlongPath(request[, callback]) ``` -------------------------------- ### InfoWindow Constructor Source: https://developers.google.com/maps/documentation/javascript/reference/info-window Creates an InfoWindow instance with the given options. The InfoWindow can be placed on a map at a particular position or above a marker. After construction, you must call `open()` to display it. The user or developer can call `close()` to remove it. ```APIDOC ### Constructor --- `InfoWindow` | `InfoWindow([opts])` **Parameters:** * `opts`: `InfoWindowOptions optional` - Options for the InfoWindow. ``` -------------------------------- ### GroundOverlay Constructor and Methods Source: https://developers.google.com/maps/documentation/javascript/reference/image-overlay Details on creating a GroundOverlay and managing its properties like bounds, map, opacity, and URL. ```APIDOC ## GroundOverlay Constructor ### Description Creates a ground overlay from the provided image URL and its LatLngBounds. ### Method POST ### Endpoint /GroundOverlay ### Parameters #### Request Body - **url** (string) - The URL of the image to display. - **bounds** (LatLngBounds|LatLngBoundsLiteral optional) - The geographical bounds for the overlay. - **opts** (GroundOverlayOptions optional) - Additional options for the overlay. ### Request Example { "url": "https://example.com/image.png", "bounds": { "north": 34.0, "south": 33.0, "east": -118.0, "west": -119.0 } } ``` ```APIDOC ## getBounds ### Description Gets the LatLngBounds of this ground overlay. ### Method GET ### Endpoint /GroundOverlay/getBounds ### Parameters None ### Response #### Success Response (200) - **bounds** (LatLngBounds|null) - The geographical bounds of the overlay. ### Response Example { "bounds": { "north": 34.0, "south": 33.0, "east": -118.0, "west": -119.0 } } ``` ```APIDOC ## getMap ### Description Returns the map on which this ground overlay is displayed. ### Method GET ### Endpoint /GroundOverlay/getMap ### Parameters None ### Response #### Success Response (200) - **map** (Map|null) - The map object or null if not displayed. ### Response Example { "map": "MapObjectReference" } ``` ```APIDOC ## getOpacity ### Description Returns the opacity of this ground overlay. ### Method GET ### Endpoint /GroundOverlay/getOpacity ### Parameters None ### Response #### Success Response (200) - **opacity** (number) - The opacity level (0.0 to 1.0). ### Response Example { "opacity": 0.7 } ``` ```APIDOC ## getUrl ### Description Gets the URL of the projected image for this ground overlay. ### Method GET ### Endpoint /GroundOverlay/getUrl ### Parameters None ### Response #### Success Response (200) - **url** (string) - The image URL. ### Response Example { "url": "https://example.com/image.png" } ``` ```APIDOC ## setMap ### Description Renders the ground overlay on the specified map. If map is set to null, the overlay is removed. ### Method POST ### Endpoint /GroundOverlay/setMap ### Parameters #### Request Body - **map** (Map optional) - The map object to display the overlay on, or null to remove it. ### Response #### Success Response (200) None ``` ```APIDOC ## setOpacity ### Description Sets the opacity of this ground overlay. ### Method POST ### Endpoint /GroundOverlay/setOpacity ### Parameters #### Request Body - **opacity** (number) - The new opacity level (0.0 to 1.0). ### Response #### Success Response (200) None ``` -------------------------------- ### getRadius Source: https://developers.google.com/maps/documentation/javascript/reference/polygon Gets the radius of the circle in meters. ```APIDOC ## getRadius ### Description Returns the radius of this circle (in meters). ### Method `getRadius()` ### Parameters None ### Return Value `number` ``` -------------------------------- ### dragstart Event Source: https://developers.google.com/maps/documentation/javascript/reference/polygon Fired when the user begins dragging the circle. ```APIDOC ## dragstart Event ### Description This event is fired when the user starts dragging the circle. ### Arguments - **event** (MapMouseEvent optional) - The event object. ``` -------------------------------- ### getRenderingType Source: https://developers.google.com/maps/documentation/javascript/reference/map Gets the current rendering type of the map. ```APIDOC ## getRenderingType ### Description Returns the current `RenderingType` of the map. ### Method `getRenderingType()` ### Parameters None ### Return Value `RenderingType` ``` -------------------------------- ### Import EVChargeAmenitySummary Class Source: https://developers.google.com/maps/documentation/javascript/reference/place Import the EVChargeAmenitySummary class from the places library. This class provides AI-generated summaries of amenities near EV charging stations. ```javascript const {EVChargeAmenitySummary} = await google.maps.importLibrary("places"); ``` -------------------------------- ### getTilt Source: https://developers.google.com/maps/documentation/javascript/reference/map Gets the current angle of incidence of the map in degrees. ```APIDOC ## getTilt ### Description Returns the current angle of incidence of the map, in degrees from the viewport plane to the map plane. For raster maps, the result will be `0` for imagery taken directly overhead or `45` for 45° imagery. This method does not return the value set by `setTilt`. See `setTilt` for details. ### Method `getTilt()` ### Parameters None ### Return Value `number|undefined` ``` -------------------------------- ### Import EVChargeOptions Class Source: https://developers.google.com/maps/documentation/javascript/reference/place Import the EVChargeOptions class from the places library. This is necessary to work with EV charging station data. ```javascript const {EVChargeOptions} = await google.maps.importLibrary("places"); ``` -------------------------------- ### getZoom() Source: https://developers.google.com/maps/documentation/javascript/reference/street-view Gets the current zoom level of the Street View panorama. ```APIDOC ## getZoom() ### Description Returns the zoom level of the panorama. Fully zoomed-out is level 0, where the field of view is 180 degrees. Zooming in increases the zoom level. ### Method `getZoom()` ### Parameters None ### Return Value `number` - The current zoom level. ``` -------------------------------- ### LatLngBounds Constructor and Constants Source: https://developers.google.com/maps/documentation/javascript/reference/coordinates Documentation for the LatLngBounds constructor and its constants. ```APIDOC ## `LatLngBounds` Class ### Description Represents a rectangle in geographical coordinates. ### Constructor `LatLngBounds(swOrLatLngBounds?: LatLng|LatLngLiteral|LatLngBounds|LatLngBoundsLiteral, ne?: LatLng|LatLngLiteral)` ### Parameters * `swOrLatLngBounds`: `LatLng|LatLngLiteral|LatLngBounds|LatLngBoundsLiteral optional` - The south-west corner or an existing LatLngBounds object/literal. * `ne`: `LatLng|LatLngLiteral optional` - The north-east corner. ### Constants * `MAX_BOUNDS`: `LatLngBounds` - Represents the maximum bounds encompassing the entire globe. ``` -------------------------------- ### getLocation() Source: https://developers.google.com/maps/documentation/javascript/reference/street-view Gets the geographical location of the current Street View panorama. ```APIDOC ## getLocation() ### Description Returns the `StreetViewLocation` of the current panorama. ### Method `getLocation()` ### Parameters None ### Return Value `StreetViewLocation` - The location of the current panorama. ``` -------------------------------- ### Import StreetViewService Source: https://developers.google.com/maps/documentation/javascript/reference/street-view-service Import the `StreetViewService` class from the streetView library. This is required before you can instantiate the service. ```javascript const {StreetViewService} = await google.maps.importLibrary("streetView"); ``` -------------------------------- ### MVCArray getLength Method Source: https://developers.google.com/maps/documentation/javascript/reference/event Get the current number of elements in the MVCArray. ```javascript const length = mvcArray.getLength(); ``` -------------------------------- ### Import FleetEngineTripLocationProvider Source: https://developers.google.com/maps/documentation/javascript/reference/journey-sharing-trip-and-order-progress Import the FleetEngineTripLocationProvider class from the journeySharing library. This is required before instantiating the provider. ```javascript const {FleetEngineTripLocationProvider} = await google.maps.importLibrary("journeySharing"); ``` -------------------------------- ### setOptions() Source: https://developers.google.com/maps/documentation/javascript/reference/street-view Sets multiple options for the Street View panorama at once. ```APIDOC ## setOptions(options) ### Description Sets a collection of key-value pairs. ### Method `setOptions(options)` ### Parameters * `options`: `StreetViewPanoramaOptions optional` - An object containing key-value pairs to set as options. ### Return Value None ``` -------------------------------- ### PlaceOptions Interface Source: https://developers.google.com/maps/documentation/javascript/reference Options for configuring a Place request. ```APIDOC ## PlaceOptions Interface ### Description Defines properties that can be used to configure a Place request. ### Properties - `id` (string) - `requestedLanguage` (string) - `requestedRegion` (string) - `resourceName` (string) ``` -------------------------------- ### Import ReviewSummary class Source: https://developers.google.com/maps/documentation/javascript/reference/place Import the ReviewSummary class from the places library. This class provides an AI-generated summary of user reviews for a place. ```javascript const {ReviewSummary} = await google.maps.importLibrary("places"); ``` -------------------------------- ### StyledMapType Methods Source: https://developers.google.com/maps/documentation/javascript/reference/image-overlay Methods for interacting with the StyledMapType, such as getting and releasing map tiles. ```APIDOC ## StyledMapType Methods ### getTile #### Description Retrieves a tile for the given coordinates and zoom level. #### Parameters - **tileCoord**: `Point optional` - The tile coordinates. - **zoom**: `number` - The zoom level of the tile. - **ownerDocument**: `Document optional` - The document that owns the tile. #### Return Value - `Element|null`: The resulting tile element, or null if no tile is available. ``` ```APIDOC ## StyledMapType Methods ### releaseTile #### Description Releases a tile that is no longer needed. #### Parameters - **tile**: `Element optional` - The tile element to release. #### Return Value - None ``` -------------------------------- ### Configure Place Review Summary Display Source: https://developers.google.com/maps/documentation/javascript/reference/place-widget-child-elements Use `gmp-place-review-summary` as a child of `PlaceDetailsElement` (or `PlaceContentConfigElement`) to display a place's review summary. Import `PlaceReviewSummaryElement` for programmatic use. ```html ``` ```html ``` ```javascript const {PlaceReviewSummaryElement} = await google.maps.importLibrary("places"); ``` -------------------------------- ### Get GroundOverlay URL Source: https://developers.google.com/maps/documentation/javascript/reference/image-overlay Retrieve the URL of the image used for the ground overlay. ```javascript const url = groundOverlay.getUrl(); ``` -------------------------------- ### Importing MapElement Source: https://developers.google.com/maps/documentation/javascript/reference/map Demonstrates how to import the MapElement class from the maps library. ```APIDOC ```javascript const {MapElement} = await google.maps.importLibrary("maps"); ``` ``` -------------------------------- ### TimeWindow Interface Source: https://developers.google.com/maps/documentation/javascript/reference/journey-sharing-fleet-engine-entities Interface representing a time range with a start and end time. ```APIDOC ## TimeWindow interface `google.maps.journeySharing.TimeWindow` interface A time range. ### Properties --- `endTime` | **Type:** `Date` The end time of the time window (inclusive). `startTime` | **Type:** `Date` The start time of the time window (inclusive). ``` -------------------------------- ### Get Polyline Visibility Source: https://developers.google.com/maps/documentation/javascript/reference/polygon Check if the polyline is currently visible on the map. Returns a boolean value. ```javascript const isVisible = polyline.getVisible(); ``` -------------------------------- ### Place Class Constructor Source: https://developers.google.com/maps/documentation/javascript/reference/place Initializes a new Place object. The constructor takes an options object of type PlaceOptions. ```APIDOC ## Place class `google.maps.places.Place` class implements `PlaceOptions` library "places" ```javascript const {Place} = await google.maps.importLibrary("places"); ``` ### Constructor --- `Place` | `Place(options)` **Parameters:** * `options`: `PlaceOptions` ``` -------------------------------- ### Get Polyline Path Source: https://developers.google.com/maps/documentation/javascript/reference/polygon Retrieve the path of the polyline. The returned value is an MVCArray of LatLng objects. ```javascript const path = polyline.getPath(); ``` -------------------------------- ### Configure Place Price Display Source: https://developers.google.com/maps/documentation/javascript/reference/place-widget-child-elements Append `gmp-place-price` to `gmp-place-content-config` to show a place's price level or range. Import `PlacePriceElement` for programmatic use. ```html ``` ```html ``` ```javascript const {PlacePriceElement} = await google.maps.importLibrary("places"); ``` -------------------------------- ### Import ComputeRoutesExtraComputation Constants Source: https://developers.google.com/maps/documentation/javascript/reference/route Import the ComputeRoutesExtraComputation constants from the routes library. These are used to specify extra computations for route requests. ```javascript const {ComputeRoutesExtraComputation} = await google.maps.importLibrary("routes"); ``` -------------------------------- ### getPhotographerPov() Source: https://developers.google.com/maps/documentation/javascript/reference/street-view Gets the photographer's point of view (heading and pitch) at the time the panorama was captured. ```APIDOC ## getPhotographerPov() ### Description Returns the heading and pitch of the photographer when this panorama was taken. For Street View panoramas on the road, this also reveals in which direction the car was travelling. This data is available after the `pano_changed` event. ### Method `getPhotographerPov()` ### Parameters None ### Return Value `StreetViewPov` - An object containing the heading and pitch. ``` -------------------------------- ### Data.LinearRing Constructor and Methods Source: https://developers.google.com/maps/documentation/javascript/reference/data Documentation for the Data.LinearRing constructor and its methods, including iteration over LatLngs, retrieval, and type identification. ```APIDOC ## Data.LinearRing class ### Constructor `Data.LinearRing(elements)` Constructs a `Data.LinearRing` from the given `LatLng`s or `LatLngLiteral`s. **Parameters:** * `elements`: `Array` ### Methods #### `forEachLatLng(callback)` Iterates over the contained `LatLng`s. **Parameters:** * `callback`: `function(LatLng): void` **Return Value:** None #### `getArray()` Returns an array of the contained `LatLng`s. **Return Value:** `Array` #### `getAt(n)` Returns the `n`-th contained `LatLng`. **Parameters:** * `n`: `number` **Return Value:** `LatLng` #### `getLength()` Returns the number of contained `LatLng`s. **Return Value:** `number` #### `getType()` Returns the string "LinearRing". **Return Value:** `string` ``` -------------------------------- ### Get KmlLayer URL Source: https://developers.google.com/maps/documentation/javascript/reference/kml Retrieve the URL of the KML file currently being displayed by the KML Layer. ```javascript const url = kmlLayer.getUrl(); ``` -------------------------------- ### Get GroundOverlay Bounds Source: https://developers.google.com/maps/documentation/javascript/reference/image-overlay Retrieve the geographical bounds of the ground overlay. This returns a `LatLngBounds` object. ```javascript const bounds = groundOverlay.getBounds(); ``` -------------------------------- ### Import FleetEngineDeliveryVehicleLocationProvider Source: https://developers.google.com/maps/documentation/javascript/reference/journey-sharing-fleet-tracking Import the `FleetEngineDeliveryVehicleLocationProvider` class from the `journeySharing` library. This is required before instantiating the provider. ```javascript const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing"); ``` -------------------------------- ### PriceRange Class Source: https://developers.google.com/maps/documentation/javascript/reference/place Represents the price range associated with a Place, including start and end prices. ```APIDOC ## PriceRange class `google.maps.places.PriceRange` class library "places" The price range associated with a Place. `endPrice` could be unset, which indicates a range without upper bound (e.g. "More than $100"). ```javascript const {PriceRange} = await google.maps.importLibrary("places"); ``` ### Properties --- `endPrice` readonly | **Type:** `Money optional` The upper end of the price range (inclusive). Price should be lower than this amount. `startPrice` readonly | **Type:** `Money` The low end of the price range (inclusive). Price should be at or above this amount. ### Methods --- **Inherited:** `toJSON` ``` -------------------------------- ### PlaceAutocompleteElement Constructor Source: https://developers.google.com/maps/documentation/javascript/reference/places-widget Initializes a new instance of the PlaceAutocompleteElement with specified options. ```APIDOC ## Constructor PlaceAutocompleteElement ### Description Initializes a new instance of the `PlaceAutocompleteElement`. ### Method `PlaceAutocompleteElement(options)` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters * `options`: `PlaceAutocompleteElementOptions` - An object containing configuration options for the autocomplete element. ``` -------------------------------- ### Get Polyline Editable State Source: https://developers.google.com/maps/documentation/javascript/reference/polygon Determine if the polyline is currently in an editable state. Returns a boolean value. ```javascript const isEditable = polyline.getEditable(); ``` -------------------------------- ### Import ContentBlock Class Source: https://developers.google.com/maps/documentation/javascript/reference/place Import the ContentBlock class from the places library. Use this to describe content summaries and their origins. ```javascript const {ContentBlock} = await google.maps.importLibrary("places"); ``` -------------------------------- ### Get Polyline Draggable State Source: https://developers.google.com/maps/documentation/javascript/reference/polygon Check if the polyline is currently draggable by the user. Returns a boolean value. ```javascript const isDraggable = polyline.getDraggable(); ``` -------------------------------- ### Map Initialization Options Source: https://developers.google.com/maps/documentation/javascript/reference/map These options can be set when initializing the map. ```APIDOC ## Map Options ### Description Configuration options for the Google Map. ### Properties #### `backgroundColor` - **Type:** `string optional` - **Description:** Color used for the background of the Map div. This color will be visible when tiles have not yet loaded as the user pans. This option can only be set when the map is initialized. #### `cameraControl` - **Type:** `boolean optional` - **Description:** The enabled/disabled state of the Camera control. #### `cameraControlOptions` - **Type:** `CameraControlOptions optional` - **Description:** The display options for the Camera control. #### `center` - **Type:** `LatLng|LatLngLiteral optional` - **Description:** The initial Map center. #### `clickableIcons` - **Type:** `boolean optional` - **Default:** `true` - **Description:** When `false`, map icons are not clickable. A map icon represents a point of interest, also known as a POI. #### `colorScheme` - **Type:** `ColorScheme|string optional` - **Default:** `ColorScheme.LIGHT` - **Description:** The initial Map color scheme. This option can only be set when the map is initialized. #### `controlSize` - **Type:** `number optional` - **Description:** Size in pixels of the controls appearing on the map. This value must be supplied directly when creating the Map, updating this value later may bring the controls into an `undefined` state. Only governs the controls made by the Maps API itself. Does not scale developer created custom controls. #### `disableDefaultUI` - **Type:** `boolean optional` - **Description:** Enables/disables all default UI buttons. May be overridden individually. Does not disable the keyboard controls, which are separately controlled by the `MapOptions.keyboardShortcuts` option. Does not disable gesture controls, which are separately controlled by the `MapOptions.gestureHandling` option. #### `disableDoubleClickZoom` - **Type:** `boolean optional` - **Description:** Enables/disables zoom and center on double click. Enabled by default. **Note** : This property is **not recommended**. To disable zooming on double click, you can use the `gestureHandling` property, and set it to `"none"`. #### `draggable` - **Type:** `boolean optional` - **Deprecated:** Deprecated in 2017. To disable dragging on the map, you can use the `gestureHandling` property, and set it to `"none"`. - **Description:** If `false`, prevents the map from being dragged and zoomed by mouse and touch gestures. Dragging is enabled by default. #### `draggableCursor` - **Type:** `string optional` - **Description:** 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;'`. #### `draggingCursor` - **Type:** `string optional` - **Description:** 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;'`. #### `fullscreenControl` - **Type:** `boolean optional` - **Description:** The enabled/disabled state of the Fullscreen control. #### `fullscreenControlOptions` - **Type:** `FullscreenControlOptions optional` - **Description:** The display options for the Fullscreen control. #### `gestureHandling` - **Type:** `string optional` - **Description:** 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. #### `heading` - **Type:** `number optional` - **Description:** 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. #### `headingInteractionEnabled` - **Type:** `boolean optional` - **Default:** `false` - **Description:** Whether the map should allow user control of the camera heading (rotation). This option is only in effect when the map is a vector map. If not set in code, then the cloud configuration for the map ID will be used (if available). #### `internalUsageAttributionIds` ``` -------------------------------- ### getPov() Source: https://developers.google.com/maps/documentation/javascript/reference/street-view Gets the current point of view (heading, pitch, and zoom) within the Street View panorama. ```APIDOC ## getPov() ### Description Returns the current point of view for the Street View panorama. ### Method `getPov()` ### Parameters None ### Return Value `StreetViewPov` - An object containing the current point of view (heading, pitch, zoom). ``` -------------------------------- ### KmlLayer Methods Source: https://developers.google.com/maps/documentation/javascript/reference/kml Methods available on the KmlLayer class for interacting with the layer, such as getting its properties or updating its state. ```APIDOC ## KmlLayer Methods ### `getDefaultViewport()` **Description:** Get the default viewport for the layer being displayed. **Return Value:** `LatLngBounds|null` ### `getMap()` **Description:** Get the map on which the KML Layer is being rendered. **Return Value:** `Map|null` ### `getMetadata()` **Description:** Get the metadata associated with this layer, as specified in the layer markup. **Return Value:** `KmlLayerMetadata|null` ### `getStatus()` **Description:** Get the status of the layer, set once the requested document has loaded. **Return Value:** `KmlLayerStatus|null` ### `getUrl()` **Description:** Gets the URL of the KML file being displayed. **Return Value:** `string` ### `getZIndex()` **Description:** Gets the z-index of the KML Layer. **Return Value:** `number` ### `setMap(map)` **Description:** Renders the KML Layer on the specified map. If map is set to `null`, the layer is removed. **Parameters:** * `map` (Map optional) - The map to render the layer on. ### `setOptions(options)` **Description:** Sets the options for the KML layer. **Parameters:** * `options` (KmlLayerOptions optional) - The options to set. ### `setUrl(url)` **Description:** Sets the URL of the KML file to display. **Parameters:** * `url` (string) - The URL of the KML file. ### `setZIndex(zIndex)` **Description:** Sets the z-index of the KML Layer. **Parameters:** * `zIndex` (number) - The z-index to set. ``` -------------------------------- ### Place Class Methods Source: https://developers.google.com/maps/documentation/javascript/reference Instance methods available on a Place object. ```APIDOC ## Place Class Instance Methods ### Description Methods that can be called on a Place instance. ### Methods - `fetchFields(request: FetchFieldsRequest): Promise ` - `toJSON(): object` (Inherited) ``` -------------------------------- ### Import OpeningHours Class Source: https://developers.google.com/maps/documentation/javascript/reference/place Import the OpeningHours class from the 'places' library. This class provides information about business hours of a Place. ```javascript const {OpeningHours} = await google.maps.importLibrary("places"); ``` -------------------------------- ### Get KmlLayer ZIndex Source: https://developers.google.com/maps/documentation/javascript/reference/kml Retrieve the current z-index of the KML Layer, which determines its stacking order on the map. ```javascript const zIndex = kmlLayer.getZIndex(); ``` -------------------------------- ### Get GroundOverlay Opacity Source: https://developers.google.com/maps/documentation/javascript/reference/image-overlay Retrieve the current opacity of the ground overlay. The value is a float between 0 and 1.0. ```javascript const opacity = groundOverlay.getOpacity(); ``` -------------------------------- ### Configure All Place Content Source: https://developers.google.com/maps/documentation/javascript/reference/place-widget-child-elements Use PlaceAllContentElement to display all available content within a place detail widget. Append this element as a child to the widget. ```html ``` ```html ``` ```javascript const {PlaceAllContentElement} = await google.maps.importLibrary("places"); ``` -------------------------------- ### Import FleetEngineFleetLocationProvider Source: https://developers.google.com/maps/documentation/javascript/reference/journey-sharing-fleet-tracking-odrd Import the FleetEngineFleetLocationProvider class from the journeySharing library. This is required before instantiating the provider. ```javascript const {FleetEngineFleetLocationProvider} = await google.maps.importLibrary("journeySharing"); ``` -------------------------------- ### DrawingManager Methods Source: https://developers.google.com/maps/documentation/javascript/reference/drawing Methods for interacting with the DrawingManager, including getting and setting the drawing mode, map, and options. ```APIDOC ## DrawingManager Methods ### `getDrawingMode()` #### Description Returns the `DrawingManager`'s current drawing mode. #### Return Value `OverlayType | null` - The current drawing mode, or null if no drawing mode is set. ### `getMap()` #### Description Returns the `Map` to which the `DrawingManager` is attached. #### Return Value `Map | null` - The `Map` object, or null if the `DrawingManager` is not attached to a map. ### `setDrawingMode(drawingMode)` #### Description Changes the `DrawingManager`'s drawing mode. #### Parameters * `drawingMode`: `OverlayType` (optional) - The desired drawing mode. Accepted values are `'marker'`, `'polygon'`, `'polyline'`, `'rectangle'`, `'circle'`, or `null`. ### `setMap(map)` #### Description Attaches the `DrawingManager` object to the specified `Map`. #### Parameters * `map`: `Map` (optional) - The `Map` object to attach the `DrawingManager` to. ### `setOptions(options)` #### Description Sets the `DrawingManager`'s options. #### Parameters * `options`: `DrawingManagerOptions` (optional) - The options to set for the `DrawingManager`. ``` -------------------------------- ### Get Polyline Map Source: https://developers.google.com/maps/documentation/javascript/reference/polygon Retrieve the map object to which the polyline is currently attached. Returns null if the polyline is not on a map. ```javascript const map = polyline.getMap(); ``` -------------------------------- ### Importing the Data class Source: https://developers.google.com/maps/documentation/javascript/reference/data Shows the modern way to import the `Data` class using async/await syntax from the maps library. ```javascript const {Data} = await google.maps.importLibrary("maps"); ``` -------------------------------- ### Get GroundOverlay Map Source: https://developers.google.com/maps/documentation/javascript/reference/image-overlay Retrieve the map on which the ground overlay is currently displayed. Returns `null` if the overlay is not on a map. ```javascript const map = groundOverlay.getMap(); ``` -------------------------------- ### Import Marker Library Source: https://developers.google.com/maps/documentation/javascript/reference/marker Import the marker library to use the Marker class. This is necessary before constructing a marker. ```javascript const {Marker} = await google.maps.importLibrary("marker"); ``` -------------------------------- ### SpeedReadingInterval Source: https://developers.google.com/maps/documentation/javascript/reference Represents an interval for speed reading, providing start and end polyline point indices and the associated speed. ```APIDOC class SpeedReadingInterval _library "routes" Properties: `endPolylinePointIndex`, `speed`, `startPolylinePointIndex` ``` -------------------------------- ### Configure Open Now Status Display Source: https://developers.google.com/maps/documentation/javascript/reference/place-widget-child-elements Add `gmp-place-open-now-status` as a child of `gmp-place-content-config` to show whether a place is currently open or closed. Import `PlaceOpenNowStatusElement` for programmatic use. ```html ``` ```html ``` ```javascript const {PlaceOpenNowStatusElement} = await google.maps.importLibrary("places"); ``` -------------------------------- ### PlaceContextualListConfigElement HTML tag Source: https://developers.google.com/maps/documentation/javascript/reference/places-widget Example of using the gmp-place-contextual-list-config custom HTML element. It can configure layout and map visibility. ```html ``` -------------------------------- ### Importing the core library Source: https://developers.google.com/maps/documentation/javascript/reference/coordinates Import the 'core' library to use classes like LatLng. This is an asynchronous operation. ```javascript const {LatLng} = await google.maps.importLibrary("core"); ``` -------------------------------- ### Import StepsOverview Class Source: https://developers.google.com/maps/documentation/javascript/reference/route Import the StepsOverview class from the routes library. This class provides summarized information about multi-modal segments of RouteLeg.steps. ```javascript const {StepsOverview} = await google.maps.importLibrary("routes"); ``` -------------------------------- ### Get KmlLayer Map Source: https://developers.google.com/maps/documentation/javascript/reference/kml Retrieve the map on which the KML Layer is currently being rendered. Returns `null` if the layer is not associated with any map. ```javascript const map = kmlLayer.getMap(); ``` -------------------------------- ### Get Elevation for Locations Source: https://developers.google.com/maps/documentation/javascript/reference/elevation Make an elevation request for a list of discrete locations. The request should include an array of LatLng objects. ```javascript getElevationForLocations(request[, callback]) ``` -------------------------------- ### Instantiate JourneySharingMapView Source: https://developers.google.com/maps/documentation/javascript/reference/journey-sharing-map-view Instantiate a new JourneySharingMapView. Pass a JourneySharingMapViewOptions object to configure the map view. ```javascript new JourneySharingMapView(options) ``` -------------------------------- ### Import DistanceMatrixService Source: https://developers.google.com/maps/documentation/javascript/reference/distance-matrix Import the DistanceMatrixService class from the 'routes' library. This is required before instantiating the service. ```javascript const {DistanceMatrixService} = await google.maps.importLibrary("routes"); ``` -------------------------------- ### vehicleId Source: https://developers.google.com/maps/documentation/javascript/reference/journey-sharing-fleet-tracking-odrd The vehicle ID to track immediately upon instantiation of the location provider. If not set, tracking starts when `FleetEngineVehicleLocationProvider.vehicleId` is used. ```APIDOC ## Property: vehicleId ### Description The vehicle ID to track immediately after the location provider is instantiated. If not specified, the location provider does not start tracking any vehicle; use `FleetEngineVehicleLocationProvider.vehicleId` to set the ID and begin tracking. ### Type `string optional` ``` -------------------------------- ### PlaceContextualElement HTML tag Source: https://developers.google.com/maps/documentation/javascript/reference/places-widget Example of using the gmp-place-contextual custom HTML element. It requires a context-token attribute to display information. ```html ``` -------------------------------- ### Instantiate DirectionsService Source: https://developers.google.com/maps/documentation/javascript/reference/directions Create a new instance of DirectionsService. This service is used to send directions queries to Google servers. ```javascript new DirectionsService() ``` -------------------------------- ### Minimal PlaceDetailsElement Source: https://developers.google.com/maps/documentation/javascript/reference/places-widget A minimal example of using the PlaceDetailsElement. This tag can be used on its own, but will require further configuration to display specific place details. ```html ``` -------------------------------- ### FullscreenControlOptions Interface Source: https://developers.google.com/maps/documentation/javascript/reference Options for the fullscreen control. ```APIDOC ## FullscreenControlOptions ### Description Options for the fullscreen control. ### Properties - `position` (ControlPosition) ``` -------------------------------- ### Get Settings Instance Source: https://developers.google.com/maps/documentation/javascript/reference/settings Retrieve the singleton instance of the Settings class. This instance controls the global behavior of the Maps JavaScript API. ```javascript const settingsInstance = google.maps.Settings.getInstance(); ``` -------------------------------- ### SpeedReadingInterval Source: https://developers.google.com/maps/documentation/javascript/reference/route Represents traffic density on a segment of a polyline or path. It includes properties for the start and end indices of the interval and the traffic speed. ```APIDOC ## SpeedReadingInterval class `google.maps.routes.SpeedReadingInterval` class library "routes" Traffic density indicator on a contiguous segment of a polyline or path. Given a path with points P_0, P_1, ... , P_N (zero-based index), the `SpeedReadingInterval` describes the traffic density of an interval. ```javascript const {SpeedReadingInterval} = await google.maps.importLibrary("routes"); ``` ### Properties --- `endPolylinePointIndex` readonly | **Type:** `number optional` The ending index of this interval in the polyline. `speed` readonly | **Type:** `Speed optional` Traffic speed in this interval. `startPolylinePointIndex` readonly | **Type:** `number optional` The starting index of this interval in the polyline. ``` -------------------------------- ### open([options, anchor]) Source: https://developers.google.com/maps/documentation/javascript/reference/info-window Opens the InfoWindow on a specified map or Street View panorama, optionally associating it with an anchor. ```APIDOC ## open([options, anchor]) ### Description Opens this InfoWindow on the given map. Optionally, an InfoWindow can be associated with an anchor. In the core API, the only anchor is the Marker class. However, an anchor can be any MVCObject that exposes a LatLng `position` property and optionally a Point `anchorPoint` property for calculating the `pixelOffset` (see InfoWindowOptions). The `anchorPoint` is the offset from the anchor's position to the tip of the InfoWindow. It is recommended to use the `InfoWindowOpenOptions` interface as the single argument for this method. To prevent changing browser focus on open, set `InfoWindowOpenOptions.shouldFocus` to `false`. ### Method `open([options, anchor])` ### Parameters * `options`: `InfoWindowOpenOptions|Map|StreetViewPanorama optional` - Either an InfoWindowOpenOptions object (recommended) or the map|panorama on which to render this InfoWindow. * `anchor`: `MVCObject|AdvancedMarkerElement optional` - The anchor to which this InfoWindow will be positioned. If the anchor is non-null, the InfoWindow will be positioned at the top-center of the anchor. The InfoWindow will be rendered on the same map or panorama as the anchor **(when available)**. ### Return Value None ``` -------------------------------- ### Add a listener that triggers once Source: https://developers.google.com/maps/documentation/javascript/reference/event Similar to addListener, but the handler automatically removes itself after the first event is triggered. Useful for one-time setup or actions. ```javascript const listener = google.maps.event.addListenerOnce(instance, "eventName", handler); ``` -------------------------------- ### Create a HeatmapLayer Instance Source: https://developers.google.com/maps/documentation/javascript/reference/visualization Instantiate a new HeatmapLayer object. The constructor accepts an optional HeatmapLayerOptions object to configure the heatmap upon creation. ```javascript new google.maps.visualization.HeatmapLayer() ``` -------------------------------- ### Get KmlLayer Metadata Source: https://developers.google.com/maps/documentation/javascript/reference/kml Retrieve the metadata associated with the KML Layer, as specified in the layer's markup. This can include author information and descriptions. ```javascript const metadata = kmlLayer.getMetadata(); ```