Data

Data class

class google.maps.Data extends MVCObject
library "maps"

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

Every Map has a Data object 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(...);
The Data object is a collection of Features.

const {Data} = await google.maps.importLibrary("maps");
Data
Data([options])
Parameters:
Creates an empty collection, with the given DataOptions.
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. If FeatureOptions are given, a new feature will be created with the specified properties.

Note that the IDs 1234 and '1234' are equivalent. Adding a feature with ID 1234 will 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|null
Returns the position of the drawing controls on the map.
getControls
getControls()
Parameters: None
Return Value: Array<string>|null
Returns which drawing modes are available for the user to select, in the order they are displayed. This does not include the null drawing 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 of null means that the user can interact with the map as normal, and clicks do not draw anything. Possible drawing modes are null, "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 returns undefined.

Note that the IDs 1234 and '1234' are equivalent. Either can be used to look up the same feature.
getMap
getMap()
Parameters: None
Return Value: Map|null
Returns the map on which the features are displayed.
getStyle
getStyle()
Parameters: None
Return Value: Data.StylingFunction|Data.StyleOptions|null
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 call addGeoJson().
overrideStyle
overrideStyle(feature, style)
Parameters:
Return Value: None
Changes the style of a feature. These changes are applied on top of the style specified by setStyle(). Style properties set to null revert to the value specified via setStyle().
remove
remove(feature)
Parameters:
Return Value: None
Removes a feature from the collection.
revertStyle
revertStyle([feature])
Parameters:
Return Value: None
Removes the effect of previous overrideStyle() calls. The style of the given feature reverts to the style specified by setStyle().

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:
  • controls: Array<string> optional
Return Value: None
Sets which drawing modes are available for the user to select, in the order they are displayed. This should not include the null drawing mode, which is added by default. If null, drawing controls are disabled and not displayed. Possible drawing modes are "Point", "LineString" or "Polygon".
setDrawingMode
setDrawingMode(drawingMode)
Parameters:
  • drawingMode: string optional
Return Value: None
Sets the current drawing mode of the given Data layer. A drawing mode of null means that the user can interact with the map as normal, and clicks do not draw anything. Possible drawing modes are null, "Point", "LineString" or "Polygon".
setMap
setMap(map)
Parameters:
  • map: Map optional
Return Value: None
Renders the features on the specified map. If map is set to null, the features will be removed from the map.
setStyle
setStyle(style)
Parameters:
Return Value: None
Sets the style for all features in the collection. Styles specified on a per-feature basis via overrideStyle() 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

interface google.maps.Data.DataOptions

DataOptions object used to define the properties that a developer can set on a Data object.
map
Type: Map
Map on which to display the features in the collection.
controlPosition
optional
Type: ControlPosition optional
Default: ControlPosition.TOP_LEFT
The position of the drawing controls on the map.
controls
optional
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 the null drawing mode, which is added by default. If null, drawing controls are disabled and not displayed. Possible drawing modes are "Point", "LineString" or "Polygon".
drawingMode
optional
Type: string optional
Default: null
The current drawing mode of the given Data layer. A drawing mode of null means that the user can interact with the map as normal, and clicks do not draw anything. Possible drawing modes are null, "Point", "LineString" or "Polygon".
featureFactory
optional
Type: function(Data.Geometry): Data.Feature optional
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 to null.
style
optional
Style for all features in the collection. For more details, see the setStyle() method above.

Data.GeoJsonOptions interface

interface google.maps.Data.GeoJsonOptions

Optional parameters for importing GeoJSON.
idPropertyName
optional
Type: string optional
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

interface google.maps.Data.StyleOptions

These options specify the way a Feature should appear when displayed on a map.
animation
optional
Type: Animation optional
The animation to play when marker is added to a map. Only applies to point geometries.
clickable
optional
Type: boolean optional
Default: true
If true, the marker receives mouse and touch events.
cursor
optional
Type: string optional
Mouse cursor to show on hover. Only applies to point geometries.
draggable
optional
Type: boolean optional
Default: false
If true, the object can be dragged across the map and the underlying feature will have its geometry updated.
editable
optional
Type: boolean optional
Default: false
If true, 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.
fillColor
optional
Type: string optional
The fill color. All CSS3 colors are supported e