ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #2555 from elemoine/apistable1

Browse Source 
Add @api stable annotations for the ol.source namespace
This commit is contained in:
Éric Lemoine
2014-08-22 17:57:23 +02:00
parent f369f9a076 54ff843075
commit 678d4ef01c
16 changed files with 111 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

132
externs/olx.js
View File

@@ -3009,7 +3009,7 @@ olx.source.BingMapsOptions;
/**
* Culture code. Default is `en-us`.
* @type {string|undefined}
* @api
* @api stable
*/
olx.source.BingMapsOptions.prototype.culture;
@@ -3017,7 +3017,7 @@ olx.source.BingMapsOptions.prototype.culture;
/**
* Bing Maps API key. Get yours at http://bingmapsportal.com/.
* @type {string}
* @api
* @api stable
*/
olx.source.BingMapsOptions.prototype.key;
@@ -3025,7 +3025,7 @@ olx.source.BingMapsOptions.prototype.key;
/**
* Type of imagery.
* @type {string}
* @api
* @api stable
*/
olx.source.BingMapsOptions.prototype.imagerySet;
@@ -3657,7 +3657,7 @@ olx.source.ImageMapGuideOptions;
/**
* The mapagent url.
* @type {string|undefined}
* @api
* @api stable
*/
olx.source.ImageMapGuideOptions.prototype.url;
@@ -3665,7 +3665,7 @@ olx.source.ImageMapGuideOptions.prototype.url;
/**
* The display resolution. Default is `96`.
* @type {number|undefined}
* @api
* @api stable
*/
olx.source.ImageMapGuideOptions.prototype.displayDpi;
@@ -3673,7 +3673,7 @@ olx.source.ImageMapGuideOptions.prototype.displayDpi;
/**
* The meters-per-unit value. Default is `1`.
* @type {number|undefined}
* @api
* @api stable
*/
olx.source.ImageMapGuideOptions.prototype.metersPerUnit;
@@ -3690,7 +3690,7 @@ olx.source.ImageMapGuideOptions.prototype.hidpi;
/**
* If `true`, will use `GETDYNAMICMAPOVERLAYIMAGE`.
* @type {boolean|undefined}
* @api
* @api stable
*/
olx.source.ImageMapGuideOptions.prototype.useOverlay;
@@ -3707,7 +3707,7 @@ olx.source.ImageMapGuideOptions.prototype.projection;
* Ratio. `1` means image requests are the size of the map viewport, `2` means
* twice the size of the map viewport, and so on. Default is `1`.
* @type {number|undefined}
* @api
* @api stable
*/
olx.source.ImageMapGuideOptions.prototype.ratio;
@@ -3715,7 +3715,7 @@ olx.source.ImageMapGuideOptions.prototype.ratio;
/**
* Resolutions. If specified, requests will be made for these resolutions only.
* @type {Array.<number>|undefined}
* @api
* @api stable
*/
olx.source.ImageMapGuideOptions.prototype.resolutions;
@@ -3723,7 +3723,7 @@ olx.source.ImageMapGuideOptions.prototype.resolutions;
/**
* Additional parameters.
* @type {Object|undefined}
* @api
* @api stable
*/
olx.source.ImageMapGuideOptions.prototype.params;
@@ -3836,7 +3836,7 @@ olx.source.MapQuestOptions;
/**
* Layer. Possible values are `osm`, `sat`, and `hyb`.
* @type {string}
* @api
* @api stable
*/
olx.source.MapQuestOptions.prototype.layer;
@@ -3887,7 +3887,7 @@ olx.source.OSMOptions;
/**
* Attributions.
* @type {Array.<ol.Attribution>|undefined}
* @api
* @api stable
*/
olx.source.OSMOptions.prototype.attributions;
@@ -3895,7 +3895,7 @@ olx.source.OSMOptions.prototype.attributions;
/**
* crossOrigin setting for image requests. Default is `anonymous`.
* @type {null|string|undefined}
* @api
* @api stable
*/
olx.source.OSMOptions.prototype.crossOrigin;
@@ -3920,7 +3920,7 @@ olx.source.OSMOptions.prototype.tileLoadFunction;
* URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders.
* Default is `//{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png`.
* @type {string|undefined}
* @api
* @api stable
*/
olx.source.OSMOptions.prototype.url;
@@ -4190,7 +4190,7 @@ olx.source.ImageWMSOptions;
/**
* Attributions.
* @type {Array.<ol.Attribution>|undefined}
* @api
* @api stable
*/
olx.source.ImageWMSOptions.prototype.attributions;
@@ -4198,7 +4198,7 @@ olx.source.ImageWMSOptions.prototype.attributions;
/**
* crossOrigin setting for image requests.
* @type {null|string|undefined}
* @api
* @api stable
*/
olx.source.ImageWMSOptions.prototype.crossOrigin;
@@ -4224,7 +4224,7 @@ olx.source.ImageWMSOptions.prototype.serverType;
/**
* Logo.
* @type {string|olx.LogoOptions|undefined}
* @api
* @api stable
*/
olx.source.ImageWMSOptions.prototype.logo;
@@ -4234,7 +4234,7 @@ olx.source.ImageWMSOptions.prototype.logo;
* `''` by default. `VERSION` is `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX`
* and `CRS` (`SRS` for WMS version < 1.3.0) will be set dynamically.
* @type {Object.<string,*>}
* @api
* @api stable
*/
olx.source.ImageWMSOptions.prototype.params;
@@ -4251,7 +4251,7 @@ olx.source.ImageWMSOptions.prototype.projection;
* Ratio. `1` means image requests are the size of the map viewport, `2` means
* twice the size of the map viewport, and so on. Default is `1.5`.
* @type {number|undefined}
* @api
* @api stable
*/
olx.source.ImageWMSOptions.prototype.ratio;
@@ -4259,7 +4259,7 @@ olx.source.ImageWMSOptions.prototype.ratio;
/**
* Resolutions. If specified, requests will be made for these resolutions only.
* @type {Array.<number>|undefined}
* @api
* @api stable
*/
olx.source.ImageWMSOptions.prototype.resolutions;
@@ -4267,7 +4267,7 @@ olx.source.ImageWMSOptions.prototype.resolutions;
/**
* WMS service URL.
* @type {string|undefined}
* @api
* @api stable
*/
olx.source.ImageWMSOptions.prototype.url;
@@ -4287,7 +4287,7 @@ olx.source.StamenOptions;
/**
* Layer.
* @type {string}
* @api
* @api stable
*/
olx.source.StamenOptions.prototype.layer;
@@ -4327,7 +4327,7 @@ olx.source.StamenOptions.prototype.tileLoadFunction;
/**
* URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders.
* @type {string|undefined}
* @api
* @api stable
*/
olx.source.StamenOptions.prototype.url;
@@ -4348,7 +4348,7 @@ olx.source.ImageStaticOptions;
/**
* Attributions.
* @type {Array.<ol.Attribution>|undefined}
* @api
* @api stable
*/
olx.source.ImageStaticOptions.prototype.attributions;
@@ -4356,7 +4356,7 @@ olx.source.ImageStaticOptions.prototype.attributions;
/**
* crossOrigin setting for image requests.
* @type {null|string|undefined}
* @api
* @api stable
*/
olx.source.ImageStaticOptions.prototype.crossOrigin;
@@ -4364,7 +4364,7 @@ olx.source.ImageStaticOptions.prototype.crossOrigin;
/**
* Extent of the image.
* @type {ol.Extent|undefined}
* @api
* @api stable
*/
olx.source.ImageStaticOptions.prototype.imageExtent;
@@ -4372,7 +4372,7 @@ olx.source.ImageStaticOptions.prototype.imageExtent;
/**
* Size of the image.
* @type {ol.Size|undefined}
* @api
* @api stable
*/
olx.source.ImageStaticOptions.prototype.imageSize;
@@ -4380,7 +4380,7 @@ olx.source.ImageStaticOptions.prototype.imageSize;
/**
* Logo.
* @type {string|olx.LogoOptions|undefined}
* @api
* @api stable
*/
olx.source.ImageStaticOptions.prototype.logo;
@@ -4396,7 +4396,7 @@ olx.source.ImageStaticOptions.prototype.projection;
/**
* Url.
* @type {string}
* @api
* @api stable
*/
olx.source.ImageStaticOptions.prototype.url;
@@ -4474,7 +4474,7 @@ olx.source.TileJSONOptions;
/**
* crossOrigin setting for image requests.
* @type {null|string|undefined}
* @api
* @api stable
*/
olx.source.TileJSONOptions.prototype.crossOrigin;
@@ -4490,7 +4490,7 @@ olx.source.TileJSONOptions.prototype.tileLoadFunction;
/**
* URL to the TileJSON file.
* @type {string}
* @api
* @api stable
*/
olx.source.TileJSONOptions.prototype.url;
@@ -4517,7 +4517,7 @@ olx.source.TileWMSOptions;
/**
* Attributions.
* @type {Array.<ol.Attribution>|undefined}
* @api
* @api stable
*/
olx.source.TileWMSOptions.prototype.attributions;
@@ -4527,7 +4527,7 @@ olx.source.TileWMSOptions.prototype.attributions;
* `''` by default. `VERSION` is `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX`
* and `CRS` (`SRS` for WMS version < 1.3.0) will be set dynamically.
* @type {Object.<string,*>}
* @api
* @api stable
*/
olx.source.TileWMSOptions.prototype.params;
@@ -4535,7 +4535,7 @@ olx.source.TileWMSOptions.prototype.params;
/**
* crossOrigin setting for image requests.
* @type {null|string|undefined}
* @api
* @api stable
*/
olx.source.TileWMSOptions.prototype.crossOrigin;
@@ -4550,7 +4550,7 @@ olx.source.TileWMSOptions.prototype.crossOrigin;
* example, MapServer has a `tile_map_edge_buffer` configuration parameter for
* this. See http://mapserver.org/output/tile_mode.html.
* @type {number|undefined}
* @api
* @api stable
*/
olx.source.TileWMSOptions.prototype.gutter;
@@ -4567,7 +4567,7 @@ olx.source.TileWMSOptions.prototype.hidpi;
/**
* Logo.
* @type {string|olx.LogoOptions|undefined}
* @api
* @api stable
*/
olx.source.TileWMSOptions.prototype.logo;
@@ -4579,7 +4579,7 @@ olx.source.TileWMSOptions.prototype.logo;
* extent, the grid will be based on that; if not, a grid based on a global
* extent with origin at 0,0 will be used.
* @type {ol.tilegrid.TileGrid|undefined}
* @api
* @api stable
*/
olx.source.TileWMSOptions.prototype.tileGrid;
@@ -4620,7 +4620,7 @@ olx.source.TileWMSOptions.prototype.tileLoadFunction;
/**
* WMS service URL.
* @type {string|undefined}
* @api
* @api stable
*/
olx.source.TileWMSOptions.prototype.url;
@@ -4629,7 +4629,7 @@ olx.source.TileWMSOptions.prototype.url;
* WMS service urls. Use this instead of `url` when the WMS supports multiple
* urls for GetMap requests.
* @type {Array.<string>|undefined}
* @api
* @api stable
*/
olx.source.TileWMSOptions.prototype.urls;
@@ -4648,7 +4648,7 @@ olx.source.VectorOptions;
/**
* Attributions.
* @type {Array.<ol.Attribution>|undefined}
* @api
* @api stable
*/
olx.source.VectorOptions.prototype.attributions;
@@ -4656,7 +4656,7 @@ olx.source.VectorOptions.prototype.attributions;
/**
* Features.
* @type {Array.<ol.Feature>|undefined}
* @api
* @api stable
*/
olx.source.VectorOptions.prototype.features;
@@ -4664,7 +4664,7 @@ olx.source.VectorOptions.prototype.features;
/**
* Logo.
* @type {string|olx.LogoOptions|undefined}
* @api
* @api stable
*/
olx.source.VectorOptions.prototype.logo;
@@ -4816,7 +4816,7 @@ olx.source.WMTSOptions;
/**
* Attributions.
* @type {Array.<ol.Attribution>|undefined}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.attributions;
@@ -4824,7 +4824,7 @@ olx.source.WMTSOptions.prototype.attributions;
/**
* crossOrigin setting for image requests.
* @type {string|null|undefined}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.crossOrigin;
@@ -4832,7 +4832,7 @@ olx.source.WMTSOptions.prototype.crossOrigin;
/**
* Logo.
* @type {string|olx.LogoOptions|undefined}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.logo;
@@ -4840,7 +4840,7 @@ olx.source.WMTSOptions.prototype.logo;
/**
* Tile grid.
* @type {ol.tilegrid.WMTS}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.tileGrid;
@@ -4856,7 +4856,7 @@ olx.source.WMTSOptions.prototype.projection;
/**
* Request encoding.
* @type {ol.source.WMTSRequestEncoding|undefined}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.requestEncoding;
@@ -4864,7 +4864,7 @@ olx.source.WMTSOptions.prototype.requestEncoding;
/**
* Layer.
* @type {string}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.layer;
@@ -4872,7 +4872,7 @@ olx.source.WMTSOptions.prototype.layer;
/**
* Style.
* @type {string}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.style;
@@ -4891,7 +4891,7 @@ olx.source.WMTSOptions.prototype.tilePixelRatio;
/**
* WMTS version. Default is `1.0.0`.
* @type {string|undefined}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.version;
@@ -4899,7 +4899,7 @@ olx.source.WMTSOptions.prototype.version;
/**
* Image format. Default is `image/jpeg`.
* @type {string|undefined}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.format;
@@ -4907,7 +4907,7 @@ olx.source.WMTSOptions.prototype.format;
/**
* Matrix set.
* @type {string}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.matrixSet;
@@ -4915,7 +4915,7 @@ olx.source.WMTSOptions.prototype.matrixSet;
/**
* Dimensions.
* @type {Object|undefined}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.dimensions;
@@ -4923,7 +4923,7 @@ olx.source.WMTSOptions.prototype.dimensions;
/**
* URL.
* @type {string|undefined}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.url;
@@ -4947,7 +4947,7 @@ olx.source.WMTSOptions.prototype.tileLoadFunction;
/**
* Urls.
* @type {Array.<string>|undefined}
* @api
* @api stable
*/
olx.source.WMTSOptions.prototype.urls;
@@ -4973,7 +4973,7 @@ olx.source.XYZOptions;
/**
* Attributions.
* @type {Array.<ol.Attribution>|undefined}
* @api
* @api stable
*/
olx.source.XYZOptions.prototype.attributions;
@@ -4981,7 +4981,7 @@ olx.source.XYZOptions.prototype.attributions;
/**
* Cross origin setting for image requests.
* @type {null|string|undefined}
* @api
* @api stable
*/
olx.source.XYZOptions.prototype.crossOrigin;
@@ -4989,7 +4989,7 @@ olx.source.XYZOptions.prototype.crossOrigin;
/**
* Logo.
* @type {string|olx.LogoOptions|undefined}
* @api
* @api stable
*/
olx.source.XYZOptions.prototype.logo;
@@ -5049,7 +5049,7 @@ olx.source.XYZOptions.prototype.tileUrlFunction;
/**
* URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders.
* @type {string|undefined}
* @api
* @api stable
*/
olx.source.XYZOptions.prototype.url;
@@ -5057,7 +5057,7 @@ olx.source.XYZOptions.prototype.url;
/**
* An array of URL templates.
* @type {Array.<string>|undefined}
* @api
* @api stable
*/
olx.source.XYZOptions.prototype.urls;
@@ -5085,7 +5085,7 @@ olx.source.ZoomifyOptions;
/**
* Attributions.
* @type {Array.<ol.Attribution>|undefined}
* @api
* @api stable
*/
olx.source.ZoomifyOptions.prototype.attributions;
@@ -5093,7 +5093,7 @@ olx.source.ZoomifyOptions.prototype.attributions;
/**
* Cross origin setting for image requests.
* @type {null|string|undefined}
* @api
* @api stable
*/
olx.source.ZoomifyOptions.prototype.crossOrigin;
@@ -5101,7 +5101,7 @@ olx.source.ZoomifyOptions.prototype.crossOrigin;
/**
* Logo.
* @type {string|olx.LogoOptions|undefined}
* @api
* @api stable
*/
olx.source.ZoomifyOptions.prototype.logo;
@@ -5109,7 +5109,7 @@ olx.source.ZoomifyOptions.prototype.logo;
/**
* Prefix of URL template.
* @type {!string}
* @api
* @api stable
*/
olx.source.ZoomifyOptions.prototype.url;
@@ -5117,7 +5117,7 @@ olx.source.ZoomifyOptions.prototype.url;
/**
* Tier size calculation method: `default` or `truncated`.
* @type {string|undefined}
* @api
* @api stable
*/
olx.source.ZoomifyOptions.prototype.tierSizeCalculation;
@@ -5125,7 +5125,7 @@ olx.source.ZoomifyOptions.prototype.tierSizeCalculation;
/**
* Size of the image.
* @type {ol.Size}
* @api
* @api stable
*/
olx.source.ZoomifyOptions.prototype.size;

2
src/ol/source/bingmapssource.js
View File

@@ -24,7 +24,7 @@ goog.require('ol.tilegrid.XYZ');
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.BingMapsOptions} options Bing Maps options.
* @api
* @api stable
*/
ol.source.BingMaps = function(options) {

6
src/ol/source/imagemapguidesource.js
View File

@@ -16,7 +16,7 @@ goog.require('ol.source.Image');
* @constructor
* @extends {ol.source.Image}
* @param {olx.source.ImageMapGuideOptions} options Options.
* @api
* @api stable
*/
ol.source.ImageMapGuide = function(options) {
@@ -105,7 +105,7 @@ goog.inherits(ol.source.ImageMapGuide, ol.source.Image);
* Get the user-provided params, i.e. those passed to the constructor through
* the "params" option, and possibly updated using the updateParams method.
* @return {Object} Params.
* @api
* @api stable
*/
ol.source.ImageMapGuide.prototype.getParams = function() {
return this.params_;
@@ -175,7 +175,7 @@ ol.source.ImageMapGuide.getScale = function(extent, size, metersPerUnit, dpi) {
/**
* Update the user-provided params.
* @param {Object} params Params.
* @api
* @api stable
*/
ol.source.ImageMapGuide.prototype.updateParams = function(params) {
goog.object.extend(this.params_, params);

2
src/ol/source/imagestaticsource.js
View File

@@ -15,7 +15,7 @@ goog.require('ol.source.Image');
* @constructor
* @extends {ol.source.Image}
* @param {olx.source.ImageStaticOptions} options Options.
* @api
* @api stable
*/
ol.source.ImageStatic = function(options) {

12
src/ol/source/imagewmssource.js
View File

@@ -23,7 +23,7 @@ goog.require('ol.source.wms.ServerType');
* @constructor
* @extends {ol.source.Image}
* @param {olx.source.ImageWMSOptions=} opt_options Options.
* @api
* @api stable
*/
ol.source.ImageWMS = function(opt_options) {
@@ -123,7 +123,7 @@ ol.source.ImageWMS.GETFEATUREINFO_IMAGE_SIZE_ = [101, 101];
* in the `LAYERS` parameter will be used. `VERSION` should not be
* specified here.
* @return {string|undefined} GetFeatureInfo URL.
* @api
* @api stable
*/
ol.source.ImageWMS.prototype.getGetFeatureInfoUrl =
function(coordinate, resolution, projection, params) {
@@ -163,7 +163,7 @@ ol.source.ImageWMS.prototype.getGetFeatureInfoUrl =
* Get the user-provided params, i.e. those passed to the constructor through
* the "params" option, and possibly updated using the updateParams method.
* @return {Object} Params.
* @api
* @api stable
*/
ol.source.ImageWMS.prototype.getParams = function() {
return this.params_;
@@ -304,7 +304,7 @@ ol.source.ImageWMS.prototype.getRequestUrl_ =
/**
* Return the URL used for this WMS source.
* @return {string|undefined} URL.
* @api
* @api stable
*/
ol.source.ImageWMS.prototype.getUrl = function() {
return this.url_;
@@ -313,7 +313,7 @@ ol.source.ImageWMS.prototype.getUrl = function() {
/**
* @param {string|undefined} url URL.
* @api
* @api stable
*/
ol.source.ImageWMS.prototype.setUrl = function(url) {
if (url != this.url_) {
@@ -327,7 +327,7 @@ ol.source.ImageWMS.prototype.setUrl = function(url) {
/**
* Update the user-provided params.
* @param {Object} params Params.
* @api
* @api stable
*/
ol.source.ImageWMS.prototype.updateParams = function(params) {
goog.object.extend(this.params_, params);

2
src/ol/source/mapquestsource.js
View File

@@ -15,7 +15,7 @@ goog.require('ol.source.XYZ');
* @constructor
* @extends {ol.source.XYZ}
* @param {olx.source.MapQuestOptions=} opt_options MapQuest options.
* @api
* @api stable
*/
ol.source.MapQuest = function(opt_options) {

2
src/ol/source/osmsource.js
View File

@@ -13,7 +13,7 @@ goog.require('ol.source.XYZ');
* @constructor
* @extends {ol.source.XYZ}
* @param {olx.source.OSMOptions=} opt_options Open Street Map options.
* @api
* @api stable
*/
ol.source.OSM = function(opt_options) {

4
src/ol/source/source.js
View File

@@ -91,7 +91,7 @@ ol.source.Source.prototype.forEachFeatureAtPixel =
/**
* @return {Array.<ol.Attribution>} Attributions.
* @api
* @api stable
*/
ol.source.Source.prototype.getAttributions = function() {
return this.attributions_;
@@ -100,7 +100,7 @@ ol.source.Source.prototype.getAttributions = function() {
/**
* @return {string|olx.LogoOptions|undefined} Logo.
* @api
* @api stable
*/
ol.source.Source.prototype.getLogo = function() {
return this.logo_;

2
src/ol/source/stamensource.js
View File

@@ -85,7 +85,7 @@ ol.source.StamenProviderConfig = {
* @constructor
* @extends {ol.source.XYZ}
* @param {olx.source.StamenOptions} options Stamen options.
* @api
* @api stable
*/
ol.source.Stamen = function(options) {

2
src/ol/source/tilejsonsource.js
View File

@@ -28,7 +28,7 @@ goog.require('ol.tilegrid.XYZ');
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.TileJSONOptions} options TileJSON options.
* @api
* @api stable
*/
ol.source.TileJSON = function(options) {

2
src/ol/source/tilesource.js
View File

@@ -165,7 +165,7 @@ ol.source.Tile.prototype.getTile = goog.abstractMethod;
/**
* @return {ol.tilegrid.TileGrid} Tile grid.
* @api
* @api stable
*/
ol.source.Tile.prototype.getTileGrid = function() {
return this.tileGrid;

14
src/ol/source/tilewmssource.js
View File

@@ -29,7 +29,7 @@ goog.require('ol.tilecoord');
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.TileWMSOptions=} opt_options Tile WMS options.
* @api
* @api stable
*/
ol.source.TileWMS = function(opt_options) {
@@ -123,7 +123,7 @@ goog.inherits(ol.source.TileWMS, ol.source.TileImage);
* in the `LAYERS` parameter will be used. `VERSION` should not be
* specified here.
* @return {string|undefined} GetFeatureInfo URL.
* @api
* @api stable
*/
ol.source.TileWMS.prototype.getGetFeatureInfoUrl =
function(coordinate, resolution, projection, params) {
@@ -196,7 +196,7 @@ ol.source.TileWMS.prototype.getKeyZXY = function(z, x, y) {
* Get the user-provided params, i.e. those passed to the constructor through
* the "params" option, and possibly updated using the updateParams method.
* @return {Object} Params.
* @api
* @api stable
*/
ol.source.TileWMS.prototype.getParams = function() {
return this.params_;
@@ -296,7 +296,7 @@ ol.source.TileWMS.prototype.getTilePixelSize =
/**
* Return the URLs used for this WMS source.
* @return {!Array.<string>} URLs.
* @api
* @api stable
*/
ol.source.TileWMS.prototype.getUrls = function() {
return this.urls_;
@@ -326,7 +326,7 @@ ol.source.TileWMS.prototype.resetCoordKeyPrefix_ = function() {
/**
* @param {string|undefined} url URL.
* @api
* @api stable
*/
ol.source.TileWMS.prototype.setUrl = function(url) {
var urls = goog.isDef(url) ? ol.TileUrlFunction.expandUrl(url) : null;
@@ -336,7 +336,7 @@ ol.source.TileWMS.prototype.setUrl = function(url) {
/**
* @param {Array.<string>|undefined} urls URLs.
* @api
* @api stable
*/
ol.source.TileWMS.prototype.setUrls = function(urls) {
this.urls_ = goog.isDefAndNotNull(urls) ? urls : [];
@@ -401,7 +401,7 @@ ol.source.TileWMS.prototype.tileUrlFunction_ =
/**
* Update the user-provided params.
* @param {Object} params Params.
* @api
* @api stable
*/
ol.source.TileWMS.prototype.updateParams = function(params) {
goog.object.extend(this.params_, params);

28
src/ol/source/vectorsource.js
View File

@@ -25,13 +25,13 @@ ol.source.VectorEventType = {
/**
* Triggered when a feature is added to the source.
* @event ol.source.VectorEvent#addfeature
* @api
* @api stable
*/
ADDFEATURE: 'addfeature',
/**
* Triggered when a feature is removed from the source.
* @event ol.source.VectorEvent#removefeature
* @api
* @api stable
*/
REMOVEFEATURE: 'removefeature'
};
@@ -46,7 +46,7 @@ ol.source.VectorEventType = {
* @extends {ol.source.Source}
* @fires ol.source.VectorEvent
* @param {olx.source.VectorOptions=} opt_options Vector source options.
* @api
* @api stable
*/
ol.source.Vector = function(opt_options) {
@@ -102,7 +102,7 @@ goog.inherits(ol.source.Vector, ol.source.Source);
/**
* @param {ol.Feature} feature Feature.
* @api
* @api stable
*/
ol.source.Vector.prototype.addFeature = function(feature) {
this.addFeatureInternal(feature);
@@ -148,7 +148,7 @@ ol.source.Vector.prototype.addFeatureInternal = function(feature) {
/**
* @param {Array.<ol.Feature>} features Features.
* @api
* @api stable
*/
ol.source.Vector.prototype.addFeatures = function(features) {
this.addFeaturesInternal(features);
@@ -172,7 +172,7 @@ ol.source.Vector.prototype.addFeaturesInternal = function(features) {
/**
* Remove all features.
* @api
* @api stable
*/
ol.source.Vector.prototype.clear = function() {
this.rBush_.forEach(this.removeFeatureInternal, this);
@@ -190,7 +190,7 @@ ol.source.Vector.prototype.clear = function() {
* @param {T=} opt_this The object to use as `this` in `f`.
* @return {S|undefined}
* @template T,S
* @api
* @api stable
*/
ol.source.Vector.prototype.forEachFeature = function(f, opt_this) {
return this.rBush_.forEach(f, opt_this);
@@ -249,7 +249,7 @@ ol.source.Vector.prototype.forEachFeatureInExtentAtResolution =
/**
* @return {Array.<ol.Feature>} Features.
* @api
* @api stable
*/
ol.source.Vector.prototype.getFeatures = function() {
var features = this.rBush_.getAll();
@@ -264,7 +264,7 @@ ol.source.Vector.prototype.getFeatures = function() {
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @return {Array.<ol.Feature>} Features.
* @api
* @api stable
*/
ol.source.Vector.prototype.getFeaturesAtCoordinate = function(coordinate) {
var features = [];
@@ -287,7 +287,7 @@ ol.source.Vector.prototype.getFeaturesInExtent = function(extent) {
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @return {ol.Feature} Closest feature.
* @api
* @api stable
*/
ol.source.Vector.prototype.getClosestFeatureToCoordinate =
function(coordinate) {
@@ -334,7 +334,7 @@ ol.source.Vector.prototype.getClosestFeatureToCoordinate =
/**
* Get the extent of the features currently in the source.
* @return {ol.Extent} Extent.
* @api
* @api stable
*/
ol.source.Vector.prototype.getExtent = function() {
return this.rBush_.getExtent();
@@ -348,7 +348,7 @@ ol.source.Vector.prototype.getExtent = function() {
*
* @param {string|number} id Feature identifier.
* @return {ol.Feature} The feature (or `null` if not found).
* @api
* @api stable
*/
ol.source.Vector.prototype.getFeatureById = function(id) {
var feature = this.idIndex_[id.toString()];
@@ -426,7 +426,7 @@ ol.source.Vector.prototype.loadFeatures = goog.nullFunction;
/**
* @param {ol.Feature} feature Feature.
* @api
* @api stable
*/
ol.source.Vector.prototype.removeFeature = function(feature) {
var featureKey = goog.getUid(feature).toString();
@@ -501,7 +501,7 @@ ol.source.VectorEvent = function(type, opt_feature) {
/**
* The feature being added or removed.
* @type {ol.Feature|undefined}
* @api
* @api stable
*/
this.feature = opt_feature;

7
src/ol/source/wmtssource.js
View File

@@ -34,7 +34,7 @@ ol.source.WMTSRequestEncoding = {
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.WMTSOptions} options WMTS options.
* @api
* @api stable
*/
ol.source.WMTS = function(options) {
@@ -196,7 +196,7 @@ goog.inherits(ol.source.WMTS, ol.source.TileImage);
* "dimensions" option, and possibly updated using the updateDimensions
* method.
* @return {Object} Dimensions.
* @api
* @api stable
*/
ol.source.WMTS.prototype.getDimensions = function() {
return this.dimensions_;
@@ -227,7 +227,7 @@ ol.source.WMTS.prototype.resetCoordKeyPrefix_ = function() {
/**
* Update the dimensions.
* @param {Object} dimensions Dimensions.
* @api
* @api stable
*/
ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
goog.object.extend(this.dimensions_, dimensions);
@@ -240,7 +240,6 @@ ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
* @param {Object} wmtsCap An object representing the capabilities document.
* @param {string} layer The layer identifier.
* @return {olx.source.WMTSOptions} WMTS source options object.
* @api
*/
ol.source.WMTS.optionsFromCapabilities = function(wmtsCap, layer) {

4
src/ol/source/xyzsource.js
View File

@@ -14,7 +14,7 @@ goog.require('ol.tilegrid.XYZ');
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.XYZOptions} options XYZ options.
* @api
* @api stable
*/
ol.source.XYZ = function(options) {
var projection = goog.isDef(options.projection) ?
@@ -69,7 +69,7 @@ ol.source.XYZ.prototype.setTileUrlFunction = function(tileUrlFunction) {
/**
* @param {string} url URL.
* @api
* @api stable
*/
ol.source.XYZ.prototype.setUrl = function(url) {
this.setTileUrlFunction(ol.TileUrlFunction.createFromTemplates(

2
src/ol/source/zoomifysource.js
View File

@@ -29,7 +29,7 @@ ol.source.ZoomifyTierSizeCalculation = {
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.ZoomifyOptions=} opt_options Options.
* @api
* @api stable
*/
ol.source.Zoomify = function(opt_options) {