new ol.Feature(opt_geometryOrProperties)
| Name | Type | Description |
|---|---|---|
geometryOrProperties |
ol.geom.Geometry | Object.<string, *>= |
You may pass a Geometry object directly, or an object literal
containing properties. If you pass an object literal, you may
include a Geometry associated with a |
Fires:
-
change(ol.events.Event) - Generic change event. Triggered when the revision counter is increased. -
change:geometry(ol.Object.Event) -
propertychange(ol.Object.Event) - Triggered when a property is changed.
Extends
Observable Properties
| Name | Type | Settable | ol.Object.Event type | Description |
|---|---|---|---|---|
geometry |
ol.geom.Geometry | undefined | yes | change:geometry |
The default geometry for the feature. |
Methods
-
Increases the revision counter and dispatches a 'change' event.
-
Clone this feature. If the original feature has a geometry it is also cloned. The feature id is not set in the clone.
Returns:
The clone.
-
Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a
typeproperty.Name Type Description eventObject | ol.events.Event | string Event object.
-
Gets a value.
Name Type Description keystring Key name.
Returns:
Value.
-
Get the feature's default geometry. A feature may have any number of named geometries. The "default" geometry (the one that is rendered by default) is set when calling
ol.Feature#setGeometry.Returns:
The default geometry for the feature.
-
getGeometryName(){string}
src/ol/feature.js, line 166 -
Get the name of the feature's default geometry. By default, the default geometry is named
geometry.Returns:
Get the property name associated with the default geometry for this feature.
-
getId(){number|string|undefined}
src/ol/feature.js, line 154 -
Get the feature identifier. This is a stable identifier for the feature and is either set when reading data from a remote source or set explicitly by calling
ol.Feature#setId.Returns:
Id.
-
Get a list of object property names.
Returns:
List of property names.
-
Get an object of all property names and values.
Returns:
Object.
-
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Returns:
Revision.
-
getStyle(){ol.style.Style|Array.<ol.style.Style>|ol.FeatureStyleFunction|ol.StyleFunction}
src/ol/feature.js, line 178 -
Get the feature's style. Will return what was provided to the
ol.Feature#setStylemethod.Returns:
The feature style.
-
Get the feature's style function.
Returns:
Return a function representing the current style of this feature.
-
on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 99 -
Listen for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
once(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 124 -
Listen once for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
Sets a value.
Name Type Description keystring Key name.
value* Value.
silentboolean Update without triggering an event.
-
setGeometry(geometry)
src/ol/feature.js, line 226 -
Set the default geometry for the feature. This will update the property with the name returned by
ol.Feature#getGeometryName.Name Type Description geometryol.geom.Geometry | undefined The new geometry.
-
setGeometryName(name)
src/ol/feature.js, line 270 -
Set the property name to be used when getting the feature's default geometry. When calling
ol.Feature#getGeometry, the value of the property with this name will be returned.Name Type Description namestring The property name of the default geometry.
-
setId(id)
src/ol/feature.js, line 257 -
Set the feature id. The feature id is considered stable and may be used when requesting features or comparing identifiers returned from a remote source. The feature id can be used with the
ol.source.Vector#getFeatureByIdmethod.Name Type Description idnumber | string | undefined The feature id.
Fires:
-
change(ol.events.Event) - Generic change event. Triggered when the revision counter is increased.
-
-
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Name Type Description valuesObject.<string, *> Values.
silentboolean Update without triggering an event.
-
setStyle(style)
src/ol/feature.js, line 240 -
Set the style for the feature. This can be a single style object, an array of styles, or a function that takes a resolution and returns an array of styles. If it is
nullthe feature has no style (anullstyle).Name Type Description styleol.style.Style | Array.<ol.style.Style> | ol.FeatureStyleFunction | ol.StyleFunction Style for this feature.
Fires:
-
change(ol.events.Event) - Generic change event. Triggered when the revision counter is increased.
-
-
Unlisten for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object which was used as
thisby thelistener. -
Unsets a property.
Name Type Description keystring Key name.
silentboolean Unset without triggering an event.
OpenLayers