Module type for BaseObject

This commit is contained in:
Tim Schaub
2018-03-18 09:50:48 -06:00
parent 0edbfde4d3
commit 414792f707
10 changed files with 12 additions and 12 deletions

View File

@@ -39,14 +39,14 @@ import {listen, unlistenByKey} from '../events.js';
* *
* The main advantage of having this as a control rather than a simple separate * The main advantage of having this as a control rather than a simple separate
* DOM element is that preventing propagation is handled for you. Controls * DOM element is that preventing propagation is handled for you. Controls
* will also be `ol.Object`s in a `ol.Collection`, so you can use their * will also be `module:ol/Object~BaseObject`s in a `ol.Collection`, so you can use their
* methods. * methods.
* *
* You can also extend this base for your own control class. See * You can also extend this base for your own control class. See
* examples/custom-controls for an example of how to do this. * examples/custom-controls for an example of how to do this.
* *
* @constructor * @constructor
* @extends {ol.Object} * @extends {module:ol/Object~BaseObject}
* @implements {oli.control.Control} * @implements {oli.control.Control}
* @param {module:ol/control/Control~Options} options Control options. * @param {module:ol/control/Control~Options} options Control options.
* @api * @api

View File

@@ -270,7 +270,7 @@ OverviewMap.prototype.setMap = function(map) {
/** /**
* Handle map property changes. This only deals with changes to the map's view. * Handle map property changes. This only deals with changes to the map's view.
* @param {ol.Object.Event} event The propertychange event. * @param {module:ol/Object~BaseObject.Event} event The propertychange event.
* @private * @private
*/ */
OverviewMap.prototype.handleMapPropertyChange_ = function(event) { OverviewMap.prototype.handleMapPropertyChange_ = function(event) {

View File

@@ -21,7 +21,7 @@ import {create as createTransform, compose as composeTransform} from '../transfo
* *
* @constructor * @constructor
* @abstract * @abstract
* @extends {ol.Object} * @extends {module:ol/Object~BaseObject}
* @api * @api
*/ */
const Geometry = function() { const Geometry = function() {

View File

@@ -12,12 +12,12 @@ import {assign} from '../obj.js';
* Abstract base class; normally only used for creating subclasses and not * Abstract base class; normally only used for creating subclasses and not
* instantiated in apps. * instantiated in apps.
* Note that with `ol.layer.Base` and all its subclasses, any property set in * 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 * the options is set as a {@link module:ol/Object~BaseObject} property on the layer object, so
* is observable, and has get/set accessors. * is observable, and has get/set accessors.
* *
* @constructor * @constructor
* @abstract * @abstract
* @extends {ol.Object} * @extends {module:ol/Object~BaseObject}
* @param {olx.layer.BaseOptions} options Layer options. * @param {olx.layer.BaseOptions} options Layer options.
* @api * @api
*/ */

View File

@@ -34,7 +34,7 @@ const DEFAULT_GRADIENT = ['#00f', '#0ff', '#0f0', '#ff0', '#f00'];
/** /**
* @classdesc * @classdesc
* Layer for rendering vector data as a heatmap. * Layer for rendering vector data as a heatmap.
* Note that any property set in the options is set as a {@link ol.Object} * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
* property on the layer object; for example, setting `title: 'My Title'` in the * property on the layer object; for example, setting `title: 'My Title'` in the
* options means that `title` is observable, and has get/set accessors. * options means that `title` is observable, and has get/set accessors.
* *

View File

@@ -9,7 +9,7 @@ import Layer from '../layer/Layer.js';
* @classdesc * @classdesc
* Server-rendered images that are available for arbitrary extents and * Server-rendered images that are available for arbitrary extents and
* resolutions. * resolutions.
* Note that any property set in the options is set as a {@link ol.Object} * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
* property on the layer object; for example, setting `title: 'My Title'` in the * property on the layer object; for example, setting `title: 'My Title'` in the
* options means that `title` is observable, and has get/set accessors. * options means that `title` is observable, and has get/set accessors.
* *

View File

@@ -11,7 +11,7 @@ import {assign} from '../obj.js';
* @classdesc * @classdesc
* For layer sources that provide pre-rendered, tiled images in grids that are * For layer sources that provide pre-rendered, tiled images in grids that are
* organized by zoom levels for specific resolutions. * organized by zoom levels for specific resolutions.
* Note that any property set in the options is set as a {@link ol.Object} * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
* property on the layer object; for example, setting `title: 'My Title'` in the * property on the layer object; for example, setting `title: 'My Title'` in the
* options means that `title` is observable, and has get/set accessors. * options means that `title` is observable, and has get/set accessors.
* *

View File

@@ -21,7 +21,7 @@ const Property = {
/** /**
* @classdesc * @classdesc
* Vector data that is rendered client-side. * Vector data that is rendered client-side.
* Note that any property set in the options is set as a {@link ol.Object} * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
* property on the layer object; for example, setting `title: 'My Title'` in the * property on the layer object; for example, setting `title: 'My Title'` in the
* options means that `title` is observable, and has get/set accessors. * options means that `title` is observable, and has get/set accessors.
* *

View File

@@ -12,7 +12,7 @@ import {assign} from '../obj.js';
/** /**
* @classdesc * @classdesc
* Layer for vector tile data that is rendered client-side. * Layer for vector tile data that is rendered client-side.
* Note that any property set in the options is set as a {@link ol.Object} * Note that any property set in the options is set as a {@link module:ol/Object~BaseObject}
* property on the layer object; for example, setting `title: 'My Title'` in the * property on the layer object; for example, setting `title: 'My Title'` in the
* options means that `title` is observable, and has get/set accessors. * options means that `title` is observable, and has get/set accessors.
* *

View File

@@ -18,7 +18,7 @@ import SourceState from '../source/State.js';
* *
* @constructor * @constructor
* @abstract * @abstract
* @extends {ol.Object} * @extends {module:ol/Object~BaseObject}
* @param {ol.SourceSourceOptions} options Source options. * @param {ol.SourceSourceOptions} options Source options.
* @api * @api
*/ */