From 9915bb873c653e1bc74f21ddbbbd8a0818087782 Mon Sep 17 00:00:00 2001 From: Peter Robins Date: Wed, 9 Jul 2014 06:39:42 -0400 Subject: [PATCH 1/2] Document that feature properties are set as object properties --- src/ol/feature.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ol/feature.js b/src/ol/feature.js index 8e5307c8a2..6b7ce73e3b 100644 --- a/src/ol/feature.js +++ b/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} From 17d059f7bb71f227e230a577ff09b00624619a55 Mon Sep 17 00:00:00 2001 From: Peter Robins Date: Wed, 9 Jul 2014 06:40:28 -0400 Subject: [PATCH 2/2] Document that layer options are set as object properties --- src/ol/layer/heatmaplayer.js | 3 +++ src/ol/layer/imagelayer.js | 3 +++ src/ol/layer/layerbase.js | 3 +++ src/ol/layer/tilelayer.js | 3 +++ src/ol/layer/vectorlayer.js | 3 +++ 5 files changed, 15 insertions(+) diff --git a/src/ol/layer/heatmaplayer.js b/src/ol/layer/heatmaplayer.js index 9b17e0f263..3658144b7a 100644 --- a/src/ol/layer/heatmaplayer.js +++ b/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} diff --git a/src/ol/layer/imagelayer.js b/src/ol/layer/imagelayer.js index 1a99845ea9..3f9ebc536b 100644 --- a/src/ol/layer/imagelayer.js +++ b/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} diff --git a/src/ol/layer/layerbase.js b/src/ol/layer/layerbase.js index 28eec16d3d..6190b070fe 100644 --- a/src/ol/layer/layerbase.js +++ b/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} diff --git a/src/ol/layer/tilelayer.js b/src/ol/layer/tilelayer.js index 98ef732858..6a24ad8261 100644 --- a/src/ol/layer/tilelayer.js +++ b/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} diff --git a/src/ol/layer/vectorlayer.js b/src/ol/layer/vectorlayer.js index f413de79de..cef835be51 100644 --- a/src/ol/layer/vectorlayer.js +++ b/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}