Google Maps JavaScript API V3 Reference

Last updated Monday, February 26, 2024

This is an index of all the classes, methods, and interfaces in the Maps JavaScript API version 3.56 (weekly channel). This reference is kept up to date with the latest changes to the API.

For additional information see the Release Notes and Versioning.
Also see the reference documentation for version 3.55 (quarterly channel), version 3.54 and version 3.53.

Click the name of any item to see detailed documentation.

Global Concepts

google.maps

google.maps namespace

Static Methods: importLibrary

Constants: version

CoreLibrary interface

Properties: ControlPosition, event, LatLng, LatLngAltitude, LatLngBounds, MapsNetworkError, MapsNetworkErrorEndpoint, MapsRequestError, MapsServerError, MVCArray, MVCObject, Point, Settings, Size, SymbolPath, UnitSystem

MapsLibrary interface

Properties: BicyclingLayer, Circle, Data, FeatureType, GroundOverlay, ImageMapType, InfoWindow, KmlLayer, KmlLayerStatus, Map, MapTypeControlStyle, MapTypeId, MapTypeRegistry, MaxZoomService, MaxZoomStatus, OverlayView, Polygon, Polyline, Rectangle, RenderingType, StrokePosition, StyledMapType, TrafficLayer, TransitLayer, WebGLOverlayView, BetaZoomChangeEvent

PlacesLibrary interface

Properties: AccessibilityOptions, AddressComponent, Attribution, AuthorAttribution, Autocomplete, AutocompleteService, AutocompleteSessionToken, BusinessStatus, OpeningHours, OpeningHoursPeriod, OpeningHoursPoint, ParkingOptions, PaymentOptions, Photo, Place, PlacesService, PlacesServiceStatus, PlusCode, PriceLevel, RankBy, Review, SearchBox, SearchByTextRankPreference

GeocodingLibrary interface

Properties: Geocoder, GeocoderLocationType, GeocoderStatus

RoutesLibrary interface

Properties: DirectionsRenderer, DirectionsService, DirectionsStatus, DistanceMatrixElementStatus, DistanceMatrixService, DistanceMatrixStatus, TrafficModel, TransitMode, TransitRoutePreference, TravelMode, VehicleType

MarkerLibrary interface

Properties: AdvancedMarkerClickEvent, AdvancedMarkerElement, Animation, CollisionBehavior, Marker, PinElement

GeometryLibrary interface

Properties: encoding, poly, spherical

ElevationLibrary interface

Properties: ElevationService, ElevationStatus

StreetViewLibrary interface

Properties: InfoWindow, OverlayView, StreetViewCoverageLayer, StreetViewPanorama, StreetViewPreference, StreetViewService, StreetViewSource, StreetViewStatus

JourneySharingLibrary interface

Properties: AutomaticViewportMode, DeliveryVehicleStopState, FleetEngineDeliveryFleetLocationProvider, FleetEngineDeliveryVehicleLocationProvider, FleetEngineFleetLocationProvider, FleetEngineServiceType, FleetEngineShipmentLocationProvider, FleetEngineTripLocationProvider, FleetEngineVehicleLocationProvider, JourneySharingMapView, Speed, TripType, VehicleNavigationStatus, VehicleState, VehicleType, WaypointType

DrawingLibrary interface

Properties: DrawingManager, OverlayType

VisualizationLibrary interface

Properties: HeatmapLayer

Settings (beta)

BetaSettings class

Static Methods: BetagetInstance

Properties: BetaexperienceIds

Event system

event class

Static Methods: addListener, addListenerOnce, clearInstanceListeners, clearListeners, hasListeners, removeListener, trigger, addDomListener, addDomListenerOnce

MapsEventListener interface

Methods: remove

MVCObject class

Methods: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll

MVCArray class

Methods: clear, forEach, getArray, getAt, getLength, insertAt, pop, push, removeAt, setAt

Events: insert_at, remove_at, set_at

ErrorEvent interface

Properties: error

Errors

MapsNetworkError class

Properties: code, endpoint

MapsRequestError class
MapsServerError class
MapsNetworkErrorEndpoint constants

Constants: DIRECTIONS_ROUTE, DISTANCE_MATRIX, ELEVATION_ALONG_PATH, ELEVATION_LOCATIONS, FLEET_ENGINE_GET_DELIVERY_VEHICLE, FLEET_ENGINE_GET_TRIP, FLEET_ENGINE_GET_VEHICLE, FLEET_ENGINE_LIST_DELIVERY_VEHICLES, FLEET_ENGINE_LIST_TASKS, FLEET_ENGINE_LIST_VEHICLES, FLEET_ENGINE_SEARCH_TASKS, GEOCODER_GEOCODE, MAPS_MAX_ZOOM, PLACES_AUTOCOMPLETE, PLACES_DETAILS, PLACES_FIND_PLACE_FROM_PHONE_NUMBER, PLACES_FIND_PLACE_FROM_QUERY, PLACES_GATEWAY, PLACES_GET_PLACE, PLACES_LOCAL_CONTEXT_SEARCH, PLACES_NEARBY_SEARCH, PLACES_SEARCH_TEXT, STREETVIEW_GET_PANORAMA

Maps

Maps

Map class

Properties: controls, data, mapTypes, overlayMapTypes

Methods: fitBounds, getBounds, getCenter, getClickableIcons, BetagetDatasetFeatureLayer, getDiv, getFeatureLayer, getHeading, getMapCapabilities, getMapTypeId, getProjection, getRenderingType, getStreetView, getTilt, getZoom, moveCamera, panBy, panTo, panToBounds, setCenter, setClickableIcons, setHeading, setMapTypeId, setOptions, setStreetView, setTilt, setZoom

Constants: DEMO_MAP_ID

Events: bounds_changed, center_changed, click, contextmenu, dblclick, drag, dragend, dragstart, heading_changed, idle, isfractionalzoomenabled_changed, mapcapabilities_changed, maptypeid_changed, mousemove, mouseout, mouseover, projection_changed, renderingtype_changed, tilesloaded, tilt_changed, zoom_changed, rightclick

MapOptions interface

Properties: backgroundColor, center, clickableIcons, controlSize, disableDefaultUI, disableDoubleClickZoom, draggableCursor, draggingCursor, fullscreenControl, fullscreenControlOptions, gestureHandling, heading, isFractionalZoomEnabled, keyboardShortcuts, mapId, mapTypeControl, mapTypeControlOptions, mapTypeId, maxZoom, minZoom, noClear, restriction, rotateControl, rotateControlOptions, scaleControl, scaleControlOptions, scrollwheel, streetView, streetViewControl, streetViewControlOptions, styles, tilt, zoom, zoomControl, zoomControlOptions, draggable, panControl, panControlOptions

BetaMapElement class

Properties: center, innerMap, mapId, zoom

Methods: BetaaddEventListener, BetaremoveEventListener

Events: gmp-zoomchange

BetaMapElementOptions interface

Properties: center, mapId, zoom

BetaZoomChangeEvent class
MapTypeStyle interface

Properties: elementType, featureType, stylers

MapMouseEvent interface

Properties: domEvent, latLng

Methods: stop

IconMouseEvent interface

Properties: placeId

MapTypeId constants

Constants: HYBRID, ROADMAP, SATELLITE, TERRAIN

MapTypeRegistry class

Methods: set

MapRestriction interface

Properties: latLngBounds, strictBounds

TrafficLayer class

Methods: getMap, setMap, setOptions

TrafficLayerOptions interface

Properties: autoRefresh, map

TransitLayer class

Methods: getMap, setMap

BicyclingLayer class

Methods: getMap, setMap

BetaCameraOptions interface

Properties: center, heading, tilt, zoom

VisibleRegion interface

Properties: farLeft, farRight, latLngBounds, nearLeft, nearRight

RenderingType constants

Constants: RASTER, UNINITIALIZED, VECTOR

MapCapabilities interface

Properties: isAdvancedMarkersAvailable, isDataDrivenStylingAvailable

WebGL

WebGLOverlayView class

Methods: getMap, onAdd, onContextLost, onContextRestored, onDraw, onRemove, onStateUpdate, requestRedraw, requestStateUpdate, setMap

WebGLDrawOptions interface

Properties: gl, transformer

WebGLStateOptions interface

Properties: gl

CoordinateTransformer interface

Methods: fromLatLngAltitude, getCameraParams

CameraParams interface

Properties: center, heading, tilt, zoom

Coordinates

LatLng class

Methods: equals, lat, lng, toJSON, toString, toUrlValue

LatLngLiteral interface

Properties: lat, lng

LatLngBounds class

Methods: contains, equals, extend, getCenter, getNorthEast, getSouthWest, intersects, isEmpty, toJSON, toSpan, toString, toUrlValue, union

Constants: MAX_BOUNDS

LatLngBoundsLiteral interface

Properties: east, north, south, west

LatLngAltitude class

Properties: altitude, lat, lng

Methods: equals, toJSON

LatLngAltitudeLiteral interface

Properties: altitude, lat, lng

Point class

Properties: x, y

Methods: equals, toString

Size class

Properties: height, width

Methods: equals, toString

Padding interface

Properties: bottom, left, right, top

CircleLiteral interface

Properties: center, radius

Data-driven styling

FeatureLayer interface

Properties: BetadatasetId, featureType, isAvailable, style

Methods: addListener

Events: click, mousemove

FeatureType constants

Constants: ADMINISTRATIVE_AREA_LEVEL_1, ADMINISTRATIVE_AREA_LEVEL_2, COUNTRY, BetaDATASET, LOCALITY, POSTAL_CODE, SCHOOL_DISTRICT

FeatureStyleFunction typedef
FeatureStyleFunctionOptions interface

Properties: feature

FeatureStyleOptions interface

Properties: fillColor, fillOpacity, strokeColor, strokeOpacity, strokeWeight

Feature interface

Properties: featureType

PlaceFeature interface

Properties: placeId

Methods: fetchPlace

BetaDatasetFeature interface

Properties: datasetAttributes, datasetId

FeatureMouseEvent interface

Properties: features

Controls

FullscreenControlOptions interface

Properties: position

MapTypeControlOptions interface

Properties: mapTypeIds, position, style

MapTypeControlStyle constants

Constants: DEFAULT, DROPDOWN_MENU, HORIZONTAL_BAR

MotionTrackingControlOptions interface

Properties: position

PanControlOptions interface

Properties: position

RotateControlOptions interface

Properties: position

ScaleControlOptions interface

Properties: style

ScaleControlStyle constants

Constants: DEFAULT

StreetViewControlOptions interface

Properties: position, sources

ZoomControlOptions interface

Properties: position

ControlPosition constants

Constants: BLOCK_END_INLINE_CENTER, BLOCK_END_INLINE_END, BLOCK_END_INLINE_START, BLOCK_START_INLINE_CENTER, BLOCK_START_INLINE_END, BLOCK_START_INLINE_START, BOTTOM_CENTER, BOTTOM_LEFT, BOTTOM_RIGHT, INLINE_END_BLOCK_CENTER, INLINE_END_BLOCK_END, INLINE_END_BLOCK_START, INLINE_START_BLOCK_CENTER, INLINE_START_BLOCK_END, INLINE_START_BLOCK_START, LEFT_BOTTOM, LEFT_CENTER, LEFT_TOP, RIGHT_BOTTOM, RIGHT_CENTER, RIGHT_TOP, TOP_CENTER, TOP_LEFT, TOP_RIGHT

Geometry Library

encoding namespace

Static Methods: decodePath, encodePath

spherical namespace

Static Methods: computeArea, computeDistanceBetween, computeHeading, computeLength, computeOffset, computeOffsetOrigin, computeSignedArea, interpolate

poly namespace

Static Methods: containsLocation, isLocationOnEdge

Drawing on the map

Advanced Markers

AdvancedMarkerElement class

Properties: collisionBehavior, content, element, BetagmpClickable, gmpDraggable, map, position, title, zIndex

Methods: BetaaddEventListener, addListener, BetaremoveEventListener

Events: click, drag, dragend, dragstart, Betagmp-click

AdvancedMarkerElementOptions interface

Properties: collisionBehavior, content, BetagmpClickable, gmpDraggable, map, position, title, zIndex

BetaAdvancedMarkerClickEvent class
PinElement class

Properties: background, borderColor, element, glyph, glyphColor, scale

Methods: BetaaddEventListener, BetaremoveEventListener

PinElementOptions interface

Properties: background, borderColor, glyph, glyphColor, scale

Info Window

InfoWindow class

Methods: close, focus, getContent, getPosition, getZIndex, open, setContent, setOptions, setPosition, setZIndex

Events: closeclick, content_changed, domready, position_changed, visible, zindex_changed

InfoWindowOptions interface

Properties: ariaLabel, content, disableAutoPan, maxWidth, minWidth, pixelOffset, position, zIndex

InfoWindowOpenOptions interface

Properties: anchor, map, shouldFocus

Polygons

Polyline class

Methods: getDraggable, getEditable, getMap, getPath, getVisible, setDraggable, setEditable, setMap, setOptions, setPath, setVisible

Events: click, contextmenu, dblclick, drag, dragend, dragstart, mousedown, mousemove, mouseout, mouseover, mouseup, rightclick

PolylineOptions interface

Properties: clickable, draggable, editable, geodesic, icons, map, path, strokeColor, strokeOpacity, strokeWeight, visible, zIndex

IconSequence interface

Properties: fixedRotation, icon, offset, repeat

Polygon class

Methods: getDraggable, getEditable, getMap, getPath, getPaths, getVisible, setDraggable, setEditable, setMap, setOptions, setPath, setPaths, setVisible

Events: click, contextmenu, dblclick, drag, dragend, dragstart, mousedown, mousemove, mouseout, mouseover, mouseup, rightclick

PolygonOptions interface

Properties: clickable, draggable, editable, fillColor, fillOpacity, geodesic, map, paths, strokeColor, strokeOpacity, strokePosition, strokeWeight, visible, zIndex

PolyMouseEvent interface

Properties: edge, path, vertex

Rectangle class

Methods: getBounds, getDraggable, getEditable, getMap, getVisible, setBounds, setDraggable, setEditable, setMap, setOptions, setVisible

Events: bounds_changed, click, contextmenu, dblclick, drag, dragend, dragstart, mousedown, mousemove, mouseout, mouseover, mouseup, rightclick

RectangleOptions interface

Properties: bounds, clickable, draggable, editable, fillColor, fillOpacity, map, strokeColor, strokeOpacity, strokePosition, strokeWeight, visible, zIndex

Circle class

Methods: getBounds, getCenter, getDraggable, getEditable, getMap, getRadius, getVisible, setCenter, setDraggable, setEditable, setMap, setOptions, setRadius, setVisible

Events: center_changed, click, dblclick, drag, dragend, dragstart, mousedown, mousemove, mouseout, mouseover, mouseup, radius_changed, rightclick

CircleOptions interface

Properties: center, clickable, draggable, editable, fillColor, fillOpacity, map, radius, strokeColor, strokeOpacity, strokePosition, strokeWeight, visible, zIndex

StrokePosition constants

Constants: CENTER, INSIDE, OUTSIDE

Data

Data class

Methods: add, addGeoJson, contains, forEach, getControlPosition, getControls, getDrawingMode, getFeatureById, getMap, getStyle, loadGeoJson, overrideStyle, remove, revertStyle, setControlPosition, setControls, setDrawingMode, setMap, setStyle, toGeoJson

Events: addfeature, click, contextmenu, dblclick, mousedown, mouseout, mouseover, mouseup, removefeature, removeproperty, setgeometry, setproperty, rightclick

Data.DataOptions interface

Properties: controlPosition, controls, drawingMode, featureFactory, map, style

Data.GeoJsonOptions interface

Properties: idPropertyName

Data.StyleOptions interface

Properties: animation, clickable, cursor, draggable, editable, fillColor, fillOpacity, icon, icons, label, opacity, shape, strokeColor, strokeOpacity, strokeWeight, title, visible, zIndex

Data.StylingFunction typedef
Data.Feature class

Methods: forEachProperty, getGeometry, getId, getProperty, removeProperty, setGeometry, setProperty, toGeoJson

Events: removeproperty, setgeometry, setproperty

Data.FeatureOptions interface

Properties: geometry, id, properties

Data.Geometry interface

Methods: forEachLatLng, getType

Data.Point class

Methods: forEachLatLng, get, getType

Data.MultiPoint class

Methods: forEachLatLng, getArray, getAt, getLength, getType

Data.LineString class

Methods: forEachLatLng, getArray, getAt, getLength, getType

Data.MultiLineString class

Methods: forEachLatLng, getArray, getAt, getLength, getType

Data.LinearRing class

Methods: forEachLatLng, getArray, getAt, getLength, getType

Data.Polygon class

Methods: forEachLatLng, getArray, getAt, getLength, getType

Data.MultiPolygon class

Methods: forEachLatLng, getArray, getAt, getLength, getType

Data.GeometryCollection class

Methods: forEachLatLng, getArray, getAt, getLength, getType

Data.MouseEvent interface

Properties: feature

Data.AddFeatureEvent interface

Properties: feature

Data.RemoveFeatureEvent interface

Properties: feature

Data.SetGeometryEvent interface

Properties: feature, newGeometry, oldGeometry

Data.SetPropertyEvent interface

Properties: feature, name, newValue, oldValue

Data.RemovePropertyEvent interface

Properties: feature, name, oldValue

DOM elements

OverlayView class

Static Methods: preventMapHitsAndGesturesFrom, preventMapHitsFrom

Methods: draw, getMap, getPanes, getProjection, onAdd, onRemove, setMap

MapPanes interface

Properties: floatPane, mapPane, markerLayer, overlayLayer, overlayMouseTarget

MapCanvasProjection interface

Methods: fromContainerPixelToLatLng, fromDivPixelToLatLng, fromLatLngToContainerPixel, fromLatLngToDivPixel, getVisibleRegion, getWorldWidth

KML

KmlLayer class

Methods: getDefaultViewport, getMap, getMetadata, getStatus, getUrl, getZIndex, setMap, setOptions, setUrl, setZIndex

Events: click, defaultviewport_changed, status_changed

KmlLayerOptions interface

Properties: clickable, map, preserveViewport, screenOverlays, suppressInfoWindows, url, zIndex

KmlLayerMetadata interface

Properties: author, description, hasScreenOverlays, name, snippet

KmlLayerStatus constants

Constants: DOCUMENT_NOT_FOUND, DOCUMENT_TOO_LARGE, FETCH_ERROR, INVALID_DOCUMENT, INVALID_REQUEST, LIMITS_EXCEEDED, OK, TIMED_OUT, UNKNOWN

KmlMouseEvent interface

Properties: featureData, latLng, pixelOffset

KmlFeatureData interface

Properties: author, description, id, infoWindowHtml, name, snippet

KmlAuthor interface

Properties: email, name, uri

Image overlays

MapType interface

Properties: alt, maxZoom, minZoom, name, projection, radius, tileSize

Methods: getTile, releaseTile

Projection interface

Methods: fromLatLngToPoint, fromPointToLatLng

ImageMapType class

Properties: alt, maxZoom, minZoom, name, projection, radius, tileSize

Methods: getOpacity, getTile, releaseTile, setOpacity

Events: tilesloaded

ImageMapTypeOptions interface

Properties: alt, getTileUrl, maxZoom, minZoom, name, opacity, tileSize

GroundOverlay class

Methods: getBounds, getMap, getOpacity, getUrl, setMap, setOpacity

Events: click, dblclick

GroundOverlayOptions interface

Properties: clickable, map, opacity

StyledMapType class

Properties: alt, maxZoom, minZoom, name, projection, radius, tileSize

Methods: getTile, releaseTile

StyledMapTypeOptions interface

Properties: alt, maxZoom, minZoom, name

Drawing Library

DrawingManager class

Methods: getDrawingMode, getMap, setDrawingMode, setMap, setOptions

Events: circlecomplete, markercomplete, overlaycomplete, polygoncomplete, polylinecomplete, rectanglecomplete

DrawingManagerOptions interface

Properties: circleOptions, drawingControl, drawingControlOptions, drawingMode, map, markerOptions, polygonOptions, polylineOptions, rectangleOptions

DrawingControlOptions interface

Properties: drawingModes, position

OverlayCompleteEvent interface

Properties: overlay, type

OverlayType constants

Constants: CIRCLE, MARKER, POLYGON, POLYLINE, RECTANGLE

Heatmaps

HeatmapLayer class

Methods: getData, getMap, setData, setMap, setOptions

HeatmapLayerOptions interface

Properties: data, dissipating, gradient, map, maxIntensity, opacity, radius

WeightedLocation interface

Properties: location, weight

Max Zoom

MaxZoomService class

Methods: getMaxZoomAtLatLng

MaxZoomResult interface

Properties: status, zoom

MaxZoomStatus constants

Constants: ERROR, OK

Marker (legacy)

Marker class

Methods: getAnimation, getClickable, getCursor, getDraggable, getIcon, getLabel, getMap, getOpacity, getPosition, getShape, getTitle, getVisible, getZIndex, setAnimation, setClickable, setCursor, setDraggable, setIcon, setLabel, setMap, setOpacity, setOptions, setPosition, setShape, setTitle, setVisible, setZIndex

Constants: MAX_ZINDEX

Events: animation_changed, click, clickable_changed, contextmenu, cursor_changed, dblclick, drag, dragend, draggable_changed, dragstart, flat_changed, icon_changed, mousedown, mouseout, mouseover, mouseup, position_changed, shape_changed, title_changed, visible_changed, zindex_changed, rightclick

MarkerOptions interface

Properties: anchorPoint, animation, clickable, crossOnDrag, cursor, draggable, icon, label, map, opacity, optimized, position, shape, title, visible, zIndex, BetacollisionBehavior

CollisionBehavior constants

Constants: OPTIONAL_AND_HIDES_LOWER_PRIORITY, REQUIRED, REQUIRED_AND_HIDES_OPTIONAL

Icon interface

Properties: anchor, labelOrigin, origin, scaledSize, size, url

MarkerLabel interface

Properties: className, color, fontFamily, fontSize, fontWeight, text

MarkerShape interface

Properties: coords, type

Symbol interface

Properties: anchor, fillColor, fillOpacity, labelOrigin, path, rotation, scale, strokeColor, strokeOpacity, strokeWeight

SymbolPath constants

Constants: BACKWARD_CLOSED_ARROW, BACKWARD_OPEN_ARROW, CIRCLE, FORWARD_CLOSED_ARROW, FORWARD_OPEN_ARROW

Animation constants

Constants: BOUNCE, DROP

Street View

Rendering

StreetViewPanorama class

Properties: controls

Methods: focus, getLinks, getLocation, getMotionTracking, getPano, getPhotographerPov, getPosition, getPov, getStatus, getVisible, getZoom, registerPanoProvider, setLinks, setMotionTracking, setOptions, setPano, setPosition, setPov, setVisible, setZoom

Events: closeclick, pano_changed, position_changed, pov_changed, resize, status_changed, visible_changed, zoom_changed

StreetViewPanoramaOptions interface

Properties: addressControl, addressControlOptions, clickToGo, controlSize, disableDefaultUI, disableDoubleClickZoom, enableCloseButton, fullscreenControl, fullscreenControlOptions, imageDateControl, linksControl, motionTracking, motionTrackingControl, motionTrackingControlOptions, panControl, panControlOptions, pano, position, pov, scrollwheel, showRoadLabels, visible, zoom, zoomControl, zoomControlOptions

StreetViewAddressControlOptions interface

Properties: position

PanoProviderOptions interface

Properties: cors

StreetViewTileData interface

Properties: centerHeading, tileSize, worldSize

Methods: getTileUrl

StreetViewPov interface

Properties: heading, pitch

StreetViewCoverageLayer class

Methods: getMap, setMap

Service

StreetViewService class

Methods: getPanorama

StreetViewStatus constants

Constants: OK, UNKNOWN_ERROR, ZERO_RESULTS

StreetViewLocationRequest interface

Properties: location, preference, radius, sources, source

StreetViewPanoRequest interface

Properties: pano

StreetViewResponse interface

Properties: data

StreetViewLocation interface

Properties: description, latLng, pano, shortDescription

StreetViewPreference constants

Constants: BEST, NEAREST

StreetViewSource constants

Constants: DEFAULT, GOOGLE, OUTDOOR

StreetViewPanoramaData interface

Properties: copyright, imageDate, links, location, tiles

Properties: description, heading, pano

Places

Places Widgets

BetaPlaceAutocompleteElement class

Properties: componentRestrictions, locationBias, locationRestriction, name, requestedLanguage, requestedRegion, types

Methods: BetaaddEventListener, BetaremoveEventListener

BetaPlaceAutocompleteElementOptions interface

Properties: componentRestrictions, locationBias, locationRestriction, requestedLanguage, requestedRegion, types

BetaPlaceAutocompletePlaceSelectEvent class

Properties: Betaplace

BetaPlaceAutocompleteRequestErrorEvent class
Autocomplete class

Methods: getBounds, getFields, getPlace, setBounds, setComponentRestrictions, setFields, setOptions, setTypes

Events: place_changed

AutocompleteOptions interface

Properties: bounds, componentRestrictions, fields, strictBounds, types, placeIdOnly

Methods: getBounds, getPlaces, setBounds

Events: places_changed

SearchBoxOptions interface

Properties: bounds

Place

Place class

Static Methods: searchByText

Properties: accessibilityOptions, addressComponents, adrFormatAddress, allowsDogs, attributions, businessStatus, displayName, editorialSummary, editorialSummaryLanguageCode, formattedAddress, googleMapsURI, hasCurbsidePickup, hasDelivery, hasDineIn, hasLiveMusic, hasMenuForChildren, hasOutdoorSeating, hasRestroom, hasTakeout, hasWiFi, iconBackgroundColor, id, internationalPhoneNumber, isGoodForChildren, isGoodForGroups, isGoodForWatchingSports, isReservable, location, nationalPhoneNumber, parkingOptions, paymentOptions, photos, plusCode, priceLevel, rating, regularOpeningHours, requestedLanguage, requestedRegion, reviews, servesBeer, servesBreakfast, servesBrunch, servesCocktails, servesCoffee, servesDessert, servesDinner, servesLunch, servesVegetarianFood, servesWine, svgIconMaskURI, types, userRatingCount, utcOffsetMinutes, viewport, websiteURI, openingHours

Methods: fetchFields, BetagetNextOpeningTime, BetaisOpen, toJSON

PlaceOptions interface

Properties: id, requestedLanguage, requestedRegion

AccessibilityOptions class

Properties: hasWheelchairAccessibleEntrance, hasWheelchairAccessibleParking, hasWheelchairAccessibleRestroom, hasWheelchairAccessibleSeating

BetaAddressComponent class

Properties: longText, shortText, types

BetaAttribution class

Properties: provider, providerURI

FetchFieldsRequest interface

Properties: fields

BetaOpeningHours class

Properties: periods, weekdayDescriptions

BetaOpeningHoursPeriod class

Properties: close, open

BetaOpeningHoursPoint class

Properties: day, hour, minute

ParkingOptions class

Properties: hasFreeGarageParking, hasFreeParkingLot, hasFreeStreetParking, hasPaidGarageParking, hasPaidParkingLot, hasPaidStreetParking, hasValetParking

PaymentOptions class

Properties: acceptsCashOnly, acceptsCreditCards, acceptsDebitCards, acceptsNFC

BetaPhoto class

Properties: authorAttributions, heightPx, widthPx

Methods: getURI

BetaAuthorAttribution class

Properties: displayName, photoURI, uri

BetaPlusCode class

Properties: compoundCode, globalCode

BetaReview class

Properties: authorAttribution, publishTime, rating, relativePublishTimeDescription, text, textLanguageCode

BetaPriceLevel constants

Constants: EXPENSIVE, FREE, INEXPENSIVE, MODERATE, VERY_EXPENSIVE

SearchByTextRequest interface

Properties: fields, includedType, isOpenNow, language, locationBias, locationRestriction, maxResultCount, minRating, priceLevels, rankPreference, region, textQuery, useStrictTypeFiltering, query, BetarankBy

SearchByTextRankPreference constants

Constants: DISTANCE, RELEVANCE

Places Service

PlacesService class

Methods: findPlaceFromPhoneNumber, findPlaceFromQuery, getDetails, nearbySearch, textSearch

PlaceDetailsRequest interface

Properties: fields, language, placeId, region, sessionToken

FindPlaceFromPhoneNumberRequest interface

Properties: fields, language, locationBias, phoneNumber

FindPlaceFromQueryRequest interface

Properties: fields, language, locationBias, query

PlaceSearchRequest interface

Properties: bounds, keyword, language, location, maxPriceLevel, minPriceLevel, openNow, radius, rankBy, type, name

TextSearchRequest interface

Properties: bounds, language, location, query, radius, region, type

RankBy constants

Constants: DISTANCE, PROMINENCE

LocationBias typedef
LocationRestriction typedef
PlacesServiceStatus constants

Constants: INVALID_REQUEST, NOT_FOUND, OK, OVER_QUERY_LIMIT, REQUEST_DENIED, UNKNOWN_ERROR, ZERO_RESULTS

PlaceSearchPagination interface

Properties: hasNextPage

Methods: nextPage

PlaceResult interface

Properties: address_components, adr_address, aspects, business_status, formatted_address, formatted_phone_number, geometry, html_attributions, icon, icon_background_color, icon_mask_base_uri, international_phone_number, name, opening_hours, photos, place_id, plus_code, price_level, rating, reviews, types, url, user_ratings_total, utc_offset_minutes, vicinity, website, utc_offset, permanently_closed

PlaceAspectRating interface

Properties: rating, type

BusinessStatus constants

Constants: CLOSED_PERMANENTLY, CLOSED_TEMPORARILY, OPERATIONAL

PlaceGeometry interface

Properties: location, viewport

PlaceOpeningHours interface

Properties: periods, weekday_text, open_now

Methods: isOpen

PlaceOpeningHoursPeriod interface

Properties: close, open

PlaceOpeningHoursTime interface

Properties: day, hours, minutes, nextDate, time

PlacePlusCode interface

Properties: compound_code, global_code

PlacePhoto interface

Properties: height, html_attributions, width

Methods: getUrl

PhotoOptions interface

Properties: maxHeight, maxWidth

PlaceReview interface

Properties: author_name, author_url, language, profile_photo_url, rating, relative_time_description, text, time, aspects

Places Autocomplete Service

AutocompleteService class

Methods: getPlacePredictions, getQueryPredictions

AutocompletionRequest interface

Properties: componentRestrictions, input, language, locationBias, locationRestriction, offset, origin, region, sessionToken, types, bounds, location, radius

AutocompleteResponse interface

Properties: predictions

QueryAutocompletionRequest interface

Properties: bounds, input, location, offset, radius

AutocompleteSessionToken class
ComponentRestrictions interface

Properties: country

AutocompletePrediction interface

Properties: description, distance_meters, matched_substrings, place_id, structured_formatting, terms, types

QueryAutocompletePrediction interface

Properties: description, matched_substrings, place_id, terms

PredictionTerm interface

Properties: offset, value

PredictionSubstring interface

Properties: length, offset

StructuredFormatting interface

Properties: main_text, main_text_matched_substrings, secondary_text

Geocoder

Geocoder class

Methods: geocode

GeocoderRequest interface

Properties: address, bounds, componentRestrictions, language, location, placeId, region

GeocoderComponentRestrictions interface

Properties: administrativeArea, country, locality, postalCode, route

GeocoderStatus constants

Constants: ERROR, INVALID_REQUEST, OK, OVER_QUERY_LIMIT, REQUEST_DENIED, UNKNOWN_ERROR, ZERO_RESULTS

GeocoderResponse interface

Properties: results

GeocoderResult interface

Properties: address_components, formatted_address, geometry, partial_match, place_id, plus_code, postcode_localities, types

GeocoderAddressComponent interface

Properties: long_name, short_name, types

GeocoderGeometry interface

Properties: bounds, location, location_type, viewport

GeocoderLocationType constants

Constants: APPROXIMATE, GEOMETRIC_CENTER, RANGE_INTERPOLATED, ROOFTOP

Routes

Directions

DirectionsService class

Methods: route

DirectionsRequest interface

Properties: avoidFerries, avoidHighways, avoidTolls, destination, drivingOptions, language, optimizeWaypoints, origin, provideRouteAlternatives, region, transitOptions, travelMode, unitSystem, waypoints

DirectionsStatus constants

Constants: INVALID_REQUEST, MAX_WAYPOINTS_EXCEEDED, NOT_FOUND, OK, OVER_QUERY_LIMIT, REQUEST_DENIED, UNKNOWN_ERROR, ZERO_RESULTS

DirectionsResult interface

Properties: available_travel_modes, geocoded_waypoints, request, routes

DirectionsRenderer class

Methods: getDirections, getMap, getPanel, getRouteIndex, setDirections, setMap, setOptions, setPanel, setRouteIndex

Events: directions_changed

DirectionsRendererOptions interface

Properties: directions, draggable, hideRouteList, infoWindow, map, markerOptions, panel, polylineOptions, preserveViewport, routeIndex, suppressBicyclingLayer, suppressInfoWindows, suppressMarkers, suppressPolylines

DirectionsWaypoint interface

Properties: location, stopover

DirectionsGeocodedWaypoint interface

Properties: partial_match, place_id, types

DirectionsRoute interface

Properties: bounds, copyrights, fare, legs, overview_path, overview_polyline, summary, warnings, waypoint_order

DirectionsLeg interface

Properties: arrival_time, departure_time, distance, duration, duration_in_traffic, end_address, end_location, start_address, start_location, steps, via_waypoints, traffic_speed_entry

DirectionsStep interface

Properties: distance, duration, encoded_lat_lngs, end_location, instructions, maneuver, path, start_location, steps, transit, transit_details, travel_mode, start_point, end_point, lat_lngs, polyline

DirectionsPolyline interface

Properties: points

Place interface

Properties: location, placeId, query

TravelMode constants

Constants: BICYCLING, DRIVING, TRANSIT, WALKING

DrivingOptions interface

Properties: departureTime, trafficModel

TrafficModel constants

Constants: BEST_GUESS, OPTIMISTIC, PESSIMISTIC

TransitOptions interface

Properties: arrivalTime, departureTime, modes, routingPreference

TransitMode constants

Constants: BUS, RAIL, SUBWAY, TRAIN, TRAM

TransitRoutePreference constants

Constants: FEWER_TRANSFERS, LESS_WALKING

TransitFare interface

Properties: currency, value

TransitDetails interface

Properties: arrival_stop, arrival_time, departure_stop, departure_time, headsign, headway, line, num_stops, trip_short_name

TransitStop interface

Properties: location, name

TransitLine interface

Properties: agencies, color, icon, name, short_name, text_color, url, vehicle

TransitAgency interface

Properties: name, phone, url

TransitVehicle interface

Properties: icon, local_icon, name, type

VehicleType constants

Constants: BUS, CABLE_CAR, COMMUTER_TRAIN, FERRY, FUNICULAR, GONDOLA_LIFT, HEAVY_RAIL, HIGH_SPEED_TRAIN, INTERCITY_BUS, METRO_RAIL, MONORAIL, OTHER, RAIL, SHARE_TAXI, SUBWAY, TRAM, TROLLEYBUS

UnitSystem constants

Constants: IMPERIAL, METRIC

Distance interface

Properties: text, value

Duration interface

Properties: text, value

Time interface

Properties: text, time_zone, value

DirectionsTravelMode constants
DirectionsUnitSystem constants

Distance Matrix

DistanceMatrixService class

Methods: getDistanceMatrix

DistanceMatrixRequest interface

Properties: avoidFerries, avoidHighways, avoidTolls, destinations, drivingOptions, language, origins, region, transitOptions, travelMode, unitSystem

DistanceMatrixResponse interface

Properties: destinationAddresses, originAddresses, rows

DistanceMatrixResponseRow interface

Properties: elements

DistanceMatrixResponseElement interface

Properties: distance, duration, duration_in_traffic, fare, status

DistanceMatrixStatus constants

Constants: INVALID_REQUEST, MAX_DIMENSIONS_EXCEEDED, MAX_ELEMENTS_EXCEEDED, OK, OVER_QUERY_LIMIT, REQUEST_DENIED, UNKNOWN_ERROR

DistanceMatrixElementStatus constants

Constants: NOT_FOUND, OK, ZERO_RESULTS

Elevation

ElevationService class

Methods: getElevationAlongPath, getElevationForLocations

LocationElevationRequest interface

Properties: locations

LocationElevationResponse interface

Properties: results

PathElevationRequest interface

Properties: path, samples

PathElevationResponse interface

Properties: results

ElevationResult interface

Properties: elevation, location, resolution

ElevationStatus constants

Constants: INVALID_REQUEST, OK, OVER_QUERY_LIMIT, REQUEST_DENIED, UNKNOWN_ERROR

Journey Sharing

Map View

JourneySharingMapView class

Properties: automaticViewportMode, element, enableTraffic, locationProviders, map, mapOptions, locationProvider, destinationMarkerSetup, originMarkerSetup, taskOutcomeMarkerSetup, unsuccessfulTaskMarkerSetup, vehicleMarkerSetup, waypointMarkerSetup, anticipatedRoutePolylineSetup, takenRoutePolylineSetup, pingMarkerSetup, successfulTaskMarkerSetup, destinationMarkers, originMarkers, successfulTaskMarkers, taskOutcomeMarkers, unsuccessfulTaskMarkers, vehicleMarkers, waypointMarkers, anticipatedRoutePolylines, takenRoutePolylines

Methods: addLocationProvider, removeLocationProvider

JourneySharingMapViewOptions interface

Properties: automaticViewportMode, element, locationProviders, mapOptions, locationProvider, destinationMarkerSetup, originMarkerSetup, taskOutcomeMarkerSetup, unsuccessfulTaskMarkerSetup, vehicleMarkerSetup, waypointMarkerSetup, anticipatedRoutePolylineSetup, takenRoutePolylineSetup, pingMarkerSetup, successfulTaskMarkerSetup

AutomaticViewportMode constants

Constants: FIT_ANTICIPATED_ROUTE, NONE

LocationProvider abstract class

Methods: addListener

PollingLocationProvider abstract class

Properties: isPolling, pollingIntervalMillis

Events: ispollingchange

PollingLocationProviderIsPollingChangeEvent interface

Properties: error

Authentication

AuthToken interface

Properties: expiresInSeconds, token

AuthTokenContext interface

Properties: deliveryVehicleId, taskId, trackingId, tripId, vehicleId

AuthTokenFetcher typedef
AuthTokenFetcherOptions interface

Properties: context, serviceType

FleetEngineServiceType constants

Constants: DELIVERY_VEHICLE_SERVICE, TASK_SERVICE, TRIP_SERVICE, UNKNOWN_SERVICE

UI Customization

PolylineSetup typedef
PolylineSetupOptions interface

Properties: polylineOptions, visible

DefaultPolylineSetupOptions interface

Properties: defaultPolylineOptions, defaultVisible

MarkerSetup typedef
MarkerSetupOptions interface

Properties: markerOptions

DefaultMarkerSetupOptions interface

Properties: defaultMarkerOptions

MarkerCustomizationFunctionParams interface

Properties: defaultOptions, isNew, marker

DeliveryVehicleMarkerCustomizationFunctionParams interface

Properties: vehicle

PlannedStopMarkerCustomizationFunctionParams interface

Properties: stopIndex

TaskMarkerCustomizationFunctionParams interface

Properties: task

ShipmentMarkerCustomizationFunctionParams interface

Properties: taskTrackingInfo

TripMarkerCustomizationFunctionParams interface

Properties: trip

TripWaypointMarkerCustomizationFunctionParams interface

Properties: waypointIndex

BetaVehicleMarkerCustomizationFunctionParams interface

Properties: vehicle

BetaVehicleWaypointMarkerCustomizationFunctionParams interface

Properties: waypointIndex

PolylineCustomizationFunctionParams interface

Properties: defaultOptions, isNew, polylines

ShipmentPolylineCustomizationFunctionParams interface

Properties: taskTrackingInfo

TripPolylineCustomizationFunctionParams interface

Properties: trip

VehiclePolylineCustomizationFunctionParams interface

Properties: vehicle

DeliveryVehiclePolylineCustomizationFunctionParams interface

Properties: deliveryVehicle

Fleet Engine Entities

Task interface

Properties: attributes, estimatedCompletionTime, latestVehicleLocationUpdate, name, outcome, outcomeLocation, outcomeLocationSource, outcomeTime, plannedLocation, remainingVehicleJourneySegments, status, targetTimeWindow, trackingId, type, vehicleId

TaskInfo interface

Properties: extraDurationMillis, id, targetTimeWindow

TaskTrackingInfo interface

Properties: attributes, estimatedArrivalTime, estimatedTaskCompletionTime, latestVehicleLocationUpdate, name, plannedLocation, remainingDrivingDistanceMeters, remainingStopCount, routePolylinePoints, state, targetTimeWindow, taskOutcome, taskOutcomeTime, trackingId

Trip interface

Properties: actualDropOffLocation, actualPickupLocation, dropOffTime, latestVehicleLocationUpdate, name, passengerCount, pickupTime, plannedDropOffLocation, plannedPickupLocation, remainingWaypoints, status, type, vehicleId

DeliveryVehicle interface

Properties: attributes, currentRouteSegmentEndPoint, latestVehicleLocationUpdate, name, navigationStatus, remainingDistanceMeters, remainingDurationMillis, remainingVehicleJourneySegments

DeliveryVehicleStop interface

Properties: plannedLocation, state, tasks

DeliveryVehicleStopState constants

Constants: ARRIVED, ENROUTE, NEW, UNSPECIFIED

VehicleJourneySegment interface

Properties: drivingDistanceMeters, drivingDurationMillis, path, stop

VehicleLocationUpdate interface

Properties: heading, location, speedKilometersPerHour, time

VehicleWaypoint interface

Properties: distanceMeters, durationMillis, location, path, speedReadingIntervals

BetaVehicle interface

Properties: attributes, currentRouteSegmentEndPoint, currentRouteSegmentVersion, currentTrips, etaToFirstWaypoint, latestLocation, maximumCapacity, name, navigationStatus, remainingDistanceMeters, supportedTripTypes, vehicleState, vehicleType, waypoints, waypointsVersion

BetaVehicleNavigationStatus constants

Constants: ARRIVED_AT_DESTINATION, ENROUTE_TO_DESTINATION, NO_GUIDANCE, OFF_ROUTE, UNKNOWN_NAVIGATION_STATUS

BetaVehicleState constants

Constants: OFFLINE, ONLINE, UNKNOWN_VEHICLE_STATE

BetaVehicleType constants

Constants: AUTO, TAXI, TRUCK, TWO_WHEELER, UNKNOWN

BetaTripType constants

Constants: EXCLUSIVE, SHARED, UNKNOWN_TRIP_TYPE

BetaTripWaypoint interface

Properties: distanceMeters, durationMillis, location, path, speedReadingIntervals, tripId, waypointType

BetaWaypointType constants

Constants: DROP_OFF_WAYPOINT_TYPE, INTERMEDIATE_DESTINATION_WAYPOINT_TYPE, PICKUP_WAYPOINT_TYPE, UNKNOWN_WAYPOINT_TYPE

TimeWindow interface

Properties: endTime, startTime

Speed constants

Constants: NORMAL, SLOW, TRAFFIC_JAM

SpeedReadingInterval interface

Properties: endPolylinePointIndex, speed, startPolylinePointIndex

Trip and Order Progress

FleetEngineTripLocationProvider class

Static Methods: TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION, TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION

Properties: tripId

Methods: refresh

Events: error, update

FleetEngineTripLocationProviderOptions interface

Properties: activePolylineCustomization, authTokenFetcher, destinationMarkerCustomization, originMarkerCustomization, pollingIntervalMillis, projectId, remainingPolylineCustomization, takenPolylineCustomization, tripId, vehicleMarkerCustomization, waypointMarkerCustomization

FleetEngineTripLocationProviderUpdateEvent interface

Properties: trip

Fleet Tracking - Last Mile Fleet

FleetEngineDeliveryVehicleLocationProvider class

Properties: deliveryVehicleId, shouldShowOutcomeLocations, shouldShowTasks, staleLocationThresholdMillis, taskFilterOptions

Events: error, update

FleetEngineDeliveryVehicleLocationProviderOptions interface

Properties: activePolylineCustomization, authTokenFetcher, deliveryVehicleId, deliveryVehicleMarkerCustomization, plannedStopMarkerCustomization, pollingIntervalMillis, projectId, remainingPolylineCustomization, shouldShowOutcomeLocations, shouldShowTasks, staleLocationThresholdMillis, takenPolylineCustomization, taskFilterOptions, taskMarkerCustomization, taskOutcomeMarkerCustomization

FleetEngineTaskFilterOptions interface

Properties: completionTimeFrom, completionTimeTo, state

FleetEngineDeliveryVehicleLocationProviderUpdateEvent interface

Properties: completedVehicleJourneySegments, deliveryVehicle, tasks

FleetEngineDeliveryFleetLocationProvider class

Properties: deliveryVehicleFilter, locationRestriction, staleLocationThresholdMillis

Events: update

FleetEngineDeliveryFleetLocationProviderOptions interface

Properties: authTokenFetcher, deliveryVehicleFilter, deliveryVehicleMarkerCustomization, locationRestriction, projectId, staleLocationThresholdMillis

FleetEngineDeliveryFleetLocationProviderUpdateEvent interface

Properties: deliveryVehicles

Fleet Tracking - On Demand Rides & Delivery (beta)

BetaFleetEngineVehicleLocationProvider class

Static Methods: TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION, TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION

Properties: staleLocationThresholdMillis, vehicleId

Events: error, update

BetaFleetEngineVehicleLocationProviderOptions interface

Properties: activePolylineCustomization, authTokenFetcher, destinationMarkerCustomization, intermediateDestinationMarkerCustomization, originMarkerCustomization, pollingIntervalMillis, projectId, remainingPolylineCustomization, staleLocationThresholdMillis, takenPolylineCustomization, vehicleId, vehicleMarkerCustomization

BetaFleetEngineVehicleLocationProviderUpdateEvent interface

Properties: trips, vehicle

BetaFleetEngineFleetLocationProvider class

Properties: locationRestriction, staleLocationThresholdMillis, vehicleFilter

Events: update

BetaFleetEngineFleetLocationProviderOptions interface

Properties: authTokenFetcher, locationRestriction, projectId, staleLocationThresholdMillis, vehicleFilter, vehicleMarkerCustomization

BetaFleetEngineFleetLocationProviderUpdateEvent interface

Properties: vehicles

Shipment Tracking

FleetEngineShipmentLocationProvider class

Properties: trackingId

Methods: refresh

Events: error, update

FleetEngineShipmentLocationProviderOptions interface

Properties: activePolylineCustomization, authTokenFetcher, deliveryVehicleMarkerCustomization, destinationMarkerCustomization, pollingIntervalMillis, projectId, remainingPolylineCustomization, takenPolylineCustomization, trackingId

FleetEngineShipmentLocationProviderUpdateEvent interface

Properties: taskTrackingInfo

Local Context (beta)

Map View

BetaLocalContextMapView class

Properties: directionsOptions, element, isTransitioningMapBounds, locationBias, locationRestriction, maxPlaceCount, placeTypePreferences

Methods: addListener, hidePlaceDetailsView, search

Events: error, placedetailsviewhidestart, placedetailsviewshowstart

BetaLocalContextMapViewOptions interface

Properties: directionsOptions, element, locationBias, locationRestriction, map, maxPlaceCount, pinOptionsSetup, placeChooserViewSetup, placeDetailsViewSetup, placeTypePreferences

BetaPlaceTypePreference typedef
BetaMapDirectionsOptions class

Methods: addListener

BetaMapDirectionsOptionsLiteral interface

Properties: origin

BetaPinOptions interface

Properties: background, glyphColor, scale

PlaceChooserViewSetupOptions interface

Properties: layoutMode, position

BetaPlaceChooserLayoutMode constants

Constants: HIDDEN, SHEET

BetaPlaceChooserPosition constants

Constants: BLOCK_END, INLINE_END, INLINE_START

PlaceDetailsViewSetupOptions interface

Properties: hidesOnMapClick, layoutMode, position

BetaPlaceDetailsLayoutMode constants

Constants: INFO_WINDOW, SHEET

BetaPlaceDetailsPosition constants

Constants: INLINE_END, INLINE_START