google.maps.Data class
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.
This class extends MVCObject.
Constructor
Data([options])
Parameters:
- options: Data.DataOptions optional
Creates an empty collection, with the given DataOptions.
Methods
add([feature])
Parameters:
- feature: Data.Feature|Data.FeatureOptions optional
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(geoJson[, options])
Parameters:
- geoJson: Object
- options: Data.GeoJsonOptions optional
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(feature)
Parameters:
- feature: Data.Feature
Return Value: boolean
Checks whether the given feature is in the collection.
forEach(callback)
Parameters:
- callback: function(Data.Feature)
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()
Parameters: None
Return Value: ControlPosition
Returns the position of the drawing controls on the map.
getControls()
Parameters: None
Return Value: Array
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()
Parameters: None
Return Value: string optional
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(id)
Parameters:
- id: number|string
Return Value: Data.Feature optional
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()
Parameters: None
Return Value: Map
Returns the map on which the features are displayed.
getStyle()
Parameters: None
Return Value: Data.StylingFunction|Data.StyleOptions
Gets the style for all features in the collection.
loadGeoJson(url[, options, callback])
Parameters:
- url: string
- options: Data.GeoJsonOptions optional
- callback: function(Array<Data.Feature>) optional
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(feature, style)
Parameters:
- feature: Data.Feature
- style: Data.StyleOptions
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(feature)
Parameters:
- feature: Data.Feature
Return Value: None
Removes a feature from the collection.
revertStyle([feature])
Parameters:
- feature: Data.Feature optional
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(controlPosition)
Parameters:
- controlPosition: ControlPosition
Return Value: None
Sets the position of the drawing controls on the map.
setControls(controls)
Parameters:
- controls: Array
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(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(map)
Parameters:
- map: Map
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(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(callback)
Parameters:
- callback: function(Object)
Return Value: None
Exports the features in the collection to a GeoJSON object.
Events
function(event)
Arguments:
- event: Data.AddFeatureEvent
This event is fired when a feature is added to the collection.
function(event)
Arguments:
- event: Data.MouseEvent
This event is fired for a click on the geometry.
function(event)
Arguments:
- event: Data.MouseEvent
This event is fired for a double click on the geometry.
function(event)
Arguments:
- event: Data.MouseEvent
This event is fired for a mousedown on the geometry.
function(event)
Arguments:
- event: Data.MouseEvent
This event is fired when the mouse leaves the area of the geometry.
function(event)
Arguments:
- event: Data.MouseEvent
This event is fired when the mouse enters the area of the geometry.
function(event)
Arguments:
- event: Data.MouseEvent
This event is fired for a mouseup on the geometry.
function(event)
Arguments:
- event: Data.RemoveFeatureEvent
This event is fired when a feature is removed from the collection.
function(event)
Arguments:
- event: Data.RemovePropertyEvent
This event is fired when a feature's property is removed.
function(event)
Arguments:
- event: Data.MouseEvent
This event is fired for a rightclick on the geometry.
function(event)
Arguments:
- event: Data.SetGeometryEvent
This event is fired when a feature's geometry is set.
function(event)
Arguments:
- event: Data.SetPropertyEvent
This event is fired when a feature's property is set.