diff --git a/nicer-api-docs/apidoc/ol.Feature_.html b/nicer-api-docs/apidoc/ol.Feature_.html deleted file mode 100644 index 49efe639bb..0000000000 --- a/nicer-api-docs/apidoc/ol.Feature_.html +++ /dev/null @@ -1,8300 +0,0 @@ - - - - - OpenLayers 3 API Documentation - Namespace: feature - - - - - - - - - - -
-
-
- OpenLayers 3 - API Documentation -
-
-
- -
- -
-
- -
- -
-
-

Namespace: feature

- - - - -
- -
-

- ol. - - feature -

- -
- -
-
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - - - - - - - - - - - - - - - -

Type Definitions

- -
- -
-
- -

-experimental - - - - ol.feature.FeatureStyleFunction() -

- - -
- src/ol/feature.js, line 216 -
- - -
- - -
-
- - -
-

A function that takes a {number} representing the view's resolution. It -returns an Array of ol.style.Style. This way individual features -can be styled. The this keyword inside the function references the -ol.Feature to be styled.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - ol.feature.StyleFunction() -

- - -
- src/ol/feature.js, line 265 -
- - -
- - -
-
- - -
-

A function that takes an ol.Feature and a {number} representing -the view's resolution. The function should return an array of -ol.style.Style. This way e.g. a vector layer can be styled.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- -
- - - -
- -
- - - - - - -
-
- - - - - \ No newline at end of file diff --git a/nicer-api-docs/apidoc/ol.feature.html b/nicer-api-docs/apidoc/ol.feature.html deleted file mode 100644 index bc8192be60..0000000000 --- a/nicer-api-docs/apidoc/ol.feature.html +++ /dev/null @@ -1,11274 +0,0 @@ - - - - - OpenLayers 3 API Documentation - Class: Feature - - - - - - - - - - -
-
-
- OpenLayers 3 - API Documentation -
-
-
- -
- -
-
- -
- -
-
-

Class: Feature

- - - - -
- -
-

- ol. - - Feature -

- -
- -
-
- - - - -
-
- -

-experimental - - - - new ol.Feature(opt_geometryOrValues) -

- - -
- src/ol/feature.js, line 25 -
- - -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
geometryOrValues - - -ol.geom.Geometry -| - -Object.<string, *>= - - - - - -

Values or geometry.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - -
Fires:
- - - - - - - - - - - - -
- - -
- - - - -

Extends

- - - - - - - - - - - - - - - - - -

Methods

- -
- -
-
- -

-experimental - - - - inherited - - bindTo(key, target, opt_targetKey){ol.ObjectAccessor} -

- - -
- src/ol/object.js, line 247 -
- - -
- - -
-
- - -
-

The bindTo method allows you to set up a two-way binding between a -source and target object. The method returns an -ol.ObjectAccessor with a transform method that lets you transform -values on the way from the source to the target and on the way back.

-

For example, if you had two map views (sourceView and targetView) -and you wanted the target view to have double the resolution of the -source view, you could transform the resolution on the way to and -from the target with the following:

-
sourceView.bindTo('resolution', targetView)
-  .transform(
-    function(sourceResolution) {
-      // from sourceView.resolution to targetView.resolution
-      return 2 * sourceResolution;
-    },
-    function(targetResolution) {
-      // from targetView.resolution to sourceView.resolution
-      return targetResolution / 2;
-    }
-  );
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDescription
key - - -string - - - - - - - - - - - - - - -

Key name.

target - - -ol.Object - - - - - - - - - - - - - - -

Target.

targetKey - - -string - - - - - - <optional>
- - - - 		- - - optional - - - - - -

Target key.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - inherited - - dispatchChangeEvent() -

- - -
- src/ol/observable.js, line 39 -
- - -
- - -
-
- - -
-

Dispatches a change event. Register a listener for this event to get -notified of changes.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - -
Fires:
-
    -
  • - - change - - -
    • -
- - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - inherited - - get(key){*} -

- - -
- src/ol/object.js, line 304 -
- - -
- - -
-
- - -
-

Gets a value.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -string - - - - - -

Key name.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - getGeometry(){ol.geom.Geometry|undefined} -

- - -
- src/ol/feature.js, line 85 -
- - -
- - -
-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - getGeometryName(){string} -

- - -
- src/ol/feature.js, line 108 -
- - -
- - -
-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
-property name. -
- - - - -
- - - -
-
- -

-experimental - - - - getId(){number|string|undefined} -

- - -
- src/ol/feature.js, line 99 -
- - -
- - -
-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - inherited - - getKeys(){Array.<string>} -

- - -
- src/ol/object.js, line 332 -
- - -
- - -
-
- - -
-

Get a list of object property names.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
-of property names. -
- - - - -
- - - -
-
- -

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

- - -
- src/ol/object.js, line 364 -
- - -
- - -
-
- - -
-

Get an object of all property names and values.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - getStyle(){ol.style.Style|Array.<ol.style.Style>|ol.feature.FeatureStyleFunction} -

- - -
- src/ol/feature.js, line 118 -
- - -
- - -
-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
-provided style. -
- - - - -
- - - -
-
- -

-experimental - - - - getStyleFunction(){ol.feature.FeatureStyleFunction|undefined} -

- - -
- src/ol/feature.js, line 127 -
- - -
- - -
-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
-function. -
- - - - -
- - - -
-
- -

-experimental - - - - inherited - - notify(key) -

- - -
- src/ol/object.js, line 384 -
- - -
- - -
-
- - -
-

Notify all observers of a change on this property. This notifies both -objects that are bound to the object's property as well as the object -that it is bound to.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -string - - - - - -

Key name.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - inherited - - on(type, listener, opt_this){goog.events.Key} -

- - -
- src/ol/observable.js, line 61 -
- - -
- - -
-
- - -
-

Listen for a certain type of event.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDescription
type - - -string -| - -Array.<string> - - - - - - - - - - - - - - -

The event type or array of event types.

listener - - -function - - - - - - - - - - - - - - -

The listener function.

this - - -Object - - - - - - <optional>
- - - - 		- - - optional - - - - - -

The object to use as this in listener.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
-key for the listener. -
- - - - -
- - - -
-
- -

-experimental - - - - inherited - - once(type, listener, opt_this){goog.events.Key} -

- - -
- src/ol/observable.js, line 74 -
- - -
- - -
-
- - -
-

Listen once for a certain type of event.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDescription
type - - -string -| - -Array.<string> - - - - - - - - - - - - - - -

The event type or array of event types.

listener - - -function - - - - - - - - - - - - - - -

The listener function.

this - - -Object - - - - - - <optional>
- - - - 		- - - optional - - - - - -

The object to use as this in listener.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
-key for the listener. -
- - - - -
- - - -
-
- -

-experimental - - - - inherited - - set(key, value) -

- - -
- src/ol/object.js, line 415 -
- - -
- - -
-
- - -
-

Sets a value.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -string - - - - - -

Key name.

value - - -* - - - - - -

Value.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - setGeometry(geometry) -

- - -
- src/ol/feature.js, line 161 -
- - -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
geometry - - -ol.geom.Geometry -| - -undefined - - - - - -

Geometry.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - setGeometryName(name) -

- - -
- src/ol/feature.js, line 195 -
- - -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
name - - -string - - - - - -

Geometry property name.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - setId(id) -

- - -
- src/ol/feature.js, line 186 -
- - -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
id - - -number -| - -string -| - -undefined - - - - - -

Id.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - setStyle(style) -

- - -
- src/ol/feature.js, line 175 -
- - -
- - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
style - - -ol.style.Style -| - -Array.<ol.style.Style> -| - -ol.feature.FeatureStyleFunction - - - - - -

Feature style.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - inherited - - setValues(values) -

- - -
- src/ol/object.js, line 444 -
- - -
- - -
-
- - -
-

Sets a collection of key-value pairs.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
values - - -Object.<string, *> - - - - - -

Values.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - inherited - - un(type, listener, opt_this) -

- - -
- src/ol/observable.js, line 86 -
- - -
- - -
-
- - -
-

Unlisten for a certain type of event.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeArgumentDescription
type - - -string -| - -Array.<string> - - - - - - - - - - - - - - -

The event type or array of event types.

listener - - -function - - - - - - - - - - - - - - -

The listener function.

this - - -Object - - - - - - <optional>
- - - - 		- - - optional - - - - - -

The object to use as this in listener.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - inherited - - unbind(key) -

- - -
- src/ol/object.js, line 458 -
- - -
- - -
-
- - -
-

Removes a binding. Unbinding will set the unbound property to the current - value. The object will not be notified, as the value has not changed.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -string - - - - - -

Key name.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - inherited - - unbindAll() -

- - -
- src/ol/object.js, line 482 -
- - -
- - -
-
- - -
-

Removes all bindings.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - - -
-
- -

-experimental - - - - inherited - - unByKey(key) -

- - -
- src/ol/observable.js, line 96 -
- - -
- - -
-
- - -
-

Removes an event listener using the key returned by on() or once().

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
key - - -goog.events.Key - - - - - -

Key.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- -
- - - - - -
- -
- - - - - - -
-
- - - - - \ No newline at end of file