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

Merge pull request #1626 from twpayne/api-stability

Browse Source 
Add @todo stability experimental to many classes and methods
This commit is contained in:
Tom Payne
2014-02-03 06:47:43 -08:00
parent 88f0f99fa3 6f0947a697
commit 8731766f63
33 changed files with 110 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/ol/feature.js
View File

@@ -24,6 +24,7 @@ ol.FeatureProperty = {
* @extends {ol.Object}
* @param {ol.geom.Geometry|Object.<string, *>=} opt_geometryOrValues
* Values or geometry.
* @todo stability experimental
*/
ol.Feature = function(opt_geometryOrValues) {
@@ -72,6 +73,7 @@ goog.inherits(ol.Feature, ol.Object);
/**
* @return {ol.geom.Geometry|undefined} Geometry.
* @todo stability experimental
*/
ol.Feature.prototype.getGeometry = function() {
return /** @type {ol.geom.Geometry|undefined} */ (
@@ -85,6 +87,7 @@ goog.exportProperty(
/**
* @return {number|string|undefined} Id.
* @todo stability experimental
*/
ol.Feature.prototype.getId = function() {
return this.id_;
@@ -93,6 +96,7 @@ ol.Feature.prototype.getId = function() {
/**
* @return {string} Geometry property name.
* @todo stability experimental
*/
ol.Feature.prototype.getGeometryName = function() {
return this.geometryName_;
@@ -101,6 +105,7 @@ ol.Feature.prototype.getGeometryName = function() {
/**
* @return {ol.feature.FeatureStyleFunction|undefined} Style function.
* @todo stability experimental
*/
ol.Feature.prototype.getStyleFunction = function() {
return /** @type {ol.feature.FeatureStyleFunction|undefined} */ (
@@ -147,6 +152,7 @@ ol.Feature.prototype.handleStyleFunctionChange_ = function() {
/**
* @param {ol.geom.Geometry|undefined} geometry Geometry.
* @todo stability experimental
*/
ol.Feature.prototype.setGeometry = function(geometry) {
this.set(this.geometryName_, geometry);
@@ -159,7 +165,8 @@ goog.exportProperty(
/**
* @param {ol.feature.FeatureStyleFunction|undefined} styleFunction Style
* function.
* function
* @todo stability experimental
*/
ol.Feature.prototype.setStyleFunction = function(styleFunction) {
this.set(ol.FeatureProperty.STYLE_FUNCTION, styleFunction);
@@ -172,6 +179,7 @@ goog.exportProperty(
/**
* @param {number|string|undefined} id Id.
* @todo stability experimental
*/
ol.Feature.prototype.setId = function(id) {
this.id_ = id;
@@ -180,6 +188,7 @@ ol.Feature.prototype.setId = function(id) {
/**
* @param {string} name Geometry property name.
* @todo stability experimental
*/
ol.Feature.prototype.setGeometryName = function(name) {
goog.events.unlisten(
@@ -195,6 +204,7 @@ ol.Feature.prototype.setGeometryName = function(name) {
/**
* @typedef {function(this: ol.Feature, number): Array.<ol.style.Style>}
* @todo stability experimental
*/
ol.feature.FeatureStyleFunction;
@@ -203,12 +213,14 @@ ol.feature.FeatureStyleFunction;
* @param {number} resolution Resolution.
* @return {Array.<ol.style.Style>} Style.
* @this {ol.Feature}
* @todo stability experimental
*/
ol.feature.defaultFeatureStyleFunction = goog.functions.constant([]);
/**
* @typedef {function(ol.Feature, number): Array.<ol.style.Style>}
* @todo stability experimental
*/
ol.feature.StyleFunction;
@@ -217,6 +229,7 @@ ol.feature.StyleFunction;
* @param {ol.Feature} feature Feature.
* @param {number} resolution Resolution.
* @return {Array.<ol.style.Style>} Style.
* @todo stability experimental
*/
ol.feature.defaultStyleFunction = function(feature, resolution) {
var featureStyleFunction = feature.getStyleFunction();

1
src/ol/format/geojsonformat.js
View File

@@ -24,6 +24,7 @@ goog.require('ol.proj');
* @constructor
* @extends {ol.format.JSON}
* @param {olx.format.GeoJSONOptions=} opt_options Options.
* @todo stability experimental
*/
ol.format.GeoJSON = function(opt_options) {

1
src/ol/format/gpxformat.js
View File

@@ -18,6 +18,7 @@ goog.require('ol.xml');
/**
* @constructor
* @extends {ol.format.XML}
* @todo stability experimental
*/
ol.format.GPX = function() {
goog.base(this);

1
src/ol/format/igcformat.js
View File

@@ -25,6 +25,7 @@ ol.format.IGCZ = {
* @constructor
* @extends {ol.format.Text}
* @param {olx.format.IGCOptions=} opt_options Options.
* @todo stability experimental
*/
ol.format.IGC = function(opt_options) {

2
src/ol/format/kmlformat.js
View File

@@ -62,6 +62,7 @@ ol.format.KMLGxTrackObject_;
* @constructor
* @extends {ol.format.XML}
* @param {olx.format.KMLOptions=} opt_options Options.
* @todo stability experimental
*/
ol.format.KML = function(opt_options) {
@@ -1572,6 +1573,7 @@ ol.format.KML.prototype.readFeaturesFromNode = function(node) {
/**
* @param {Document|Node|string} source Souce.
* @return {string|undefined} Name.
* @todo stability experimental
*/
ol.format.KML.prototype.readName = function(source) {
if (source instanceof Document) {

1
src/ol/format/topojsonformat.js
View File

@@ -19,6 +19,7 @@ goog.require('ol.proj');
* @constructor
* @extends {ol.format.JSON}
* @param {olx.format.TopoJSONOptions=} opt_options Options.
* @todo stability experimental
*/
ol.format.TopoJSON = function(opt_options) {

6
src/ol/geom/circle.js
View File

@@ -14,6 +14,7 @@ goog.require('ol.geom.flat');
* @param {ol.geom.RawPoint} center Center.
* @param {number=} opt_radius Radius.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.Circle = function(center, opt_radius, opt_layout) {
goog.base(this);
@@ -77,6 +78,7 @@ ol.geom.Circle.prototype.containsXY = function(x, y) {
/**
* @return {ol.geom.RawPoint} Center.
* @todo stability experimental
*/
ol.geom.Circle.prototype.getCenter = function() {
return this.flatCoordinates.slice(0, this.stride);
@@ -103,6 +105,7 @@ ol.geom.Circle.prototype.getExtent = function(opt_extent) {
/**
* @return {number} Radius.
* @todo stability experimental
*/
ol.geom.Circle.prototype.getRadius = function() {
return Math.sqrt(this.getRadiusSquared_());
@@ -138,6 +141,7 @@ ol.geom.Circle.prototype.getType = function() {
/**
* @param {ol.geom.RawPoint} center Center.
* @todo stability experimental
*/
ol.geom.Circle.prototype.setCenter = function(center) {
var stride = this.stride;
@@ -157,6 +161,7 @@ ol.geom.Circle.prototype.setCenter = function(center) {
* @param {ol.geom.RawPoint} center Center.
* @param {number} radius Radius.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.Circle.prototype.setCenterAndRadius =
function(center, radius, opt_layout) {
@@ -195,6 +200,7 @@ ol.geom.Circle.prototype.setFlatCoordinates =
/**
* @param {number} radius Radius.
* @todo stability experimental
*/
ol.geom.Circle.prototype.setRadius = function(radius) {
goog.asserts.assert(!goog.isNull(this.flatCoordinates));

7
src/ol/geom/geometry.js
View File

@@ -37,6 +37,7 @@ ol.geom.GeometryLayout = {
/**
* @constructor
* @extends {ol.Observable}
* @todo stability experimental
*/
ol.geom.Geometry = function() {
@@ -78,6 +79,7 @@ goog.inherits(ol.geom.Geometry, ol.Observable);
/**
* @return {ol.geom.Geometry} Clone.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.clone = goog.abstractMethod;
@@ -96,6 +98,7 @@ ol.geom.Geometry.prototype.closestPointXY = goog.abstractMethod;
* @param {ol.Coordinate} point Point.
* @param {ol.Coordinate=} opt_closestPoint Closest point.
* @return {ol.Coordinate} Closest point.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
var closestPoint = goog.isDef(opt_closestPoint) ?
@@ -108,6 +111,7 @@ ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @return {boolean} Contains coordinate.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.containsCoordinate = function(coordinate) {
return this.containsXY(coordinate[0], coordinate[1]);
@@ -125,6 +129,7 @@ ol.geom.Geometry.prototype.containsXY = goog.functions.FALSE;
/**
* @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} extent Extent.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.getExtent = goog.abstractMethod;
@@ -138,12 +143,14 @@ ol.geom.Geometry.prototype.getSimplifiedGeometry = goog.abstractMethod;
/**
* @return {ol.geom.GeometryType} Geometry type.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.getType = goog.abstractMethod;
/**
* @param {ol.TransformFunction} transformFn Transform.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.transform = goog.abstractMethod;

4
src/ol/geom/geometrycollection.js
View File

@@ -13,6 +13,7 @@ goog.require('ol.geom.GeometryType');
* @constructor
* @extends {ol.geom.Geometry}
* @param {Array.<ol.geom.Geometry>=} opt_geometries Geometries.
* @todo stability experimental
*/
ol.geom.GeometryCollection = function(opt_geometries) {
@@ -108,6 +109,7 @@ ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) {
/**
* @return {Array.<ol.geom.Geometry>} Geometries.
* @todo stability experimental
*/
ol.geom.GeometryCollection.prototype.getGeometries = function() {
return ol.geom.GeometryCollection.cloneGeometries_(this.geometries_);
@@ -176,6 +178,7 @@ ol.geom.GeometryCollection.prototype.getType = function() {
/**
* @return {boolean} Is empty.
* @todo stability experimental
*/
ol.geom.GeometryCollection.prototype.isEmpty = function() {
return goog.array.isEmpty(this.geometries_);
@@ -184,6 +187,7 @@ ol.geom.GeometryCollection.prototype.isEmpty = function() {
/**
* @param {Array.<ol.geom.Geometry>} geometries Geometries.
* @todo stability experimental
*/
ol.geom.GeometryCollection.prototype.setGeometries = function(geometries) {
this.setGeometriesArray(

4
src/ol/geom/linearring.js
View File

@@ -14,6 +14,7 @@ goog.require('ol.geom.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.LinearRing = function(coordinates, opt_layout) {
@@ -69,6 +70,7 @@ ol.geom.LinearRing.prototype.closestPointXY =
/**
* @return {number} Area.
* @todo stability experimental
*/
ol.geom.LinearRing.prototype.getArea = function() {
return ol.geom.flat.linearRingArea(
@@ -78,6 +80,7 @@ ol.geom.LinearRing.prototype.getArea = function() {
/**
* @return {ol.geom.RawLinearRing} Coordinates.
* @todo stability experimental
*/
ol.geom.LinearRing.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinates(
@@ -112,6 +115,7 @@ ol.geom.LinearRing.prototype.getType = function() {
/**
* @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.LinearRing.prototype.setCoordinates =
function(coordinates, opt_layout) {

4
src/ol/geom/linestring.js
View File

@@ -14,6 +14,7 @@ goog.require('ol.geom.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.LineString = function(coordinates, opt_layout) {
@@ -69,6 +70,7 @@ ol.geom.LineString.prototype.closestPointXY =
/**
* @return {ol.geom.RawLineString} Coordinates.
* @todo stability experimental
*/
ol.geom.LineString.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinates(
@@ -78,6 +80,7 @@ ol.geom.LineString.prototype.getCoordinates = function() {
/**
* @return {number} Length.
* @todo stability experimental
*/
ol.geom.LineString.prototype.getLength = function() {
return ol.geom.flat.lineStringLength(
@@ -112,6 +115,7 @@ ol.geom.LineString.prototype.getType = function() {
/**
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.LineString.prototype.setCoordinates =
function(coordinates, opt_layout) {

5
src/ol/geom/multilinestring.js
View File

@@ -17,6 +17,7 @@ goog.require('ol.geom.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.MultiLineString = function(coordinates, opt_layout) {
@@ -79,6 +80,7 @@ ol.geom.MultiLineString.prototype.closestPointXY =
/**
* @return {ol.geom.RawMultiLineString} Coordinates.
* @todo stability experimental
*/
ol.geom.MultiLineString.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinatess(
@@ -96,6 +98,7 @@ ol.geom.MultiLineString.prototype.getEnds = function() {
/**
* @return {Array.<ol.geom.LineString>} LineStrings.
* @todo stability experimental
*/
ol.geom.MultiLineString.prototype.getLineStrings = function() {
// FIXME we should construct the line strings from the flat coordinates
@@ -137,6 +140,7 @@ ol.geom.MultiLineString.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.MultiLineString.prototype.setCoordinates =
function(coordinates, opt_layout) {
@@ -170,6 +174,7 @@ ol.geom.MultiLineString.prototype.setFlatCoordinates =
/**
* @param {Array.<ol.geom.LineString>} lineStrings LineStrings.
* @todo stability experimental
*/
ol.geom.MultiLineString.prototype.setLineStrings = function(lineStrings) {
var layout = ol.geom.GeometryLayout.XY;

4
src/ol/geom/multipoint.js
View File

@@ -13,6 +13,7 @@ goog.require('ol.geom.flat');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.MultiPoint = function(coordinates, opt_layout) {
goog.base(this);
@@ -60,6 +61,7 @@ ol.geom.MultiPoint.prototype.closestPointXY =
/**
* @return {ol.geom.RawMultiPoint} Coordinates.
* @todo stability experimental
*/
ol.geom.MultiPoint.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinates(
@@ -69,6 +71,7 @@ ol.geom.MultiPoint.prototype.getCoordinates = function() {
/**
* @return {Array.<ol.geom.Point>} Points.
* @todo stability experimental
*/
ol.geom.MultiPoint.prototype.getPoints = function() {
// FIXME we should construct the points from the flat coordinates
@@ -93,6 +96,7 @@ ol.geom.MultiPoint.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.MultiPoint.prototype.setCoordinates =
function(coordinates, opt_layout) {

5
src/ol/geom/multipolygon.js
View File

@@ -15,6 +15,7 @@ goog.require('ol.geom.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.MultiPolygon = function(coordinates, opt_layout) {
@@ -110,6 +111,7 @@ ol.geom.MultiPolygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
* @todo stability experimental
*/
ol.geom.MultiPolygon.prototype.getArea = function() {
return ol.geom.flat.linearRingssArea(
@@ -119,6 +121,7 @@ ol.geom.MultiPolygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawMultiPolygon} Coordinates.
* @todo stability experimental
*/
ol.geom.MultiPolygon.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinatesss(
@@ -189,6 +192,7 @@ ol.geom.MultiPolygon.prototype.getSimplifiedGeometryInternal =
/**
* @return {Array.<ol.geom.Polygon>} Polygons.
* @todo stability experimental
*/
ol.geom.MultiPolygon.prototype.getPolygons = function() {
var layout = this.layout;
@@ -221,6 +225,7 @@ ol.geom.MultiPolygon.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.MultiPolygon.prototype.setCoordinates =
function(coordinates, opt_layout) {

3
src/ol/geom/point.js
View File

@@ -13,6 +13,7 @@ goog.require('ol.geom.flat');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.Point = function(coordinates, opt_layout) {
goog.base(this);
@@ -55,6 +56,7 @@ ol.geom.Point.prototype.closestPointXY =
/**
* @return {ol.geom.RawPoint} Coordinates.
* @todo stability experimental
*/
ol.geom.Point.prototype.getCoordinates = function() {
return this.flatCoordinates.slice();
@@ -86,6 +88,7 @@ ol.geom.Point.prototype.getType = function() {
/**
* @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) {
if (goog.isNull(coordinates)) {

5
src/ol/geom/polygon.js
View File

@@ -15,6 +15,7 @@ goog.require('ol.geom.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.Polygon = function(coordinates, opt_layout) {
@@ -110,6 +111,7 @@ ol.geom.Polygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
* @todo stability experimental
*/
ol.geom.Polygon.prototype.getArea = function() {
return ol.geom.flat.linearRingsArea(
@@ -119,6 +121,7 @@ ol.geom.Polygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawPolygon} Coordinates.
* @todo stability experimental
*/
ol.geom.Polygon.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinatess(
@@ -151,6 +154,7 @@ ol.geom.Polygon.prototype.getInteriorPoint = function() {
/**
* @return {Array.<ol.geom.LinearRing>} Linear rings.
* @todo stability experimental
*/
ol.geom.Polygon.prototype.getLinearRings = function() {
var layout = this.layout;
@@ -219,6 +223,7 @@ ol.geom.Polygon.prototype.getType = function() {
/**
* @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {
if (goog.isNull(coordinates)) {

2
src/ol/geom/simplegeometry.js
View File

@@ -12,6 +12,7 @@ goog.require('ol.geom.flat');
/**
* @constructor
* @extends {ol.geom.Geometry}
* @todo stability experimental
*/
ol.geom.SimpleGeometry = function() {
@@ -107,6 +108,7 @@ ol.geom.SimpleGeometry.prototype.getFlatCoordinates = function() {
/**
* @return {ol.geom.GeometryLayout} Layout.
* @todo stability experimental
*/
ol.geom.SimpleGeometry.prototype.getLayout = function() {
return this.layout;

1
src/ol/interaction/drawinteraction.js
View File

@@ -61,6 +61,7 @@ goog.inherits(ol.DrawEvent, goog.events.Event);
* @constructor
* @extends {ol.interaction.Interaction}
* @param {olx.interaction.DrawOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.Draw = function(opt_options) {

2
src/ol/interaction/selectinteraction.js
View File

@@ -12,6 +12,7 @@ goog.require('ol.render.FeaturesOverlay');
* @constructor
* @extends {ol.interaction.Interaction}
* @param {olx.interaction.SelectOptions=} opt_options Options.
* @todo stability experimental
*/
ol.interaction.Select = function(opt_options) {
@@ -78,6 +79,7 @@ goog.inherits(ol.interaction.Select, ol.interaction.Interaction);
/**
* @return {ol.render.FeaturesOverlay} Features overlay.
* @todo stability experimental
*/
ol.interaction.Select.prototype.getFeaturesOverlay = function() {
return this.featuresOverlay_;

5
src/ol/layer/vectorlayer.js
View File

@@ -18,6 +18,7 @@ ol.layer.VectorProperty = {
* @constructor
* @extends {ol.layer.Layer}
* @param {olx.layer.VectorOptions=} opt_options Options.
* @todo stability experimental
*/
ol.layer.Vector = function(opt_options) {
@@ -37,6 +38,7 @@ goog.inherits(ol.layer.Vector, ol.layer.Layer);
/**
* @return {ol.Collection|undefined} Render geometry functions.
* @todo stability experimental
*/
ol.layer.Vector.prototype.getRenderGeometryFunctions = function() {
return /** @type {ol.Collection|undefined} */ (
@@ -50,6 +52,7 @@ goog.exportProperty(
/**
* @return {ol.feature.StyleFunction|undefined} Style function.
* @todo stability experimental
*/
ol.layer.Vector.prototype.getStyleFunction = function() {
return /** @type {ol.feature.StyleFunction|undefined} */ (
@@ -64,6 +67,7 @@ goog.exportProperty(
/**
* @param {ol.Collection|undefined} renderGeometryFunctions Render geometry
* functions.
* @todo stability experimental
*/
ol.layer.Vector.prototype.setRenderGeometryFunctions =
function(renderGeometryFunctions) {
@@ -81,6 +85,7 @@ goog.exportProperty(
* value returned by the style function then `dispatchChangeEvent` should be
* called on the layer for the layer to be refreshed on the screen.
* @param {ol.feature.StyleFunction|undefined} styleFunction Style function.
* @todo stability experimental
*/
ol.layer.Vector.prototype.setStyleFunction = function(styleFunction) {
this.set(ol.layer.VectorProperty.STYLE_FUNCTION, styleFunction);

1
src/ol/object.js
View File

@@ -343,6 +343,7 @@ ol.Object.prototype.getKeys = function() {
/**
* Get an object of all property names and values.
* @return {Object.<string, *>} Object.
* @todo stability experimental
*/
ol.Object.prototype.getProperties = function() {
var properties = {};

3
src/ol/observable.js
View File

@@ -30,7 +30,7 @@ goog.inherits(ol.Observable, goog.events.EventTarget);
/**
* FIXME empty description for jsdoc
* @todo stability experimental
*/
ol.Observable.prototype.dispatchChangeEvent = function() {
++this.revision_;
@@ -40,6 +40,7 @@ ol.Observable.prototype.dispatchChangeEvent = function() {
/**
* @return {number} Revision.
* @todo stability experimental
*/
ol.Observable.prototype.getRevision = function() {
return this.revision_;

7
src/ol/render/featuresoverlay.js
View File

@@ -16,6 +16,7 @@ goog.require('ol.render.EventType');
/**
* @constructor
* @param {olx.render.FeaturesOverlayOptions=} opt_options Options.
* @todo stability experimental
*/
ol.render.FeaturesOverlay = function(opt_options) {
@@ -81,6 +82,7 @@ ol.render.FeaturesOverlay = function(opt_options) {
/**
* @param {ol.Feature} feature Feature.
* @todo stability experimental
*/
ol.render.FeaturesOverlay.prototype.addFeature = function(feature) {
this.features_.push(feature);
@@ -89,6 +91,7 @@ ol.render.FeaturesOverlay.prototype.addFeature = function(feature) {
/**
* @return {ol.Collection} Features collection.
* @todo stability experimental
*/
ol.render.FeaturesOverlay.prototype.getFeatures = function() {
return this.features_;
@@ -156,6 +159,7 @@ ol.render.FeaturesOverlay.prototype.handleMapPostCompose_ = function(event) {
/**
* @param {ol.Feature} feature Feature.
* @todo stability experimental
*/
ol.render.FeaturesOverlay.prototype.removeFeature = function(feature) {
this.features_.remove(feature);
@@ -174,6 +178,7 @@ ol.render.FeaturesOverlay.prototype.requestRenderFrame_ = function() {
/**
* @param {ol.Collection} features Features collection.
* @todo stability experimental
*/
ol.render.FeaturesOverlay.prototype.setFeatures = function(features) {
if (!goog.isNull(this.featuresListenerKeys_)) {
@@ -211,6 +216,7 @@ ol.render.FeaturesOverlay.prototype.setFeatures = function(features) {
/**
* @param {ol.Map} map Map.
* @todo stability experimental
*/
ol.render.FeaturesOverlay.prototype.setMap = function(map) {
if (!goog.isNull(this.postComposeListenerKey_)) {
@@ -230,6 +236,7 @@ ol.render.FeaturesOverlay.prototype.setMap = function(map) {
/**
* @param {ol.feature.StyleFunction} styleFunction Style function.
* @todo stability experimental
*/
ol.render.FeaturesOverlay.prototype.setStyleFunction = function(styleFunction) {
this.styleFunction_ = styleFunction;

1
src/ol/source/geojsonsource.js
View File

@@ -9,6 +9,7 @@ goog.require('ol.source.VectorFile');
* @constructor
* @extends {ol.source.VectorFile}
* @param {olx.source.GeoJSONOptions=} opt_options Options.
* @todo stability experimental
*/
ol.source.GeoJSON = function(opt_options) {

1
src/ol/source/gpxsource.js
View File

@@ -9,6 +9,7 @@ goog.require('ol.source.VectorFile');
* @constructor
* @extends {ol.source.VectorFile}
* @param {olx.source.GPXOptions=} opt_options Options.
* @todo stability experimental
*/
ol.source.GPX = function(opt_options) {

1
src/ol/source/igcsource.js
View File

@@ -9,6 +9,7 @@ goog.require('ol.source.VectorFile');
* @constructor
* @extends {ol.source.VectorFile}
* @param {olx.source.IGCOptions=} opt_options Options.
* @todo stability experimental
*/
ol.source.IGC = function(opt_options) {

1
src/ol/source/imagecanvassource.js
View File

@@ -11,6 +11,7 @@ goog.require('ol.source.Image');
* @constructor
* @extends {ol.source.Image}
* @param {olx.source.ImageCanvasOptions} options
* @todo stability experimental
*/
ol.source.ImageCanvas = function(options) {

1
src/ol/source/imagevectorsource.js
View File

@@ -31,6 +31,7 @@ goog.require('ol.vec.Mat4');
* @constructor
* @extends {ol.source.ImageCanvas}
* @param {olx.source.ImageVectorOptions} options Options.
* @todo stability experimental
*/
ol.source.ImageVector = function(options) {

1
src/ol/source/kmlsource.js
View File

@@ -9,6 +9,7 @@ goog.require('ol.source.VectorFile');
* @constructor
* @extends {ol.source.VectorFile}
* @param {olx.source.KMLOptions=} opt_options Options.
* @todo stability experimental
*/
ol.source.KML = function(opt_options) {

1
src/ol/source/topojsonsource.js
View File

@@ -9,6 +9,7 @@ goog.require('ol.source.VectorFile');
* @constructor
* @extends {ol.source.VectorFile}
* @param {olx.source.TopoJSONOptions=} opt_options Options.
* @todo stability experimental
*/
ol.source.TopoJSON = function(opt_options) {

1
src/ol/source/vectorfilesource.js
View File

@@ -16,6 +16,7 @@ goog.require('ol.source.Vector');
* @constructor
* @extends {ol.source.Vector}
* @param {olx.source.VectorFileOptions=} opt_options Options.
* @todo stability experimental
*/
ol.source.VectorFile = function(opt_options) {

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

@@ -72,6 +72,7 @@ goog.inherits(ol.source.Vector, ol.source.Source);
/**
* @param {ol.Feature} feature Feature.
* @todo stability experimental
*/
ol.source.Vector.prototype.addFeature = function(feature) {
this.addFeatureInternal(feature);
@@ -103,6 +104,7 @@ ol.source.Vector.prototype.addFeatureInternal = function(feature) {
/**
* @param {Array.<ol.Feature>} features Features.
* @todo stability experimental
*/
ol.source.Vector.prototype.addFeatures = function(features) {
this.addFeaturesInternal(features);
@@ -125,7 +127,7 @@ ol.source.Vector.prototype.addFeaturesInternal = function(features) {
/**
* FIXME empty description for jsdoc
* @todo stability experimental
*/
ol.source.Vector.prototype.clear = function() {
this.rBush_.forEach(this.removeFeatureInternal, this);
@@ -143,6 +145,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
* @todo stability experimental
*/
ol.source.Vector.prototype.forEachFeature = function(f, opt_this) {
return this.rBush_.forEach(f, opt_this);
@@ -155,6 +158,7 @@ ol.source.Vector.prototype.forEachFeature = function(f, opt_this) {
* @param {T=} opt_this The object to use as `this` in `f`.
* @return {S|undefined}
* @template T,S
* @todo stability experimental
*/
ol.source.Vector.prototype.forEachFeatureAtCoordinate =
function(coordinate, f, opt_this) {
@@ -177,6 +181,7 @@ ol.source.Vector.prototype.forEachFeatureAtCoordinate =
* @param {T=} opt_this The object to use as `this` in `f`.
* @return {S|undefined}
* @template T,S
* @todo stability experimental
*/
ol.source.Vector.prototype.forEachFeatureInExtent =
function(extent, f, opt_this) {
@@ -186,6 +191,7 @@ ol.source.Vector.prototype.forEachFeatureInExtent =
/**
* @return {Array.<ol.Feature>} Features.
* @todo stability experimental
*/
ol.source.Vector.prototype.getAllFeatures = function() {
var features = this.rBush_.getAll();
@@ -200,6 +206,7 @@ ol.source.Vector.prototype.getAllFeatures = function() {
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @return {Array.<ol.Feature>} Features.
* @todo stability experimental
*/
ol.source.Vector.prototype.getAllFeaturesAtCoordinate = function(coordinate) {
var features = [];
@@ -213,6 +220,7 @@ ol.source.Vector.prototype.getAllFeaturesAtCoordinate = function(coordinate) {
/**
* @param {ol.Extent} extent Extent.
* @return {Array.<ol.Feature>} Features.
* @todo stability experimental
*/
ol.source.Vector.prototype.getAllFeaturesInExtent = function(extent) {
return this.rBush_.getAllInExtent(extent);
@@ -222,6 +230,7 @@ ol.source.Vector.prototype.getAllFeaturesInExtent = function(extent) {
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @return {ol.Feature} Closest feature.
* @todo stability experimental
*/
ol.source.Vector.prototype.getClosestFeatureToCoordinate =
function(coordinate) {
@@ -267,6 +276,7 @@ ol.source.Vector.prototype.getClosestFeatureToCoordinate =
/**
* @return {ol.Extent} Extent.
* @todo stability experimental
*/
ol.source.Vector.prototype.getExtent = function() {
return this.rBush_.getExtent();
@@ -301,6 +311,7 @@ ol.source.Vector.prototype.handleFeatureChange_ = function(event) {
/**
* @return {boolean} Is empty.
* @todo stability experimental
*/
ol.source.Vector.prototype.isEmpty = function() {
return this.rBush_.isEmpty() &&
@@ -310,6 +321,7 @@ ol.source.Vector.prototype.isEmpty = function() {
/**
* @param {ol.Feature} feature Feature.
* @todo stability experimental
*/
ol.source.Vector.prototype.removeFeature = function(feature) {
var featureKey = goog.getUid(feature).toString();
@@ -345,6 +357,7 @@ ol.source.Vector.prototype.removeFeatureInternal = function(feature) {
* @implements {oli.source.VectorEvent}
* @param {string} type Type.
* @param {ol.Feature=} opt_feature Feature.
* @todo stability experimental
*/
ol.source.VectorEvent = function(type, opt_feature) {

1
src/ol/style/circlestyle.js
View File

@@ -17,6 +17,7 @@ goog.require('ol.style.Stroke');
* @constructor
* @param {olx.style.CircleOptions=} opt_options Options.
* @extends {ol.style.Image}
* @todo stability experimental
*/
ol.style.Circle = function(opt_options) {