FeatureLayer interface
google.maps.FeatureLayer
interface
An interface representing a map layer containing features of a specificFeatureType
whose style can be overridden client-side, or have events attached.
Properties | |
---|---|
featureType |
Type:
FeatureType The FeatureType associated with thisFeatureLayer . |
isAvailable |
Type:
boolean Whether this FeatureLayer is available, meaning whether Data-driven styling is available for this map (there is a map ID using vector tiles with thisFeatureLayer enabled in the Google Cloud Console map style.) If this is false (or becomes false), styling on thisFeatureLayer returns to default and events are not triggered. |
datasetIdoptional |
Type:
stringoptional The Dataset ID for this FeatureLayer .Only present if thefeatureType isFeatureType.DATASET . |
styleoptional |
Type:
FeatureStyleOptions|FeatureStyleFunctionoptional The style of Feature s in theFeatureLayer .The style is applied when style is set. If your style function updates, you must set the style property again. AFeatureStyleFunction must return consistent results when it is applied over the map tiles, and should be optimized for performance. Asynchronous functions are not supported. If you use aFeatureStyleOptions ,all features of that layer will be styled with the sameFeatureStyleOptions .Set the style tonull to remove the previously set style. If thisFeatureLayer is not available, setting style does nothing and logs an error. |
Methods | |
---|---|
addListener |
addListener(eventName, handler) Parameters:
Return Value:
MapsEventListener Resulting event listener.Adds the given listener function to the given event name. Returns an identifier for this listener that can be used with event.removeListener . |
Events | |
---|---|
click |
function(event) Arguments:
This event is fired when the FeatureLayer is clicked. |
mousemove |
function(event) Arguments:
This event is fired when the user's mouse moves over the FeatureLayer . |
FeatureType constants
google.maps.FeatureType
constants
Identifiers for feature types.
Access by callingconst {FeatureType} = await google.maps.importLibrary( "maps" )
.SeeLibraries in the Maps JavaScript API.
Constants | |
---|---|
ADMINISTRATIVE_AREA_LEVEL_1 |
Indicates a first-order civil entity below the country level. |
ADMINISTRATIVE_AREA_LEVEL_2 |
Indicates a second-order civil entity below the country level. |
COUNTRY |
Indicates the national political entity. |
DATASET |
Indicates a third-party dataset. |
LOCALITY |
Indicates an incorporated city or town political entity. |
POSTAL_CODE |
Indicates a postal code as used to address postal mail within the country. Includes zip codes. |
SCHOOL_DISTRICT |
Indicates a school district. |
FeatureStyleFunction typedef
google.maps.FeatureStyleFunction
typedef
A function to style aFeatureLayer
.
function(FeatureStyleFunctionOptions): (FeatureStyleOptionsoptional)
FeatureStyleFunctionOptions interface
google.maps.FeatureStyleFunctionOptions
interface
Options passed to aFeatureStyleFunction
.
Properties | |
---|---|
feature |
Type:
Feature Feature passed into theFeatureStyleFunction for styling. |
FeatureStyleOptions interface
google.maps.FeatureStyleOptions
interface
These options specify the way the style of aFeature
should be modified on a map.
Properties | |
---|---|
fillColoroptional |
Type:
stringoptional Hex RGB string (like "#00FF00" for green). Only applies to polygon geometries. |
fillOpacityoptional |
Type:
numberoptional The fill opacity between 0.0 and 1.0. Only applies to polygon geometries. |
strokeColoroptional |
Type:
stringoptional Hex RGB string (like "#00FF00" for green). |
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. |
Feature interface
google.maps.Feature
interface
An interface representing a vector map tile feature. These are inputs to theFeatureStyleFunction
.Do not save a reference to a particularFeature
object because the reference will not be stable.
Properties | |
---|---|
featureType |
Type:
FeatureType FeatureType of thisFeature . |
PlaceFeature interface
google.maps.PlaceFeature
interface
An interface representing a feature with a place ID which includes features of typeFeatureType.ADMINISTRATIVE_AREA_LEVEL_1
,FeatureType.ADMINISTRATIVE_AREA_LEVEL_2
,FeatureType.COUNTRY
,FeatureType.LOCALITY
,FeatureType.POSTAL_CODE
,andFeatureType.SCHOOL_DISTRICT
.
This interface extends
Feature
.
Properties | |
---|---|
placeId |
Type:
string |
Inherited:
featureType
|
Methods | |
---|---|
fetchPlace |
fetchPlace() Parameters:None
Fetches a Place for thisPlaceFeature .In the resultingPlace object, theid and thedisplayName properties will be populated. The display name will be in the language the end user sees on the map. (Additional fields can be subsequently requested viaPlace.fetchFields() subject to normal Places API enablement and billing.) Do not call this from aFeatureStyleFunction since only synchronous FeatureStyleFunctions are supported. The promise is rejected if there was an error fetching thePlace . |
DatasetFeature interface
google.maps.DatasetFeature
interface
An interface representing a feature from a Dataset. ThefeatureType
of aDatasetFeature
will always beFeatureType.DATASET
.
This interface extends
Feature
.
Properties | |
---|---|
datasetAttributes |
Type:
Object<string, string> Key-value mapping of the feature's attributes. |
datasetId |
Type:
string Dataset id of the dataset that this feature belongs to. |
Inherited:
featureType
|
FeatureMouseEvent interface
google.maps.FeatureMouseEvent
interface
This object is returned from a mouse event on aFeatureLayer
.
This interface extends
MapMouseEvent
.
Properties | |
---|---|
features |
The Feature s at this mouse event. |
Inherited:
domEvent ,
latLng
|
Methods | |
---|---|
Inherited:
stop
|