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

Add default stability level to docs of exported things.

Browse Source
This commit is contained in:
Paul Spencer
2013-10-24 17:07:02 -04:00
parent a13c5d30a2
commit bada596b45
108 changed files with 382 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/ol/map.js
View File

@@ -87,6 +87,7 @@ ol.ENABLE_WEBGL = true;
/**
* @enum {string}
* @todo stability experimental
*/
ol.RendererHint = {
CANVAS: 'canvas',
@@ -141,6 +142,7 @@ ol.MapProperty = {
* @constructor
* @extends {ol.Object}
* @param {ol.MapOptions} options Map options.
* @todo stability experimental
*/
ol.Map = function(options) {
@@ -361,6 +363,7 @@ goog.inherits(ol.Map, ol.Object);
/**
* Add the given control to the map.
* @param {ol.control.Control} control Control.
* @todo stability experimental
*/
ol.Map.prototype.addControl = function(control) {
var controls = this.getControls();
@@ -373,6 +376,7 @@ ol.Map.prototype.addControl = function(control) {
/**
* Adds the given layer to the top of this map.
* @param {ol.layer.Base} layer Layer.
* @todo stability experimental
*/
ol.Map.prototype.addLayer = function(layer) {
var layers = this.getLayerGroup().getLayers();
@@ -384,6 +388,7 @@ ol.Map.prototype.addLayer = function(layer) {
/**
* Add the given overlay to the map.
* @param {ol.Overlay} overlay Overlay.
* @todo stability experimental
*/
ol.Map.prototype.addOverlay = function(overlay) {
var overlays = this.getOverlays();
@@ -398,6 +403,7 @@ ol.Map.prototype.addOverlay = function(overlay) {
* animations before updating the map's view. The {@link ol.animation}
* namespace provides several static methods for creating prerender functions.
* @param {...ol.PreRenderFunction} var_args Any number of pre-render functions.
* @todo stability experimental
*/
ol.Map.prototype.beforeRender = function(var_args) {
this.requestRenderFrame();
@@ -436,6 +442,7 @@ ol.Map.prototype.freezeRendering = function() {
* Returns the map pixel position for a a browser event.
* @param {Event} event Event.
* @return {ol.Coordinate} Coordinate.
* @todo stability experimental
*/
ol.Map.prototype.getEventCoordinate = function(event) {
return this.getCoordinateFromPixel(this.getEventPixel(event));
@@ -446,6 +453,7 @@ ol.Map.prototype.getEventCoordinate = function(event) {
* Returns the geographical coordinate for a browser event.
* @param {Event} event Event.
* @return {ol.Pixel} Pixel.
* @todo stability experimental
*/
ol.Map.prototype.getEventPixel = function(event) {
// goog.style.getRelativePosition is based on event.targetTouches,
@@ -470,6 +478,7 @@ ol.Map.prototype.getEventPixel = function(event) {
/**
* Get the map's renderer.
* @return {ol.renderer.Map} Renderer.
* @todo stability experimental
*/
ol.Map.prototype.getRenderer = function() {
return this.renderer_;
@@ -479,6 +488,7 @@ ol.Map.prototype.getRenderer = function() {
/**
* Get the element in which this map is rendered.
* @return {Element|string|undefined} Target.
* @todo stability experimental
*/
ol.Map.prototype.getTarget = function() {
return /** @type {Element|string|undefined} */ (
@@ -507,6 +517,7 @@ ol.Map.prototype.getCoordinateFromPixel = function(pixel) {
/**
* @return {ol.Collection} Controls.
* @todo stability experimental
*/
ol.Map.prototype.getControls = function() {
return this.controls_;
@@ -515,6 +526,7 @@ ol.Map.prototype.getControls = function() {
/**
* @return {ol.Collection} Overlays.
* @todo stability experimental
*/
ol.Map.prototype.getOverlays = function() {
return this.overlays_;
@@ -525,6 +537,7 @@ ol.Map.prototype.getOverlays = function() {
* Get feature information for a pixel on the map.
*
* @param {ol.GetFeatureInfoOptions} options Options.
* @todo stability experimental
*/
ol.Map.prototype.getFeatureInfo = function(options) {
var layers = goog.isDefAndNotNull(options.layers) ?
@@ -538,6 +551,7 @@ ol.Map.prototype.getFeatureInfo = function(options) {
* Get features for a pixel on the map.
*
* @param {ol.GetFeaturesOptions} options Options.
* @todo stability experimental
*/
ol.Map.prototype.getFeatures = function(options) {
var layers = goog.isDefAndNotNull(options.layers) ?
@@ -555,6 +569,7 @@ ol.Map.prototype.getFeatures = function(options) {
*
* Interactions are used for e.g. pan, zoom and rotate.
* @return {ol.Collection} Interactions.
* @todo stability experimental
*/
ol.Map.prototype.getInteractions = function() {
return this.interactions_;
@@ -564,6 +579,7 @@ ol.Map.prototype.getInteractions = function() {
/**
* Get the layergroup associated with this map.
* @return {ol.layer.Group} LayerGroup.
* @todo stability experimental
*/
ol.Map.prototype.getLayerGroup = function() {
return /** @type {ol.layer.Group} */ (
@@ -578,6 +594,7 @@ goog.exportProperty(
/**
* Get the collection of layers associated with this map.
* @return {ol.Collection} Layers.
* @todo stability experimental
*/
ol.Map.prototype.getLayers = function() {
return this.getLayerGroup().getLayers();
@@ -602,6 +619,7 @@ ol.Map.prototype.getPixelFromCoordinate = function(coordinate) {
/**
* Get the size of this map.
* @return {ol.Size|undefined} Size.
* @todo stability experimental
*/
ol.Map.prototype.getSize = function() {
return /** @type {ol.Size|undefined} */ (this.get(ol.MapProperty.SIZE));
@@ -616,6 +634,7 @@ goog.exportProperty(
* Get the view associated with this map. This can be a 2D or 3D view. A 2D
* view manages properties such as center and resolution.
* @return {ol.View} View.
* @todo stability experimental
*/
ol.Map.prototype.getView = function() {
return /** @type {ol.View} */ (this.get(ol.MapProperty.VIEW));
@@ -628,6 +647,7 @@ goog.exportProperty(
/**
* @return {Element} Viewport.
* @todo stability experimental
*/
ol.Map.prototype.getViewport = function() {
return this.viewport_;
@@ -918,6 +938,7 @@ ol.Map.prototype.requestRenderFrame = function() {
* @param {ol.control.Control} control Control.
* @return {ol.control.Control|undefined} The removed control of undefined
* if the control was not found.
* @todo stability experimental
*/
ol.Map.prototype.removeControl = function(control) {
var controls = this.getControls();
@@ -935,6 +956,7 @@ ol.Map.prototype.removeControl = function(control) {
* @param {ol.layer.Base} layer Layer.
* @return {ol.layer.Base|undefined} The removed layer or undefined if the
* layer was not found.
* @todo stability experimental
*/
ol.Map.prototype.removeLayer = function(layer) {
var layers = this.getLayerGroup().getLayers();
@@ -948,6 +970,7 @@ ol.Map.prototype.removeLayer = function(layer) {
* @param {ol.Overlay} overlay Overlay.
* @return {ol.Overlay|undefined} The removed overlay of undefined
* if the overlay was not found.
* @todo stability experimental
*/
ol.Map.prototype.removeOverlay = function(overlay) {
var overlays = this.getOverlays();
@@ -1059,6 +1082,7 @@ ol.Map.prototype.renderFrame_ = function(time) {
/**
* Sets the layergroup of this map.
* @param {ol.layer.Group} layerGroup Layergroup.
* @todo stability experimental
*/
ol.Map.prototype.setLayerGroup = function(layerGroup) {
this.set(ol.MapProperty.LAYERGROUP, layerGroup);
@@ -1072,6 +1096,7 @@ goog.exportProperty(
/**
* Set the size of this map.
* @param {ol.Size|undefined} size Size.
* @todo stability experimental
*/
ol.Map.prototype.setSize = function(size) {
this.set(ol.MapProperty.SIZE, size);
@@ -1085,6 +1110,7 @@ goog.exportProperty(
/**
* Set the target element to render this map into.
* @param {Element|string|undefined} target Target.
* @todo stability experimental
*/
ol.Map.prototype.setTarget = function(target) {
this.set(ol.MapProperty.TARGET, target);
@@ -1098,6 +1124,7 @@ goog.exportProperty(
/**
* Set the view for this map.
* @param {ol.IView} view View.
* @todo stability experimental
*/
ol.Map.prototype.setView = function(view) {
this.set(ol.MapProperty.VIEW, view);
@@ -1122,6 +1149,7 @@ ol.Map.prototype.unfreezeRendering = function() {
/**
* Force a recalculation of the map viewport size. This should be called when
* third-party code changes the size of the map viewport.
* @todo stability experimental
*/
ol.Map.prototype.updateSize = function() {
var target = this.getTarget();