All @api annotations imply stability
This commit is contained in:
@@ -19,7 +19,7 @@ goog.require('ol.obj');
|
||||
* @abstract
|
||||
* @extends {ol.Object}
|
||||
* @param {olx.layer.BaseOptions} options Layer options.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Base = function(options) {
|
||||
|
||||
@@ -103,7 +103,7 @@ ol.layer.Base.prototype.getLayerStatesArray = function(opt_states) {};
|
||||
* will be visible regardless of extent.
|
||||
* @return {ol.Extent|undefined} The layer extent.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Base.prototype.getExtent = function() {
|
||||
return /** @type {ol.Extent|undefined} */ (
|
||||
@@ -115,7 +115,7 @@ ol.layer.Base.prototype.getExtent = function() {
|
||||
* Return the maximum resolution of the layer.
|
||||
* @return {number} The maximum resolution of the layer.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Base.prototype.getMaxResolution = function() {
|
||||
return /** @type {number} */ (
|
||||
@@ -127,7 +127,7 @@ ol.layer.Base.prototype.getMaxResolution = function() {
|
||||
* Return the minimum resolution of the layer.
|
||||
* @return {number} The minimum resolution of the layer.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Base.prototype.getMinResolution = function() {
|
||||
return /** @type {number} */ (
|
||||
@@ -139,7 +139,7 @@ ol.layer.Base.prototype.getMinResolution = function() {
|
||||
* Return the opacity of the layer (between 0 and 1).
|
||||
* @return {number} The opacity of the layer.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Base.prototype.getOpacity = function() {
|
||||
return /** @type {number} */ (this.get(ol.layer.Property.OPACITY));
|
||||
@@ -157,7 +157,7 @@ ol.layer.Base.prototype.getSourceState = function() {};
|
||||
* Return the visibility of the layer (`true` or `false`).
|
||||
* @return {boolean} The visibility of the layer.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Base.prototype.getVisible = function() {
|
||||
return /** @type {boolean} */ (this.get(ol.layer.Property.VISIBLE));
|
||||
@@ -181,7 +181,7 @@ ol.layer.Base.prototype.getZIndex = function() {
|
||||
* will be visible at all extents.
|
||||
* @param {ol.Extent|undefined} extent The extent of the layer.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Base.prototype.setExtent = function(extent) {
|
||||
this.set(ol.layer.Property.EXTENT, extent);
|
||||
@@ -192,7 +192,7 @@ ol.layer.Base.prototype.setExtent = function(extent) {
|
||||
* Set the maximum resolution at which the layer is visible.
|
||||
* @param {number} maxResolution The maximum resolution of the layer.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Base.prototype.setMaxResolution = function(maxResolution) {
|
||||
this.set(ol.layer.Property.MAX_RESOLUTION, maxResolution);
|
||||
@@ -203,7 +203,7 @@ ol.layer.Base.prototype.setMaxResolution = function(maxResolution) {
|
||||
* Set the minimum resolution at which the layer is visible.
|
||||
* @param {number} minResolution The minimum resolution of the layer.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Base.prototype.setMinResolution = function(minResolution) {
|
||||
this.set(ol.layer.Property.MIN_RESOLUTION, minResolution);
|
||||
@@ -214,7 +214,7 @@ ol.layer.Base.prototype.setMinResolution = function(minResolution) {
|
||||
* Set the opacity of the layer, allowed values range from 0 to 1.
|
||||
* @param {number} opacity The opacity of the layer.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Base.prototype.setOpacity = function(opacity) {
|
||||
this.set(ol.layer.Property.OPACITY, opacity);
|
||||
@@ -225,7 +225,7 @@ ol.layer.Base.prototype.setOpacity = function(opacity) {
|
||||
* Set the visibility of the layer (`true` or `false`).
|
||||
* @param {boolean} visible The visibility of the layer.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Base.prototype.setVisible = function(visible) {
|
||||
this.set(ol.layer.Property.VISIBLE, visible);
|
||||
|
||||
@@ -23,7 +23,7 @@ goog.require('ol.source.State');
|
||||
* @constructor
|
||||
* @extends {ol.layer.Base}
|
||||
* @param {olx.layer.GroupOptions=} opt_options Layer options.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Group = function(opt_options) {
|
||||
|
||||
@@ -158,7 +158,7 @@ ol.layer.Group.prototype.handleLayersRemove_ = function(collectionEvent) {
|
||||
* @return {!ol.Collection.<ol.layer.Base>} Collection of
|
||||
* {@link ol.layer.Base layers} that are part of this group.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Group.prototype.getLayers = function() {
|
||||
return /** @type {!ol.Collection.<ol.layer.Base>} */ (this.get(
|
||||
@@ -172,7 +172,7 @@ ol.layer.Group.prototype.getLayers = function() {
|
||||
* @param {!ol.Collection.<ol.layer.Base>} layers Collection of
|
||||
* {@link ol.layer.Base layers} that are part of this group.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Group.prototype.setLayers = function(layers) {
|
||||
this.set(ol.layer.Group.Property_.LAYERS, layers);
|
||||
|
||||
@@ -19,7 +19,7 @@ goog.require('ol.renderer.webgl.ImageLayer');
|
||||
* @extends {ol.layer.Layer}
|
||||
* @fires ol.render.Event
|
||||
* @param {olx.layer.ImageOptions=} opt_options Layer options.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Image = function(opt_options) {
|
||||
var options = opt_options ? opt_options : {};
|
||||
@@ -47,6 +47,6 @@ ol.layer.Image.prototype.createRenderer = function(mapRenderer) {
|
||||
* Return the associated {@link ol.source.Image source} of the image layer.
|
||||
* @function
|
||||
* @return {ol.source.Image} Source.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Image.prototype.getSource;
|
||||
|
||||
@@ -31,7 +31,7 @@ goog.require('ol.source.State');
|
||||
* @extends {ol.layer.Base}
|
||||
* @fires ol.render.Event
|
||||
* @param {olx.layer.LayerOptions} options Layer options.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Layer = function(options) {
|
||||
|
||||
@@ -110,7 +110,7 @@ ol.layer.Layer.prototype.getLayerStatesArray = function(opt_states) {
|
||||
* Get the layer source.
|
||||
* @return {ol.source.Source} The layer source (or `null` if not yet set).
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Layer.prototype.getSource = function() {
|
||||
var source = this.get(ol.layer.Property.SOURCE);
|
||||
@@ -196,7 +196,7 @@ ol.layer.Layer.prototype.setMap = function(map) {
|
||||
* Set the layer source.
|
||||
* @param {ol.source.Source} source The layer source.
|
||||
* @observable
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Layer.prototype.setSource = function(source) {
|
||||
this.set(ol.layer.Property.SOURCE, source);
|
||||
|
||||
@@ -21,7 +21,7 @@ goog.require('ol.renderer.webgl.TileLayer');
|
||||
* @extends {ol.layer.Layer}
|
||||
* @fires ol.render.Event
|
||||
* @param {olx.layer.TileOptions=} opt_options Tile layer options.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Tile = function(opt_options) {
|
||||
var options = opt_options ? opt_options : {};
|
||||
@@ -69,7 +69,7 @@ ol.layer.Tile.prototype.getPreload = function() {
|
||||
* Return the associated {@link ol.source.Tile tilesource} of the layer.
|
||||
* @function
|
||||
* @return {ol.source.Tile} Source.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Tile.prototype.getSource;
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ goog.require('ol.style.Style');
|
||||
* @extends {ol.layer.Layer}
|
||||
* @fires ol.render.Event
|
||||
* @param {olx.layer.VectorOptions=} opt_options Options.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Vector = function(opt_options) {
|
||||
var options = opt_options ?
|
||||
@@ -111,7 +111,7 @@ ol.layer.Vector.prototype.getRenderOrder = function() {
|
||||
* Return the associated {@link ol.source.Vector vectorsource} of the layer.
|
||||
* @function
|
||||
* @return {ol.source.Vector} Source.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Vector.prototype.getSource;
|
||||
|
||||
@@ -121,7 +121,7 @@ ol.layer.Vector.prototype.getSource;
|
||||
* option at construction or to the `setStyle` method.
|
||||
* @return {ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction}
|
||||
* Layer style.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Vector.prototype.getStyle = function() {
|
||||
return this.style_;
|
||||
@@ -131,7 +131,7 @@ ol.layer.Vector.prototype.getStyle = function() {
|
||||
/**
|
||||
* Get the style function.
|
||||
* @return {ol.StyleFunction|undefined} Layer style function.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Vector.prototype.getStyleFunction = function() {
|
||||
return this.styleFunction_;
|
||||
@@ -174,7 +174,7 @@ ol.layer.Vector.prototype.setRenderOrder = function(renderOrder) {
|
||||
* {@link ol.style} for information on the default style.
|
||||
* @param {ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction|null|undefined}
|
||||
* style Layer style.
|
||||
* @api stable
|
||||
* @api
|
||||
*/
|
||||
ol.layer.Vector.prototype.setStyle = function(style) {
|
||||
this.style_ = style !== undefined ? style : ol.style.Style.defaultFunction;
|
||||
|
||||
Reference in New Issue
Block a user