Merge pull request #2298 from probins/props

Document that options in layers and properties in features are set as object properties

src/ol/feature.js

@@ -21,6 +21,8 @@ goog.require('ol.style.Style');
  * attribute properties, similar to the features in vector file formats like
  * GeoJSON.
  * Features can be styled individually or use the style of their vector layer.
+ * Note that attribute properties are set as {@link ol.Object} properties on the
+ * feature object, so they are observable, and have get/set accessors.
  *
  * @constructor
  * @extends {ol.Object}

src/ol/layer/heatmaplayer.js

@@ -23,6 +23,9 @@ ol.layer.HeatmapLayerProperty = {
 /**
  * @classdesc
  * Layer for rendering vector data as a heatmap.
+ * Note that any property set in the options is set as a {@link ol.Object}
+ * property on the layer object; for example, setting `title: 'My Title'` in the
+ * options means that `title` is observable, and has get/set accessors.
  *
  * @constructor
  * @extends {ol.layer.Vector}

src/ol/layer/imagelayer.js

@@ -8,6 +8,9 @@ goog.require('ol.layer.Layer');
  * @classdesc
  * Server-rendered images that are available for arbitrary extents and
  * resolutions.
+ * Note that any property set in the options is set as a {@link ol.Object}
+ * property on the layer object; for example, setting `title: 'My Title'` in the
+ * options means that `title` is observable, and has get/set accessors.
  *
  * @constructor
  * @extends {ol.layer.Layer}

src/ol/layer/layerbase.js

@@ -44,6 +44,9 @@ ol.layer.LayerState;
  * @classdesc
  * Abstract base class; normally only used for creating subclasses and not
  * instantiated in apps.
+ * Note that with `ol.layer.Base` and all its subclasses, any property set in
+ * the options is set as a {@link ol.Object} property on the layer object, so
+ * is observable, and has get/set accessors.
  *
  * @constructor
  * @extends {ol.Object}

src/ol/layer/tilelayer.js

@@ -17,6 +17,9 @@ ol.layer.TileProperty = {
  * @classdesc
  * For layer sources that provide pre-rendered, tiled images in grids that are
  * organized by zoom levels for specific resolutions.
+ * Note that any property set in the options is set as a {@link ol.Object}
+ * property on the layer object; for example, setting `title: 'My Title'` in the
+ * options means that `title` is observable, and has get/set accessors.
  *
  * @constructor
  * @extends {ol.layer.Layer}

src/ol/layer/vectorlayer.js

@@ -17,6 +17,9 @@ ol.layer.VectorProperty = {
 /**
  * @classdesc
  * Vector data that is rendered client-side.
+ * Note that any property set in the options is set as a {@link ol.Object}
+ * property on the layer object; for example, setting `title: 'My Title'` in the
+ * options means that `title` is observable, and has get/set accessors.
  *
  * @constructor
  * @extends {ol.layer.Layer}