3D Maps Stay organized with collections Save and categorize content based on your preferences.
Map3DElementclass
google.maps.maps3d.Map3DElement
class
Notice: Available only in thev=beta channel.
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-disabled heading="number" internal-usage-attribution-ids="id1 id2" 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"></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|LatLngBoundsLiteraloptional When 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|LatLngAltitudeLiteraloptional The 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:
|
defaultUIDisabled | Type: booleanoptional Default: false When true , all default UI buttons are disabled. Does not disable the keyboard and gesture controls.HTML attribute:
|
heading | Type: numberoptional The 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>optional Adds 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:
|
maxAltitude | Type: numberoptional The 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: numberoptional The 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: numberoptional The maximum angle of incidence of the map. A valid value is between 0 and90 degrees.HTML attribute:
|
minAltitude | Type: numberoptional The 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: numberoptional The 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: numberoptional The minimum angle of incidence of the map. A valid value is between 0 and90 degrees.HTML attribute:
|
mode | Type: MapModeoptional Specifies a mode the map should be rendered in. If not set, the map won't be rendered. HTML attribute:
|
range | Type: numberoptional The distance from camera to the center of the map, in meters. HTML attribute:
|
roll | Type: numberoptional The 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: numberoptional The 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:
|
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-headingchange | function(headingChangeEvent) Arguments:
This event is fired when the Map3DElement's heading property changes. |
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.Map3DElementOptions
interface
Notice: Available only in thev=beta channel.
Map3DElementOptions object used to define the properties that can be set on a Map3DElement.
Properties | |
---|---|
boundsoptional | Type: LatLngBounds|LatLngBoundsLiteraloptional |
centeroptional | Type: LatLngAltitude|LatLngAltitudeLiteraloptional |
defaultUIDisabledoptional | Type: booleanoptional |
headingoptional | Type: numberoptional |
internalUsageAttributionIdsoptional | Type: Iterable<string>optional |
maxAltitudeoptional | Type: numberoptional |
maxHeadingoptional | Type: numberoptional |
maxTiltoptional | Type: numberoptional |
minAltitudeoptional | Type: numberoptional |
minHeadingoptional | Type: numberoptional |
minTiltoptional | Type: numberoptional |
modeoptional | Type: MapModeoptional |
rangeoptional | Type: numberoptional |
rolloptional | Type: numberoptional |
tiltoptional | Type: numberoptional |
MapModeconstants
google.maps.maps3d.MapMode
constants
Notice: Available only in thev=beta channel.
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. |
FlyAroundAnimationOptionsinterface
google.maps.maps3d.FlyAroundAnimationOptions
interface
Notice: Available only in thev=beta channel.
Customization options for the FlyCameraAround Animation.
Properties | |
---|---|
camera | Type: CameraOptions The 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: numberoptional The duration of the animation in milliseconds. This is the total duration of the animation, not the duration of a single rotation. |
roundsoptional | Type: numberoptional The 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.FlyToAnimationOptions
interface
Notice: Available only in thev=beta channel.
Customization options for the FlyCameraTo Animation.
Properties | |
---|---|
endCamera | Type: CameraOptions The location at which the camera should point at the end of the animation. |
durationMillisoptional | Type: numberoptional The duration of the animation in milliseconds. A duration of 0 will teleport the camera straight to the end position. |
CameraOptionsinterface
google.maps.maps3d.CameraOptions
interface
Notice: Available only in thev=beta channel.
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.SteadyChangeEvent
class
Notice: Available only in thev=beta channel.
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: boolean Indicates whether Map3DElement is steady (i.e. all rendering for the current scene has completed) or not. |
LocationClickEventclass
google.maps.maps3d.LocationClickEvent
class
Notice: Available only in thev=beta channel.
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: LatLngAltitudeoptional The 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.PlaceClickEvent
class
Notice: Available only in thev=beta channel.
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: string The 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 . |
Marker3DElementclass
google.maps.maps3d.Marker3DElement
class
Notice: Available only in thev=beta channel.
Shows a position on a 3D map. Note that theposition
must be set for theMarker3DElement
to display.
Custom element:<gmp-marker-3d altitude-mode="absolute" collision-behavior="required" draws-when-occluded extruded label="string" position="lat,lng" size-preserved z-index="number"></gmp-marker-3d>
This class extendsHTMLElement
.
This class implementsMarker3DElementOptions
.
Access by callingconst {Marker3DElement} = await google.maps.importLibrary("maps3d")
.
SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
Marker3DElement | Marker3DElement([options]) Parameters:
Creates an Marker3DElement with the options specified. |
Properties | |
---|---|
altitudeMode | Type: AltitudeModeoptional Default: AltitudeMode.CLAMP_TO_GROUND Specifies how the altitude component of the position is interpreted. HTML attribute:
|
collisionBehavior | Type: CollisionBehavioroptional Default: CollisionBehavior.REQUIRED An enumeration specifying how a Marker3DElement should behave when it collides with another Marker3DElement or with the basemap labels. HTML attribute:
|
drawsWhenOccluded | Type: booleanoptional Default: false Specifies whether this marker should be drawn or not when it's occluded. The marker can be occluded by map geometry (e.g. buildings). HTML attribute:
|
extruded | Type: booleanoptional Default: false Specifies whether to connect the marker to the ground. To extrude a marker, the altitudeMode must be eitherRELATIVE_TO_GROUND orABSOLUTE .HTML attribute:
|
label | Type: stringoptional Text to be displayed by this marker. HTML attribute:
|
position | Type: LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteraloptional The location of the tip of the marker. Altitude is ignored in certain modes and thus optional. HTML attribute:
|
sizePreserved | Type: booleanoptional Default: false Specifies whether this marker should preserve its size or not regardless of distance from camera. By default, the marker is scaled based on distance from camera/tilt. HTML attribute:
|
zIndex | Type: numberoptional The zIndex compared to other markers. HTML attribute:
|
Slots | |
---|---|
default | Any custom elements directly added to the Marker3DElement will be slotted, however only elements ofHTMLImageElement ,SVGElement andPinElement types will be used for drawing markers, other elements will be ignored.HTMLImageElement andSVGElement must be wrapped in<template> element before assigning to theMarker3DElement 's default slot.Images and SVGs are currently rasterized before they are rendered in the 3D scene, so custom HTML embedded into SVG or CSS classes added to images won't be applied and might not be reflected when markers are displayed on the screen. |
Marker3DElementOptionsinterface
google.maps.maps3d.Marker3DElementOptions
interface
Notice: Available only in thev=beta channel.
Marker3DElementOptions object used to define the properties that can be set on a Marker3DElement.
Properties | |
---|---|
altitudeModeoptional | Type: AltitudeModeoptional |
collisionBehavioroptional | Type: CollisionBehavioroptional |
drawsWhenOccludedoptional | Type: booleanoptional |
extrudedoptional | Type: booleanoptional |
labeloptional | Type: stringoptional |
positionoptional | Type: LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteraloptional |
sizePreservedoptional | Type: booleanoptional |
zIndexoptional | Type: numberoptional |
Marker3DInteractiveElementclass
google.maps.maps3d.Marker3DInteractiveElement
class
Notice: Available only in thev=beta channel.
Shows a position on a 3D map. Note that theposition
must be set for theMarker3DInteractiveElement
to display. UnlikeMarker3DElement
,Marker3DInteractiveElement
receives agmp-click
event.
Custom element:<gmp-marker-3d-interactive gmp-popover-target="popover-id" title="string"></gmp-marker-3d-interactive>
This class extendsMarker3DElement
.
This class implementsMarker3DInteractiveElementOptions
.
Access by callingconst {Marker3DInteractiveElement} = await google.maps.importLibrary("maps3d")
.
SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
Marker3DInteractiveElement | Marker3DInteractiveElement([options]) Parameters:
Creates an Marker3DInteractiveElement with the options specified. |
Properties | |
---|---|
gmpPopoverTargetElement | Type: PopoverElementoptional When set, the popover element will be open on this marker's click. HTML attribute:
|
title | Type: string Rollover text. If provided, an accessibility text (e.g. for use with screen readers) will be added to the Marker3DInteractiveElement with the provided value.HTML attribute:
|
Inherited:altitudeMode ,collisionBehavior ,drawsWhenOccluded ,extruded ,label ,position ,sizePreserved ,zIndex |
Slots | |
---|---|
default | Any custom elements directly added to the Marker3DInteractiveElement will be slotted, however only elements ofPinElement 's type will be used for drawing markers, other elements will be ignored. |
Events | |
---|---|
gmp-click | function(clickEvent) Arguments:
This event is fired when the Marker3DInteractiveElement element is clicked. |
Marker3DInteractiveElementOptionsinterface
google.maps.maps3d.Marker3DInteractiveElementOptions
interface
Notice: Available only in thev=beta channel.
Marker3DInteractiveElementOptions object used to define the properties that can be set on a Marker3DInteractiveElement.
This interface extendsMarker3DElementOptions
.
Properties | |
---|---|
gmpPopoverTargetElementoptional | Type: PopoverElementoptional |
titleoptional | Type: stringoptional |
Inherited:altitudeMode ,collisionBehavior ,drawsWhenOccluded ,extruded ,label ,position ,sizePreserved ,zIndex |
Model3DElementclass
google.maps.maps3d.Model3DElement
class
Notice: Available only in thev=beta channel.
A 3D model which allows the rendering of gLTF models. Note that theposition
and thesrc
must be set for theModel3DElement
to display.
Core properties of thegLTF PBR should be supported. No extensions or extension properties are currently supported.
Custom element:<gmp-model-3d altitude-mode="absolute" orientation="heading,tilt,roll" position="lat,lng" scale="number" src="url"></gmp-model-3d>
This class extendsHTMLElement
.
This class implementsModel3DElementOptions
.
Access by callingconst {Model3DElement} = await google.maps.importLibrary("maps3d")
.
SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
Model3DElement | Model3DElement([options]) Parameters:
Creates an Model3DElement with the options specified. |
Properties | |
---|---|
altitudeMode | Type: AltitudeModeoptional Default: AltitudeMode.CLAMP_TO_GROUND Specifies how altitude in the position is interpreted. HTML attribute:
|
orientation | Type: Orientation3D|Orientation3DLiteraloptional Describes rotation of a 3D model's coordinate system to position the model on the 3D Map. Rotations are applied to the model in the following order: roll, tilt and then heading. HTML attribute:
|
position | Type: LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteraloptional Sets the Model3DElement 's position. Altitude is ignored in certain modes and thus optional.HTML attribute:
|
scale | Type: number|Vector3D|Vector3DLiteraloptional Default: 1 Scales the model along the x, y, and z axes in the model's coordinate space. HTML attribute:
|
src | Type: string|URLoptional Specifies the url of the 3D model. At this time, only models in the .glb format are supported.Any relative HTTP urls will be resolved to their corresponding absolute ones. Please note that If you're hosting your .glb model files on a different website or server than your main application, make sure to set up the correct CORS HTTP headers. This allows your application to securely access the model files from the other domain.HTML attribute:
|
Model3DElementOptionsinterface
google.maps.maps3d.Model3DElementOptions
interface
Notice: Available only in thev=beta channel.
Model3DElementOptions object used to define the properties that can be set on a Model3DElement.
Properties | |
---|---|
altitudeModeoptional | Type: AltitudeModeoptional |
orientationoptional | Type: Orientation3D|Orientation3DLiteraloptional |
positionoptional | Type: LatLngLiteral|LatLngAltitude|LatLngAltitudeLiteraloptional |
scaleoptional | Type: number|Vector3D|Vector3DLiteraloptional |
srcoptional | Type: string|URLoptional |
Model3DInteractiveElementclass
google.maps.maps3d.Model3DInteractiveElement
class
Notice: Available only in thev=beta channel.
A 3D model which allows the rendering of gLTF models. Note that theposition
and thesrc
must be set for theModel3DElement
to display.
Core properties of thegLTF PBR should be supported. No extensions or extension properties are currently supported.
UnlikeModel3DElement
,Model3DInteractiveElement
receives agmp-click
event.
Custom element:<gmp-model-3d-interactive></gmp-model-3d-interactive>
This class extendsModel3DElement
.
This class implementsModel3DInteractiveElementOptions
.
Access by callingconst {Model3DInteractiveElement} = await google.maps.importLibrary("maps3d")
.
SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
Model3DInteractiveElement | Model3DInteractiveElement([options]) Parameters:
Creates a Model3DInteractiveElement with the options specified. |
Properties | |
---|---|
Inherited:altitudeMode ,orientation ,position ,scale ,src |
Events | |
---|---|
gmp-click | function(clickEvent) Arguments:
This event is fired when the Model3DInteractiveElement element is clicked. |
Model3DInteractiveElementOptionsinterface
google.maps.maps3d.Model3DInteractiveElementOptions
interface
Notice: Available only in thev=beta channel.
Model3DInteractiveElementOptions object used to define the properties that can be set on a Model3DInteractiveElement.
This interface extendsModel3DElementOptions
.
Properties | |
---|---|
Inherited:altitudeMode ,orientation ,position ,scale ,src |
Polyline3DElementclass
google.maps.maps3d.Polyline3DElement
class
Notice: Available only in thev=beta channel.
A 3D polyline is a linear overlay of connected line segments on a 3D map.
Custom element:<gmp-polyline-3d altitude-mode="absolute" draws-occluded-segments extruded geodesic outer-color="string" outer-width="number" stroke-color="string" stroke-width="number" z-index="number"></gmp-polyline-3d>
This class extendsHTMLElement
.
This class implementsPolyline3DElementOptions
.
Access by callingconst {Polyline3DElement} = await google.maps.importLibrary("maps3d")
.
SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
Polyline3DElement | Polyline3DElement([options]) Parameters:
Creates an Polyline3DElement with the options specified. |
Properties | |
---|---|
altitudeMode | Type: AltitudeModeoptional Default: AltitudeMode.CLAMP_TO_GROUND Specifies how altitude components in the coordinates are interpreted. HTML attribute:
|
coordinates | Type: Iterable<LatLngAltitude|LatLngAltitudeLiteral|LatLngLiteral>optional The ordered sequence of coordinates of the Polyline. Altitude is ignored in certain modes and thus optional. |
drawsOccludedSegments | Type: booleanoptional Default: false Specifies whether parts of the polyline which could be occluded are drawn or not. Polylines can be occluded by map geometry (e.g. buildings). HTML attribute:
|
extruded | Type: booleanoptional Default: false Specifies whether to connect the polyline to the ground. To extrude a polyline, the altitudeMode must be eitherRELATIVE_TO_GROUND orABSOLUTE .HTML attribute:
|
geodesic | Type: booleanoptional Default: false When true , edges of the polyline are interpreted as geodesic and will follow the curvature of the Earth. Whenfalse , edges of the polyline are rendered as straight lines in screen space.HTML attribute:
|
outerColor | Type: stringoptional The outer color. All CSS3 colors are supported. HTML attribute:
|
outerWidth | Type: numberoptional The outer width is between 0.0 and1.0 . This is a percentage of thestrokeWidth .HTML attribute:
|
strokeColor | Type: stringoptional The stroke color. All CSS3 colors are supported. HTML attribute:
|
strokeWidth | Type: numberoptional The stroke width in pixels. HTML attribute:
|
zIndex | Type: numberoptional The zIndex compared to other polys. HTML attribute:
|
Polyline3DElementOptionsinterface
google.maps.maps3d.Polyline3DElementOptions
interface
Notice: Available only in thev=beta channel.
Polyline3DElementOptions object used to define the properties that can be set on a Polyline3DElement.
Properties | |
---|---|
altitudeModeoptional | Type: AltitudeModeoptional |
coordinatesoptional | Type: Iterable<LatLngAltitude|LatLngAltitudeLiteral|LatLngLiteral>optional |
drawsOccludedSegmentsoptional | Type: booleanoptional |
extrudedoptional | Type: booleanoptional |
geodesicoptional | Type: booleanoptional |
outerColoroptional | Type: stringoptional |
outerWidthoptional | Type: numberoptional |
strokeColoroptional | Type: stringoptional |
strokeWidthoptional | Type: numberoptional |
zIndexoptional | Type: numberoptional |
Polyline3DInteractiveElementclass
google.maps.maps3d.Polyline3DInteractiveElement
class
Notice: Available only in thev=beta channel.
A 3D polyline is a linear overlay of connected line segments on a 3D map. UnlikePolyline3DElement
,Polyline3DInteractiveElement
receives agmp-click
event.
Custom element:<gmp-polyline-3d-interactive></gmp-polyline-3d-interactive>
This class extendsPolyline3DElement
.
This class implementsPolyline3DInteractiveElementOptions
.
Access by callingconst {Polyline3DInteractiveElement} = await google.maps.importLibrary("maps3d")
.
SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
Polyline3DInteractiveElement | Polyline3DInteractiveElement([options]) Parameters:
Creates a Polyline3DInteractiveElement with the options specified. |
Properties | |
---|---|
Inherited:altitudeMode ,coordinates ,drawsOccludedSegments ,extruded ,geodesic ,outerColor ,outerWidth ,strokeColor ,strokeWidth ,zIndex |
Events | |
---|---|
gmp-click | function(clickEvent) Arguments:
This event is fired when the Polyline3DInteractiveElement element is clicked. |
Polyline3DInteractiveElementOptionsinterface
google.maps.maps3d.Polyline3DInteractiveElementOptions
interface
Notice: Available only in thev=beta channel.
Polyline3DInteractiveElementOptions object used to define the properties that can be set on a Polyline3DInteractiveElement.
This interface extendsPolyline3DElementOptions
.
Properties | |
---|---|
Inherited:altitudeMode ,coordinates ,drawsOccludedSegments ,extruded ,geodesic ,outerColor ,outerWidth ,strokeColor ,strokeWidth ,zIndex |
Polygon3DElementclass
google.maps.maps3d.Polygon3DElement
class
Notice: Available only in thev=beta channel.
A 3D polygon (like a 3D polyline) defines a series of connected coordinates in an ordered sequence. Additionally, polygons form a closed loop and define a filled region.
Custom element:<gmp-polygon-3d altitude-mode="absolute" draws-occluded-segments extruded fill-color="string" geodesic stroke-color="string" stroke-width="number" z-index="number"></gmp-polygon-3d>
This class extendsHTMLElement
.
This class implementsPolygon3DElementOptions
.
Access by callingconst {Polygon3DElement} = await google.maps.importLibrary("maps3d")
.
SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
Polygon3DElement | Polygon3DElement([options]) Parameters:
Creates an Polygon3DElement with the options specified. |
Properties | |
---|---|
altitudeMode | Type: AltitudeModeoptional Default: AltitudeMode.CLAMP_TO_GROUND Specifies how altitude components in the coordinates are interpreted. HTML attribute:
|
drawsOccludedSegments | Type: booleanoptional Default: false Specifies whether parts of the polygon which could be occluded are drawn or not. Polygons can be occluded by map geometry (e.g. buildings). HTML attribute:
|
extruded | Type: booleanoptional Default: false Specifies whether to connect the polygon to the ground. To extrude a polygon, the altitudeMode must be eitherRELATIVE_TO_GROUND orABSOLUTE .HTML attribute:
|
fillColor | Type: stringoptional The fill color. All CSS3 colors are supported. HTML attribute:
|
geodesic | Type: booleanoptional Default: false When true , edges of the polygon are interpreted as geodesic and will follow the curvature of the Earth. Whenfalse , edges of the polygon are rendered as straight lines in screen space.HTML attribute:
|
innerCoordinates | Type: Iterable<Iterable<LatLngAltitude|LatLngAltitudeLiteral|LatLngLiteral>>optional The ordered sequence of coordinates that designates a closed loop. Unlike polylines, a polygon may consist of one or more paths, which create multiple cut-outs inside the polygon. |
outerCoordinates | Type: Iterable<LatLngAltitude|LatLngAltitudeLiteral|LatLngLiteral>optional The ordered sequence of coordinates that designates a closed loop. Altitude is ignored in certain modes and thus optional. |
strokeColor | Type: stringoptional The stroke color. All CSS3 colors are supported. HTML attribute:
|
strokeWidth | Type: numberoptional The stroke width in pixels. HTML attribute:
|
zIndex | Type: numberoptional The zIndex compared to other polys. HTML attribute:
|
Polygon3DElementOptionsinterface
google.maps.maps3d.Polygon3DElementOptions
interface
Notice: Available only in thev=beta channel.
Polygon3DElementOptions object used to define the properties that can be set on a Polygon3DElement.
Properties | |
---|---|
altitudeModeoptional | Type: AltitudeModeoptional |
drawsOccludedSegmentsoptional | Type: booleanoptional |
extrudedoptional | Type: booleanoptional |
fillColoroptional | Type: stringoptional |
geodesicoptional | Type: booleanoptional |
innerCoordinatesoptional | Type: Iterable<Iterable<LatLngAltitude|LatLngAltitudeLiteral>|Iterable<LatLngLiteral>>optional |
outerCoordinatesoptional | Type: Iterable<LatLngAltitude|LatLngAltitudeLiteral|LatLngLiteral>optional |
strokeColoroptional | Type: stringoptional |
strokeWidthoptional | Type: numberoptional |
zIndexoptional | Type: numberoptional |
Polygon3DInteractiveElementclass
google.maps.maps3d.Polygon3DInteractiveElement
class
Notice: Available only in thev=beta channel.
A 3D polygon (like a 3D polyline) defines a series of connected coordinates in an ordered sequence. Additionally, polygons form a closed loop and define a filled region. UnlikePolygon3DElement
,Polygon3DInteractiveElement
receives agmp-click
event.
Custom element:<gmp-polygon-3d-interactive></gmp-polygon-3d-interactive>
This class extendsPolygon3DElement
.
This class implementsPolygon3DInteractiveElementOptions
.
Access by callingconst {Polygon3DInteractiveElement} = await google.maps.importLibrary("maps3d")
.
SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
Polygon3DInteractiveElement | Polygon3DInteractiveElement([options]) Parameters:
Creates a Polygon3DInteractiveElement with the options specified. |
Properties | |
---|---|
Inherited:altitudeMode ,drawsOccludedSegments ,extruded ,fillColor ,geodesic ,innerCoordinates ,outerCoordinates ,strokeColor ,strokeWidth ,zIndex |
Events | |
---|---|
gmp-click | function(clickEvent) Arguments:
This event is fired when the Polygon3DInteractiveElement element is clicked. |
Polygon3DInteractiveElementOptionsinterface
google.maps.maps3d.Polygon3DInteractiveElementOptions
interface
Notice: Available only in thev=beta channel.
Polygon3DInteractiveElementOptions object used to define the properties that can be set on a Polygon3DInteractiveElement.
This interface extendsPolygon3DElementOptions
.
Properties | |
---|---|
Inherited:altitudeMode ,drawsOccludedSegments ,extruded ,fillColor ,geodesic ,innerCoordinates ,outerCoordinates ,strokeColor ,strokeWidth ,zIndex |
PopoverElementclass
google.maps.maps3d.PopoverElement
class
Notice: Available only in thev=beta channel.
A custom HTML element that renders a popover. It looks like a bubble and is often connected to a marker.
Custom element:<gmp-popover altitude-mode="absolute" light-dismiss-disabled open position-anchor="lat,lng"></gmp-popover>
This class extendsHTMLElement
.
This class implementsPopoverElementOptions
.
Access by callingconst {PopoverElement} = await google.maps.importLibrary("maps3d")
.
SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
PopoverElement | PopoverElement([options]) Parameters:
|
Properties | |
---|---|
altitudeMode | Type: AltitudeModeoptional Default: AltitudeMode.CLAMP_TO_GROUND Specifies how the altitude component of the position is interpreted. HTML attribute:
|
lightDismissDisabled | Type: booleanoptional Default: false Specifies whether this popover should be "light dismissed" or not. The "light dismiss" behavior is similar to setting the popover="auto" attribute which is part of the browserPopover API.HTML attribute:
|
open | Type: booleanoptional Default: false Specifies whether this popover should be open or not. HTML attribute:
|
positionAnchor | Type: LatLngLiteral|LatLngAltitudeLiteral|Marker3DInteractiveElement|stringoptional The position at which to display this popover. If the popover is anchored to an interactive marker, the marker's position will be used instead. HTML attribute:
|
Slots | |
---|---|
default | Places the slotted content in the main section of the popover. |
header | Places the slotted content in the heading section of the popover. |
CSS Properties | |
---|---|
--gmp-popover-max-width | Maximum width of the popover, regardless of content's width. |
--gmp-popover-min-width | Minimum width of the popover, regardless of content's width. When using this property, it is strongly recommended to set it to a value less than the width of the map (in pixels). |
--gmp-popover-pixel-offset-x | The offset on the x-axis, in pixels, of the tip of the popover from the point on the map at whose geographical coordinates the popover is anchored. |
--gmp-popover-pixel-offset-y | The offset on the y-axis, in pixels, of the tip of the popover from the point on the map at whose geographical coordinates the popover is anchored. |
color-scheme | Indicates which color scheme this popover can be rendered in. See color-scheme documentation for more details. If not specified, it defaults to the user's color scheme preferences. |
PopoverElementOptionsinterface
google.maps.maps3d.PopoverElementOptions
interface
Notice: Available only in thev=beta channel.
PopoverElementOptions object used to define the properties that can be set on a PopoverElement.
Properties | |
---|---|
altitudeModeoptional | Type: AltitudeModeoptional |
lightDismissDisabledoptional | Type: booleanoptional |
openoptional | Type: booleanoptional |
positionAnchoroptional | Type: LatLngLiteral|LatLngAltitudeLiteral|string|Marker3DInteractiveElementoptional |
AltitudeModeconstants
google.maps.maps3d.AltitudeMode
constants
Notice: Available only in thev=beta channel.
Specifies how altitude components in the coordinates are interpreted.
Access by callingconst {AltitudeMode} = await google.maps.importLibrary("maps3d")
.
SeeLibraries in the Maps JavaScript API.
Constants | |
---|---|
ABSOLUTE | Allows to express objects relative to the average mean sea level. That also means that if the terrain level of detail changes underneath the object, its absolute position will remain the same. |
CLAMP_TO_GROUND | Allows to express objects placed on the ground. They will remain at ground level following the terrain regardless of what altitude is provided. If the object is positioned over a major body of water, it will be placed at sea level. |
RELATIVE_TO_GROUND | Allows to express objects relative to the ground surface. If the terrain level of detail changes, the position of the object will remain constant relative to the ground. When over water, the altitude will be interpreted as a value in meters above sea level. |
RELATIVE_TO_MESH | Allows to express objects relative to the highest of ground+building+water surface. When over water, this will be water surface; when over terrain, this will be the building surface (if present) or ground surface (if no buildings). |
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-07-18 UTC.