Data

Data class

google.maps.Data class

A layer for displaying geospatial data. Points, line-strings and polygons can be displayed.

EveryMaphas aDataobject by default, so most of the time there is no need to construct one. For example:

var myMap = new google.maps.Map(...);
myMap.data.addGeoJson(...);
myMap.data.setStyle(...);
TheDataobject is a collection ofFeatures.

This class extends MVCObject.

Access by callingconst {Data} = await google.maps.importLibrary( "maps" ).SeeLibraries in the Maps JavaScript API.

Data
Data([options])
Parameters:
Creates an empty collection, with the givenDataOptions.
add
add([feature])
Parameters:
Return Value:Data.Feature
Adds a feature to the collection, and returns the added feature.

If the feature has an ID, it will replace any existing feature in the collection with the same ID. If no feature is given, a new feature will be created with null geometry and no properties. IfFeatureOptionsare given, a new feature will be created with the specified properties.

Note that the IDs1234and'1234'are equivalent. Adding a feature with ID1234will replace a feature with ID'1234',and vice versa.

addGeoJson
addGeoJson(geoJson[, options])
Parameters:
Return Value:Array<Data.Feature>
Adds GeoJSON features to the collection. Give this method a parsed JSON. The imported features are returned. Throws an exception if the GeoJSON could not be imported.
contains
contains(feature)
Parameters:
Return Value:boolean
Checks whether the given feature is in the collection.
forEach
forEach(callback)
Parameters:
Return Value:None
Repeatedly invokes the given function, passing a feature in the collection to the function on each invocation. The order of iteration through the features is undefined.
getControlPosition
getControlPosition()
Parameters:None
Return Value:ControlPosition
Returns the position of the drawing controls on the map.
getControls
getControls()
Parameters:None
Return Value:Array<string>
Returns which drawing modes are available for the user to select, in the order they are displayed. This does not include thenulldrawing mode, which is added by default. Possible drawing modes are"Point","LineString"or"Polygon".
getDrawingMode
getDrawingMode()
Parameters:None
Return Value:string|null
Returns the current drawing mode of the given Data layer. A drawing mode ofnullmeans that the user can interact with the map as normal, and clicks do not draw anything. Possible drawing modes arenull,"Point","LineString"or"Polygon".
getFeatureById
getFeatureById(id)
Parameters:
  • id:number|string
Return Value:Data.Feature|undefined
Returns the feature with the given ID, if it exists in the collection. Otherwise returnsundefined.

Note that the IDs1234and'1234'are equivalent. Either can be used to look up the same feature.

getMap
getMap()
Parameters:None
Return Value:Map
Returns the map on which the features are displayed.
getStyle
getStyle()
Parameters:None
Gets the style for all features in the collection.
loadGeoJson
loadGeoJson(url[, options, callback])
Parameters:
Return Value:None
Loads GeoJSON from a URL, and adds the features to the collection.

NOTE: The GeoJSON is fetched using XHR, and may not work cross-domain. If you have issues, we recommend you fetch the GeoJSON using your choice of AJAX library, and then calladdGeoJson().

overrideStyle
overrideStyle(feature, style)
Parameters:
Return Value:None
Changes the style of a feature. These changes are applied on top of the style specified bysetStyle().Style properties set tonullrevert to the value specified viasetStyle().
remove
remove(feature)
Parameters:
Return Value:None
Removes a feature from the collection.
revertStyle
revertStyle([feature])
Parameters:
Return Value:None
Removes the effect of previousoverrideStyle()calls. The style of the given feature reverts to the style specified bysetStyle().

If no feature is given, all features have their style reverted.

setControlPosition
setControlPosition(controlPosition)
Parameters:
Return Value:None
Sets the position of the drawing controls on the map.
setControls
setControls(controls)
Parameters:
Return Value:None
Sets which drawing modes are available for the user to select, in the order they are displayed. This should not include thenulldrawing mode, which is added by default. Ifnull,drawing controls are disabled and not displayed. Possible drawing modes are"Point","LineString"or"Polygon".
setDrawingMode
setDrawingMode(drawingMode)
Parameters:
  • drawingMode:stringoptional
Return Value:None
Sets the current drawing mode of the given Data layer. A drawing mode ofnullmeans that the user can interact with the map as normal, and clicks do not draw anything. Possible drawing modes arenull,"Point","LineString"or"Polygon".
setMap
setMap(map)
Parameters:
Return Value:None
Renders the features on the specified map. If map is set tonull,the features will be removed from the map.
setStyle
setStyle(style)
Return Value:None
Sets the style for all features in the collection. Styles specified on a per-feature basis viaoverrideStyle()continue to apply.

Pass either an object with the desired style options, or a function that computes the style for each feature. The function will be called every time a feature's properties are updated.

toGeoJson
toGeoJson(callback)
Parameters:
  • callback:function(Object): void
Return Value:None
Exports the features in the collection to a GeoJSON object.
Inherited: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
addfeature
function(event)
Arguments:
This event is fired when a feature is added to the collection.
click
function(event)
Arguments:
This event is fired for a click on the geometry.
contextmenu
function(event)
Arguments:
This event is fired when the DOM contextmenu event is fired on the geometry.
dblclick
function(event)
Arguments:
This event is fired for a double click on the geometry.
mousedown
function(event)
Arguments:
This event is fired for a mousedown on the geometry.
mouseout
function(event)
Arguments:
This event is fired when the mouse leaves the area of the geometry.
mouseover
function(event)
Arguments:
This event is fired when the mouse enters the area of the geometry.
mouseup
function(event)
Arguments:
This event is fired for a mouseup on the geometry.
removefeature
function(event)
Arguments:
This event is fired when a feature is removed from the collection.
removeproperty
function(event)
Arguments:
This event is fired when a feature's property is removed.
setgeometry
function(event)
Arguments:
This event is fired when a feature's geometry is set.
setproperty
function(event)
Arguments:
This event is fired when a feature's property is set.
rightclick
function(event)
Arguments:
This event is fired for a rightclick on the geometry.

Data.DataOptions interface

google.maps.Data.DataOptions interface

DataOptions object used to define the properties that a developer can set on aDataobject.

map
Type:Map
Map on which to display the features in the collection.
controlPositionoptional
Type:ControlPositionoptional
The position of the drawing controls on the map.
controlsoptional
Type:Array<string>optional
Default:null
Describes which drawing modes are available for the user to select, in the order they are displayed. This should not include thenulldrawing mode, which is added by default. Ifnull,drawing controls are disabled and not displayed. Possible drawing modes are"Point","LineString"or"Polygon".
drawingModeoptional
Type:stringoptional
Default:null
The current drawing mode of the given Data layer. A drawing mode ofnullmeans that the user can interact with the map as normal, and clicks do not draw anything. Possible drawing modes arenull,"Point","LineString"or"Polygon".
featureFactoryoptional
Type:function(Data.Geometry):Data.Featureoptional
When drawing is enabled and a user draws a Geometry (a Point, Line String or Polygon), this function is called with that Geometry and should return a Feature that is to be added to the Data layer. If a featureFactory is not supplied, a Feature with no id and no properties will be created from that Geometry instead. Defaults tonull.
styleoptional
Style for all features in the collection. For more details, see thesetStyle()method above.

Data.GeoJsonOptions interface

google.maps.Data.GeoJsonOptions interface

Optional parameters for importing GeoJSON.

idPropertyNameoptional
Type:stringoptional
The name of the Feature property to use as the feature ID. If not specified, the GeoJSON Feature id will be used.

Data.StyleOptions interface

google.maps.Data.StyleOptions interface

These options specify the way a Feature should appear when displayed on a map.

animationoptional
Type:Animationoptional
The animation to play when marker is added to a map. Only applies to point geometries.
clickableoptional
Type:booleanoptional
Default:true
Iftrue,the marker receives mouse and touch events.
cursoroptional
Type:stringoptional
Mouse cursor to show on hover. Only applies to point geometries.
draggableoptional
Type:booleanoptional
Default:false
Iftrue,the object can be dragged across the map and the underlying feature will have its geometry updated.
editableoptional
Type:booleanoptional
Default:false
Iftrue,the object can be edited by dragging control points and the underlying feature will have its geometry updated. Only applies to LineString and Polygon geometries.
fillColoroptional
Type:stringoptional
The fill color. All CSS3 colors are supported except for extended named colors. Only applies to polygon geometries.
fillOpacityoptional
Type:numberoptional
The fill opacity between 0.0 and 1.0. Only applies to polygon geometries.
iconoptional
Type:string|Icon|Symboloptional
Icon for the foreground. If a string is provided, it is treated as though it were anIconwith the string asurl.Only applies to point geometries.
iconsoptional
Type:Array<IconSequence>optional
The icons to be rendered along a polyline. Only applies to line geometries.
labeloptional
Type:string|MarkerLabeloptional
Adds a label to the marker. The label can either be a string, or aMarkerLabelobject. Only applies to point geometries.
opacityoptional
Type:numberoptional
The marker's opacity between 0.0 and 1.0. Only applies to point geometries.
shapeoptional
Type:MarkerShapeoptional
Defines the image map used for hit detection. Only applies to point geometries.
strokeColoroptional
Type:stringoptional
The stroke color. All CSS3 colors are supported except for extended named colors. Only applies to line and polygon geometries.
strokeOpacityoptional
Type:numberoptional
The stroke opacity between 0.0 and 1.0. Only applies to line and polygon geometries.
strokeWeightoptional
Type:numberoptional
The stroke width in pixels. Only applies to line and polygon geometries.
titleoptional
Type:stringoptional
Rollover text. Only applies to point geometries.
visibleoptional
Type:booleanoptional
Default:true
Whether the feature is visible.
zIndexoptional
Type:numberoptional
All features are displayed on the map in order of their zIndex, with higher values displaying in front of features with lower values. Markers are always displayed in front of line-strings and polygons.

Data.StylingFunction typedef

google.maps.Data.StylingFunction typedef

A function that computes the appearance of a feature.

TheData.setStyle()method can accept a styling function. Use this when features should appear differently depending on their properties. You can find more information about styling features in thedeveloper's guide.

function(Data.Feature):Data.StyleOptions

Data.Feature class

google.maps.Data.Feature class

A feature has a geometry, an id, and a set of properties.

Access by callingconst {Data} = await google.maps.importLibrary( "maps" ).SeeLibraries in the Maps JavaScript API.

Data.Feature
Data.Feature([options])
Parameters:
Constructs a Feature with the given options.
forEachProperty
forEachProperty(callback)
Parameters:
  • callback:function(*, string): void
Return Value:None
Repeatedly invokes the given function, passing a property value and name on each invocation. The order of iteration through the properties is undefined.
getGeometry
getGeometry()
Parameters:None
Return Value:Data.Geometry
Returns the feature's geometry.
getId
getId()
Parameters:None
Return Value:number|string|undefined
Returns the feature ID.
getProperty
getProperty(name)
Parameters:
  • name:string
Return Value:*
Returns the value of the requested property, orundefinedif the property does not exist.
removeProperty
removeProperty(name)
Parameters:
  • name:string
Return Value:None
Removes the property with the given name.
setGeometry
setGeometry(newGeometry)
Parameters:
Return Value:None
Sets the feature's geometry.
setProperty
setProperty(name, newValue)
Parameters:
  • name:string
  • newValue:*
Return Value:None
Sets the value of the specified property. IfnewValueisundefinedthis is equivalent to callingremoveProperty.
toGeoJson
toGeoJson(callback)
Parameters:
  • callback:function(Object): void
Return Value:None
Exports the feature to a GeoJSON object.
removeproperty
function(event)
Arguments:
This event is triggered when a feature's property is removed.
setgeometry
function(event)
Arguments:
This event is triggered when a feature's geometry is set.
setproperty
function(event)
Arguments:
This event is triggered when a feature's property is set.

Data.FeatureOptions interface

google.maps.Data.FeatureOptions interface

Optional parameters for creatingData.Featureobjects.

geometryoptional
The feature geometry. If none is specified when a feature is constructed, the feature's geometry will benull.If aLatLngobject orLatLngLiteralis given, this will be converted to aData.Pointgeometry.
idoptional
Type:number|stringoptional
Feature ID is optional. If provided, it can be used to look up the feature in aDataobject using thegetFeatureById()method. Note that a feature's ID cannot be subsequently changed.
propertiesoptional
Type:Objectoptional
The feature properties. This is an arbitrary mapping of property names to values.

Data.Geometry interface

google.maps.Data.Geometry interface

A superclass for the various geometry objects.

forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback:function(LatLng): void
Return Value:None
Repeatedly invokes the given function, passing a point from the geometry to the function on each invocation.
getType
getType()
Parameters:None
Return Value:string
Returns the type of the geometry object. Possibilities are"Point","MultiPoint","LineString","MultiLineString","LinearRing","Polygon","MultiPolygon",or"GeometryCollection".

Data.Point class

google.maps.Data.Point class

A Point geometry contains a singleLatLng.

This class implements Data.Geometry.

Access by callingconst {Data} = await google.maps.importLibrary( "maps" ).SeeLibraries in the Maps JavaScript API.

Data.Point
Data.Point(latLng)
Parameters:
Constructs aData.Pointfrom the givenLatLngorLatLngLiteral.
forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback:function(LatLng): void
Return Value:None
get
get()
Parameters:None
Return Value:LatLng
Returns the containedLatLng.
getType
getType()
Parameters:None
Return Value:string
Returns the string"Point".

Data.MultiPoint class

google.maps.Data.MultiPoint class

A MultiPoint geometry contains a number ofLatLngs.

This class implements Data.Geometry.

Access by callingconst {Data} = await google.maps.importLibrary( "maps" ).SeeLibraries in the Maps JavaScript API.

Data.MultiPoint
Data.MultiPoint(elements)
Parameters:
Constructs aData.MultiPointfrom the givenLatLngs orLatLngLiterals.
forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback:function(LatLng): void
Return Value:None
getArray
getArray()
Parameters:None
Return Value:Array<LatLng>
Returns an array of the containedLatLngs. A new array is returned each timegetArray()is called.
getAt
getAt(n)
Parameters:
  • n:number
Return Value:LatLng
Returns then-th containedLatLng.
getLength
getLength()
Parameters:None
Return Value:number
Returns the number of containedLatLngs.
getType
getType()
Parameters:None
Return Value:string
Returns the string"MultiPoint".

Data.LineString class

google.maps.Data.LineString class

A LineString geometry contains a number ofLatLngs.

This class implements Data.Geometry.

Access by callingconst {Data} = await google.maps.importLibrary( "maps" ).SeeLibraries in the Maps JavaScript API.

Data.LineString
Data.LineString(elements)
Parameters:
Constructs aData.LineStringfrom the givenLatLngs orLatLngLiterals.
forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback:function(LatLng): void
Return Value:None
getArray
getArray()
Parameters:None
Return Value:Array<LatLng>
Returns an array of the containedLatLngs.A new array is returned each timegetArray()is called.
getAt
getAt(n)
Parameters:
  • n:number
Return Value:LatLng
Returns then-th containedLatLng.
getLength
getLength()
Parameters:None
Return Value:number
Returns the number of containedLatLngs.
getType
getType()
Parameters:None
Return Value:string
Returns the string"LineString".

Data.MultiLineString class

google.maps.Data.MultiLineString class

A MultiLineString geometry contains a number ofLineStrings.

This class implements Data.Geometry.

Access by callingconst {Data} = await google.maps.importLibrary( "maps" ).SeeLibraries in the Maps JavaScript API.

Data.MultiLineString
Data.MultiLineString(elements)
Constructs aData.MultiLineStringfrom the givenData.LineStrings or arrays of positions.
forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback:function(LatLng): void
Return Value:None
getArray
getArray()
Parameters:None
Return Value:Array<Data.LineString>
Returns an array of the containedData.LineStrings. A new array is returned each timegetArray()is called.
getAt
getAt(n)
Parameters:
  • n:number
Return Value:Data.LineString
Returns then-th containedData.LineString.
getLength
getLength()
Parameters:None
Return Value:number
Returns the number of containedData.LineStrings.
getType
getType()
Parameters:None
Return Value:string
Returns the string"MultiLineString".

Data.LinearRing class

google.maps.Data.LinearRing class

A LinearRing geometry contains a number ofLatLngs, representing a closed LineString. There is no need to make the firstLatLngequal to the lastLatLng.The LinearRing is closed implicitly.

This class implements Data.Geometry.

Access by callingconst {Data} = await google.maps.importLibrary( "maps" ).SeeLibraries in the Maps JavaScript API.

Data.LinearRing
Data.LinearRing(elements)
Parameters:
Constructs aData.LinearRingfrom the givenLatLngs orLatLngLiterals.
forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback:function(LatLng): void
Return Value:None
getArray
getArray()
Parameters:None
Return Value:Array<LatLng>
Returns an array of the containedLatLngs. A new array is returned each timegetArray()is called.
getAt
getAt(n)
Parameters:
  • n:number
Return Value:LatLng
Returns then-th containedLatLng.
getLength
getLength()
Parameters:None
Return Value:number
Returns the number of containedLatLngs.
getType
getType()
Parameters:None
Return Value:string
Returns the string"LinearRing".

Data.Polygon class

google.maps.Data.Polygon class

A Polygon geometry contains a number ofData.LinearRings. The first linear-ring must be the polygon exterior boundary and subsequent linear-rings must be interior boundaries, also known as holes. See thesample polygon with a hole.

This class implements Data.Geometry.

Access by callingconst {Data} = await google.maps.importLibrary( "maps" ).SeeLibraries in the Maps JavaScript API.

Data.Polygon
Data.Polygon(elements)
Constructs aData.Polygonfrom the givenData.LinearRings or arrays of positions.
forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback:function(LatLng): void
Return Value:None
getArray
getArray()
Parameters:None
Return Value:Array<Data.LinearRing>
Returns an array of the containedData.LinearRings. A new array is returned each timegetArray()is called.
getAt
getAt(n)
Parameters:
  • n:number
Return Value:Data.LinearRing
Returns then-th containedData.LinearRing.
getLength
getLength()
Parameters:None
Return Value:number
Returns the number of containedData.LinearRings.
getType
getType()
Parameters:None
Return Value:string
Returns the string"Polygon".

Data.MultiPolygon class

google.maps.Data.MultiPolygon class

A MultiPolygon geometry contains a number ofData.Polygons.

This class implements Data.Geometry.

Access by callingconst {Data} = await google.maps.importLibrary( "maps" ).SeeLibraries in the Maps JavaScript API.

Data.MultiPolygon
Data.MultiPolygon(elements)
Constructs aData.MultiPolygonfrom the givenData.Polygons or arrays of positions.
forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback:function(LatLng): void
Return Value:None
getArray
getArray()
Parameters:None
Return Value:Array<Data.Polygon>
Returns an array of the containedData.Polygons. A new array is returned each timegetArray()is called.
getAt
getAt(n)
Parameters:
  • n:number
Return Value:Data.Polygon
Returns then-th containedData.Polygon.
getLength
getLength()
Parameters:None
Return Value:number
Returns the number of containedData.Polygons.
getType
getType()
Parameters:None
Return Value:string
Returns the string"MultiPolygon".

Data.GeometryCollection class

google.maps.Data.GeometryCollection class

A GeometryCollection contains a number of geometry objects. AnyLatLngorLatLngLiteralobjects are automatically converted toData.Pointgeometry objects.

This class implements Data.Geometry.

Access by callingconst {Data} = await google.maps.importLibrary( "maps" ).SeeLibraries in the Maps JavaScript API.

Data.GeometryCollection
Data.GeometryCollection(elements)
Parameters:
Constructs aData.GeometryCollectionfrom the given geometry objects orLatLngs.
forEachLatLng
forEachLatLng(callback)
Parameters:
  • callback:function(LatLng): void
Return Value:None
getArray
getArray()
Parameters:None
Return Value:Array<Data.Geometry>
Returns an array of the contained geometry objects. A new array is returned each timegetArray()is called.
getAt
getAt(n)
Parameters:
  • n:number
Return Value:Data.Geometry
Returns then-th contained geometry object.
getLength
getLength()
Parameters:None
Return Value:number
Returns the number of contained geometry objects.
getType
getType()
Parameters:None
Return Value:string
Returns the string"GeometryCollection".

Data.MouseEvent interface

google.maps.Data.MouseEvent interface

This object is passed to mouse event handlers on aDataobject.

This interface extends MapMouseEvent.

feature
The feature which generated the mouse event.
Inherited: domEvent, latLng
Inherited: stop

Data.AddFeatureEvent interface

google.maps.Data.AddFeatureEvent interface

The properties of aaddfeatureevent.

feature
The feature that was added to theFeatureCollection.

Data.RemoveFeatureEvent interface

google.maps.Data.RemoveFeatureEvent interface

The properties of aremovefeatureevent.

feature
The feature that was removed from theFeatureCollection.

Data.SetGeometryEvent interface

google.maps.Data.SetGeometryEvent interface

The properties of asetgeometryevent.

feature
The feature whose geometry was set.
newGeometryoptional
Type:Data.Geometryoptional
The new feature geometry.
oldGeometryoptional
Type:Data.Geometryoptional
The previous feature geometry.

Data.SetPropertyEvent interface

google.maps.Data.SetPropertyEvent interface

The properties of asetpropertyevent.

feature
The feature whose property was set.
name
Type:string
The property name.
newValue
Type:*
The new value.
oldValue
Type:*
The previous value. Will beundefinedif the property was added.

Data.RemovePropertyEvent interface

google.maps.Data.RemovePropertyEvent interface

The properties of aremovepropertyevent.

feature
The feature whose property was removed.
name
Type:string
The property name.
oldValue
Type:*
The previous value.