3D Maps Stay organized with collections Save and categorize content based on your preferences.
Map3DElementclass
google.maps.maps3d.Map3DElementclass
Map3DElement is an HTML interface for the 3D Map view. Note that themode must be set for the 3D Map to start rendering.
Custom element:<gmp-map-3d center="lat,lng,altitude" default-ui-hidden description="string" gesture-handling="auto" heading="number" internal-usage-attribution-ids="id1 id2" map-id="string" max-altitude="number" max-heading="number" max-tilt="number" min-altitude="number" min-heading="number" min-tilt="number" mode="hybrid" range="number" roll="number" tilt="number" default-ui-disabled></gmp-map-3d>
This class extendsHTMLElement.
This class implementsMap3DElementOptions.
Access by callingconst {Map3DElement} = await google.maps.importLibrary("maps3d").
SeeLibraries in the Maps JavaScript API.
Constructor | |
|---|---|
Map3DElement | Map3DElement([options])Parameters:
|
Properties | |
|---|---|
bounds | Type: LatLngBounds|LatLngBoundsLiteraloptionalWhen set, restricts the position of the camera within the specified lat/lng bounds. Note that objects outside the bounds are still rendered. Bounds can restrict both longitude and latitude, or can restrict either latitude or longitude only. For latitude-only bounds use west and east longitudes of -180 and180, respectively. For longitude-only bounds use north and south latitudes of90 and-90, respectively. |
center | Type: LatLngAltitude|LatLngAltitudeLiteraloptionalThe center of the map given as a LatLngAltitude, where altitude is in meters above ground level. Note that this is not necessarily where the camera is located, as the range field affects the camera's distance from the map center. If not set, defaults to{lat: 0, lng: 0, altitude: 63170000}. 63170000 meters is a maximum allowed altitude (Earth radius multiplied by 10).HTML attribute:
|
defaultUIHidden | Type: booleanoptionalDefault: falseWhen true, all default UI buttons are hidden.HTML attribute:
|
description | Type: stringoptionalIf provided, an accessibility description (e.g. for use with screen readers) will be added to the map with the provided value. HTML attribute:
|
gestureHandling | Type: GestureHandlingoptionalDefault: GestureHandling.GREEDYControls cooperative gesture handling. When set to COOPERATIVE, modifier keys or two-finger gestures are required to scroll the map. When set toGREEDY, the host page cannot be scrolled from user events on the map element. When set toAUTO, the gesture handling is determined by the scrollability of the host page.HTML attribute:
|
heading | Type: numberoptionalThe compass heading of the map, in degrees, where due north is zero. When there is no tilt, any roll will be interpreted as heading. HTML attribute:
|
internalUsageAttributionIds | Type: Iterable<string>optionalAdds a usage attribution ID to the initializer, which helps Google understand which libraries and samples are helpful to developers, such as usage of a marker clustering library. To opt out of sending the usage attribution ID, it is safe to delete this property. Only unique values will be sent. Changes to this value after instantiation may be ignored. HTML attribute:
|
language | Type: stringoptionalLanguage in which to attempt to render the base map's language. Will default to the language requested by the developer when loading the Maps JS API. This must be set when the element is created, and cannot be updated after the map has loaded. |
mapId | Type: stringoptionalSpecifies a map ID which will be used to fetch cloud-based map style for the map. This should not be set after the map has been initialized. Therefore we ensure the mapId is only set during initialization and do not publish this attribute to public-facing channels. HTML attribute:
|
maxAltitude | Type: numberoptionalThe maximum altitude above the ground which will be displayed on the map. A valid value is between 0 and63170000 meters (Earth radius multiplied by 10).HTML attribute:
|
maxHeading | Type: numberoptionalThe maximum angle of heading (rotation) of the map. A valid value is between 0 and360 degrees.minHeading andmaxHeading represent an interval of <=360 degrees in which heading gestures will be allowed.minHeading = 180 andmaxHeading = 90 will allow heading in[0, 90] and heading in[180, 360].minHeading = 90 andmaxHeading = 180 will allow heading in[90, 180].HTML attribute:
|
maxTilt | Type: numberoptionalThe maximum angle of incidence of the map. A valid value is between 0 and90 degrees.HTML attribute:
|
minAltitude | Type: numberoptionalThe minimum altitude above the ground which will be displayed on the map. A valid value is between 0 and63170000 meters (Earth radius multiplied by 10).HTML attribute:
|
minHeading | Type: numberoptionalThe minimum angle of heading (rotation) of the map. A valid value is between 0 and360 degrees.minHeading andmaxHeading represent an interval of <=360 degrees in which heading gestures will be allowed.minHeading = 180 andmaxHeading = 90 will allow heading in[0, 90] and heading in[180, 360].minHeading = 90 andmaxHeading = 180 will allow heading in[90, 180].HTML attribute:
|
minTilt | Type: numberoptionalThe minimum angle of incidence of the map. A valid value is between 0 and90 degrees.HTML attribute:
|
mode | Type: MapModeoptionalSpecifies a mode the map should be rendered in. If not set, the map won't be rendered. HTML attribute:
|
range | Type: numberoptionalThe distance from camera to the center of the map, in meters. HTML attribute:
|
region | Type: stringoptionalRegion with which to attempt to render the base map's POIs. Will default to the region requested by the developer when loading the Maps JS API. This must be set when the element is created, and cannot be updated after the map has loaded. |
roll | Type: numberoptionalThe roll of the camera around the view vector in degrees. To resolve ambiguities, when there is no tilt, any roll will be interpreted as heading. HTML attribute:
|
tilt | Type: numberoptionalThe tilt of the camera's view vector in degrees. A view vector looking directly down at the earth would have a tilt of zero degrees. A view vector pointing away from the earth would have a tilt of 180 degrees.HTML attribute:
|
| Deprecated: Please use Type: booleanoptionalDefault: falseWhen true, all default UI buttons are disabled. Does not disable the keyboard and gesture controls.HTML attribute:
|
Methods | |
|---|---|
addEventListener | addEventListener(type, listener[, options])Parameters:
Return Value: voidSets up a function that will be called whenever the specified event is delivered to the target. SeeaddEventListener. |
flyCameraAround | flyCameraAround(options)Parameters:
Return Value: None This method orbits the camera around a given location for a given duration. The animation can be repeated by the given number of FlyAroundAnimationOptions.repeatCount times.The camera will move in a clockwise direction. The method is asynchronous because animations can only start after the map has loaded a minimum amount. The method returns once the animation has been started. If the number of FlyAroundAnimationOptions.repeatCount times is zero, no spin will occur, and the animation will complete immediately after it starts. |
flyCameraTo | flyCameraTo(options)Parameters:
Return Value: None This method moves the camera parabolically from the current location to a given end location over a given duration. The method is asynchronous because animations can only start after the map has loaded a minimum amount. The method returns once the animation has been started. |
removeEventListener | removeEventListener(type, listener[, options])Parameters:
Return Value: voidRemoves an event listener previously registered with addEventListener from the target. SeeremoveEventListener. |
stopCameraAnimation | stopCameraAnimation()Parameters: None Return Value: None This method stops any fly animation that might happen to be running. The camera stays wherever it is mid-animation; it does not teleport to the end point. The method is asynchronous because animations can only start or stop after the map has loaded a minimum amount. The method returns once the animation has stopped. |
Events | |
|---|---|
gmp-animationend | function(animationEndEvent)Arguments:
This event is fired when the fly animation ends. This event bubbles up through the DOM tree. |
gmp-centerchange | function(centerChangeEvent)Arguments:
This event is fired when the Map3DElement's center property changes. |
gmp-click | function(clickEvent)Arguments:
This event is fired when the Map3DElement element is clicked. |
gmp-error | function(mapInitializationErrorEvent)Arguments:
This event is fired when the map fails to initialize. |
gmp-headingchange | function(headingChangeEvent)Arguments:
This event is fired when the Map3DElement's heading property changes. |
gmp-map-id-error | function(mapIdErrorEvent)Arguments:
This event is fired when the Map3DElement's mapId property is invalid. |
gmp-rangechange | function(rangeChangeEvent)Arguments:
This event is fired when the Map3DElement's range property changes. |
gmp-rollchange | function(rollChangeEvent)Arguments:
This event is fired when the Map3DElement's roll property changes. |
gmp-steadychange | function(steadyChangeEvent)Arguments:
This event is fired when the steady state of Map3DElement changes. |
gmp-tiltchange | function(tiltChangeEvent)Arguments:
This event is fired when the Map3DElement's tilt property changes. |
Map3DElementOptionsinterface
google.maps.maps3d.Map3DElementOptionsinterface
Map3DElementOptions object used to define the properties that can be set on a Map3DElement.
Properties | |
|---|---|
boundsoptional | Type: LatLngBounds|LatLngBoundsLiteraloptional |
centeroptional | Type: LatLngAltitude|LatLngAltitudeLiteraloptional |
| Deprecated: Please use Type: booleanoptional |
defaultUIHiddenoptional | Type: booleanoptional |
descriptionoptional | Type: stringoptional |
gestureHandlingoptional | Type: GestureHandlingoptional |
headingoptional | Type: numberoptional |
internalUsageAttributionIdsoptional | Type: Iterable<string>optional |
languageoptional | Type: stringoptional |
mapIdoptional | Type: stringoptional |
maxAltitudeoptional | Type: numberoptional |
maxHeadingoptional | Type: numberoptional |
maxTiltoptional | Type: numberoptional |
minAltitudeoptional | Type: numberoptional |
minHeadingoptional | Type: numberoptional |
minTiltoptional | Type: numberoptional |
modeoptional | Type: MapModeoptional |
rangeoptional | Type: numberoptional |
regionoptional | Type: stringoptional |
rolloptional | Type: numberoptional |
tiltoptional | Type: numberoptional |
MapModeconstants
google.maps.maps3d.MapModeconstants
Specifies a mode the map should be rendered in.
Access by callingconst {MapMode} = await google.maps.importLibrary("maps3d").
SeeLibraries in the Maps JavaScript API.
Constants | |
|---|---|
HYBRID | This map mode displays a transparent layer of major streets on satellite, or photorealistic imagery. |
SATELLITE | This map mode displays satellite, or photorealistic imagery where available. |
GestureHandlingconstants
google.maps.maps3d.GestureHandlingconstants
Specifies how gesture events should be handled on the map element.
Access by callingconst {GestureHandling} = await google.maps.importLibrary("maps3d").
SeeLibraries in the Maps JavaScript API.
Constants | |
|---|---|
AUTO | This lets the map choose whether to use cooperative or greedy gesture handling. This is the default behavior if not specified. This will cause the map to enter cooperative mode if the map is dominating its scroll parent (usually the host page) to where the user cannot scroll away from the map to other content. |
COOPERATIVE | This forces cooperative mode, where modifier keys or two-finger gestures are required to scroll the map. |
GREEDY | This forces greedy mode, where the host page cannot be scrolled from user events on the map element. |
FlyAroundAnimationOptionsinterface
google.maps.maps3d.FlyAroundAnimationOptionsinterface
Customization options for the FlyCameraAround Animation.
Properties | |
|---|---|
camera | Type: CameraOptionsThe central point at which the camera should look at during the orbit animation. Note that the map heading will change as the camera orbits around this center point. |
durationMillisoptional | Type: numberoptionalThe duration of one animation cycle in milliseconds. |
repeatCountoptional | Type: numberoptionalSpecifies the number of times an animation should repeat. If the number is zero, the animation will complete immediately after it starts. |
| Deprecated: Please use Type: numberoptionalThe number of rounds to rotate around the center in the given duration. This controls the overall speed of rotation. Passing a negative number to rounds will cause the camera to rotate in a counter-clockwise direction instead of the default clockwise direction. |
FlyToAnimationOptionsinterface
google.maps.maps3d.FlyToAnimationOptionsinterface
Customization options for the FlyCameraTo Animation.
Properties | |
|---|---|
endCamera | Type: CameraOptionsThe location at which the camera should point at the end of the animation. |
durationMillisoptional | Type: numberoptionalThe duration of the animation in milliseconds. A duration of 0 will teleport the camera straight to the end position. |
CameraOptionsinterface
google.maps.maps3d.CameraOptionsinterface
CameraOptions object used to define the properties that can be set on a camera object. The camera object can be anything that has a camera position, e.g. a current map state, or a future requested animation state.
Properties | |
|---|---|
centeroptional | Type: LatLngAltitude|LatLngAltitudeLiteraloptional |
headingoptional | Type: numberoptional |
rangeoptional | Type: numberoptional |
rolloptional | Type: numberoptional |
tiltoptional | Type: numberoptional |
SteadyChangeEventclass
google.maps.maps3d.SteadyChangeEventclass
This event is created from monitoring a steady state ofMap3DElement. This event bubbles up through the DOM tree.
This class extendsEvent.
Access by callingconst {SteadyChangeEvent} = await google.maps.importLibrary("maps3d").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
isSteady | Type: booleanIndicates whether Map3DElement is steady (i.e. all rendering for the current scene has completed) or not. |
LocationClickEventclass
google.maps.maps3d.LocationClickEventclass
This event is created from clicking a Map3DElement.
This class extendsEvent.
Access by callingconst {LocationClickEvent} = await google.maps.importLibrary("maps3d").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
position | Type: LatLngAltitudeoptionalThe latitude/longitude/altitude that was below the cursor when the event occurred. Please note, that at coarser levels, less accurate data will be returned. Also, sea floor elevation may be returned for the altitude value when clicking at the water surface from higher camera positions. This event bubbles up through the DOM tree. |
PlaceClickEventclass
google.maps.maps3d.PlaceClickEventclass
This event is created from clicking on a place icon on aMap3DElement. To prevent the default popover from showing up, call thepreventDefault() method on this event to prevent it being handled by theMap3DElement.
This class extendsLocationClickEvent.
Access by callingconst {PlaceClickEvent} = await google.maps.importLibrary("maps3d").
SeeLibraries in the Maps JavaScript API.
Properties | |
|---|---|
placeId | Type: stringThe place id of the map feature. |
Inherited:position | |
Methods | |
|---|---|
fetchPlace | fetchPlace()Parameters: None Fetches a Place for this place id. In the resultingPlace object, the id property will be populated. Additional fields can be subsequently requested viaPlace.fetchFields() subject to normal Places API enablement and billing. The promise is rejected if there was an error fetching thePlace. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-21 UTC.