Class: Feature

ol/Feature~Feature


import Feature from 'ol/Feature';

A vector object for geographic features with a geometry and other attribute properties, similar to the features in vector file formats like GeoJSON.

Features can be styled individually with setStyle; otherwise they use the style of their vector layer.

Note that attribute properties are set as module:ol/Object~BaseObject properties on the feature object, so they are observable, and have get/set accessors.

Typically, a feature has a single geometry property. You can set the geometry using the setGeometry method and get it with getGeometry. It is possible to store more than one geometry on a feature using attribute properties. By default, the geometry used for rendering is identified by the property name geometry. If you want to use another geometry property for rendering, use the setGeometryName method to change the attribute property associated with the geometry for the feature. For example:


import Feature from 'ol/Feature';
import Polygon from 'ol/geom/Polygon';
import Point from 'ol/geom/Point';

var feature = new Feature({
  geometry: new Polygon(polyCoords),
  labelPoint: new Point(labelCoords),
  name: 'My Polygon'
});

// get the polygon geometry
var poly = feature.getGeometry();

// Render the feature as a point using the coordinates from labelPoint
feature.setGeometryName('labelPoint');

// get the point geometry
var point = feature.getGeometry();

new Feature(opt_geometryOrProperties)

Feature.js, line 62
Name Type Description
geometryOrProperties module:ol/geom/Geometry~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 geometry key.

Fires:

Extends

Observable Properties

Name Type Settable ol/Object~ObjectEvent type Description
geometry module:ol/geom/Geometry~Geometry | undefined yes change:geometry

The default geometry for the feature.

Methods

changed() inherited

Observable.js, line 59

Increases the revision counter and dispatches a 'change' event.

clone(){module:ol/Feature~Feature}

Feature.js, line 123

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.

dispatchEvent(event) inherited

Observable.js, line 76

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 type property.

Name Type Description
event Object | module:ol/events/Event~Event | string

Event object.

get(key){*} inherited

Object.js, line 136

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

getGeometry(){module:ol/geom/Geometry~Geometry|undefined}

Feature.js, line 146

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 module:ol/Feature~Feature#setGeometry.

Returns:
The default geometry for the feature.

getGeometryName(){string}

Feature.js, line 172

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}

Feature.js, line 160

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 module:ol/Feature~Feature#setId.

Returns:
Id.

getKeys(){Array.<string>} inherited

Object.js, line 150

Get a list of object property names.

Returns:
List of property names.

getProperties(){Object.<string, *>} inherited

Object.js, line 160

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 85

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

Get the feature's style. Will return what was provided to the module:ol/Feature~Feature#setStyle method.

Returns:
The feature style.

getStyleFunction(){module:ol/style/Style~StyleFunction|undefined}

Feature.js, line 194

Get the feature's style function.

Returns:
Return a function representing the current style of this feature.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 99

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

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){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 122

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

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.

set(key, value, opt_silent) inherited

Object.js, line 185

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean

Update without triggering an event.

setGeometry(geometry)

Feature.js, line 231

Set the default geometry for the feature. This will update the property with the name returned by module:ol/Feature~Feature#getGeometryName.

Name Type Description
geometry module:ol/geom/Geometry~Geometry | undefined

The new geometry.

setGeometryName(name)

Feature.js, line 273

Set the property name to be used when getting the feature's default geometry. When calling module:ol/Feature~Feature#getGeometry, the value of the property with this name will be returned.

Name Type Description
name string

The property name of the default geometry.

setId(id)

Feature.js, line 260

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 module:ol/source/Vector~VectorSource#getFeatureById method.

Name Type Description
id number | string | undefined

The feature id.

Fires:

setProperties(values, opt_silent) inherited

Object.js, line 205

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
values Object.<string, *>

Values.

silent boolean

Update without triggering an event.

setStyle(style)

Feature.js, line 244

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 null the feature has no style (a null style).

Name Type Description
style module:ol/style/Style~Style | Array.<module:ol/style/Style~Style> | module:ol/style/Style~StyleFunction

Style for this feature.

Fires:

un(type, listener) inherited

Observable.js, line 142

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

unset(key, opt_silent) inherited

Object.js, line 218

Unsets a property.

Name Type Description
key string

Key name.

silent boolean

Unset without triggering an event.