-
Name Type Description geometryOrProperties
Geometry | ObjectWithGeometry.<Geometry> | undefined 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:
-
change
(BaseEvent) - Generic change event. Triggered when the revision counter is increased. -
change:geometry
(ObjectEvent) -
error
(BaseEvent) - Generic error event. Triggered when an error occurs. -
propertychange
(ObjectEvent) - Triggered when a property is changed.
-
Extends
Observable Properties
Name | Type | Settable | ObjectEvent type | Description |
---|---|---|---|---|
geometry |
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
type
property.Name Type Description event
BaseEvent | string Event object.
Returns:
false
if anyone called preventDefault on the event object or if any of the listeners returned false.
-
Gets a value.
Name Type Description key
string 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
setGeometry
.Returns:
The default geometry for the feature.
-
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.
-
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
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.
-
Get the feature's style. Will return what was provided to the
setStyle
method.Returns:
The feature style.
-
Get the feature's style function.
Returns:
Return a function representing the current style of this feature.
-
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.
-
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.
-
Sets a value.
Name Type Description key
string Key name.
value
* Value.
silent
boolean | undefined Update without triggering an event.
-
Set the default geometry for the feature. This will update the property with the name returned by
getGeometryName
.Name Type Description geometry
Geometry | undefined The new geometry.
-
Set the property name to be used when getting the feature's default geometry. When calling
getGeometry
, the value of the property with this name will be returned.Name Type Description name
string The property name of the default geometry.
-
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
getFeatureById
method.Name Type Description id
number | string | undefined The feature id.
Fires:
-
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 | undefined Update without triggering an event.
-
Set the style for the feature to override the layer style. This can be a single style object, an array of styles, or a function that takes a resolution and returns an array of styles. To unset the feature style, call
setStyle()
without arguments or a falsey value.Name Type Description style
StyleLike | undefined Style for this feature.
Fires:
-
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.
-
Unsets a property.
Name Type Description key
string Key name.
silent
boolean | undefined Unset without triggering an event.