Annotations for exports

This commit is contained in:
Tim Schaub
2014-04-08 13:40:35 -06:00
parent 457cfe851a
commit fb497f5288
243 changed files with 456 additions and 451 deletions

View File

@@ -1,4 +0,0 @@
@exportSymbol ol.animation.bounce
@exportSymbol ol.animation.pan
@exportSymbol ol.animation.rotate
@exportSymbol ol.animation.zoom

View File

@@ -12,6 +12,7 @@ goog.require('ol.easing');
* @param {olx.animation.BounceOptions} options Bounce options.
* @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
* @todo api
*/
ol.animation.bounce = function(options) {
var resolution = options.resolution;
@@ -47,6 +48,7 @@ ol.animation.bounce = function(options) {
* @param {olx.animation.PanOptions} options Pan options.
* @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
* @todo api
*/
ol.animation.pan = function(options) {
var source = options.source;
@@ -86,6 +88,7 @@ ol.animation.pan = function(options) {
* @param {olx.animation.RotateOptions} options Rotate options.
* @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
* @todo api
*/
ol.animation.rotate = function(options) {
var sourceRotation = goog.isDef(options.rotation) ? options.rotation : 0;
@@ -131,6 +134,7 @@ ol.animation.rotate = function(options) {
* @param {olx.animation.ZoomOptions} options Zoom options.
* @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
* @todo api
*/
ol.animation.zoom = function(options) {
var sourceResolution = options.resolution;

View File

@@ -1 +0,0 @@
@exportSymbol ol.Attribution

View File

@@ -23,6 +23,7 @@ goog.require('ol.TileRange');
* @param {olx.AttributionOptions} options Attribution options.
* @struct
* @todo stability experimental
* @todo api
*/
ol.Attribution = function(options) {

View File

@@ -1,7 +0,0 @@
@exportSymbol ol.BrowserFeature
@exportProperty ol.BrowserFeature.DEVICE_PIXEL_RATIO
@exportProperty ol.BrowserFeature.HAS_CANVAS
@exportProperty ol.BrowserFeature.HAS_DEVICE_ORIENTATION
@exportProperty ol.BrowserFeature.HAS_GEOLOCATION
@exportProperty ol.BrowserFeature.HAS_TOUCH
@exportProperty ol.BrowserFeature.HAS_WEBGL

View File

@@ -78,6 +78,7 @@ ol.IS_LEGACY_IE = goog.userAgent.IE &&
* @const
* @type {number}
* @todo stability experimental
* @todo api
*/
ol.BrowserFeature.DEVICE_PIXEL_RATIO = goog.global.devicePixelRatio || 1;
@@ -104,6 +105,7 @@ ol.BrowserFeature.HAS_CANVAS_LINE_DASH = false;
* @const
* @type {boolean}
* @todo stability experimental
* @todo api
*/
ol.BrowserFeature.HAS_CANVAS = ol.ENABLE_CANVAS && (
/**
@@ -134,6 +136,7 @@ ol.BrowserFeature.HAS_CANVAS = ol.ENABLE_CANVAS && (
* @const
* @type {boolean}
* @todo stability experimental
* @todo api
*/
ol.BrowserFeature.HAS_DEVICE_ORIENTATION =
'DeviceOrientationEvent' in goog.global;
@@ -153,6 +156,7 @@ ol.BrowserFeature.HAS_DOM = ol.ENABLE_DOM;
* @const
* @type {boolean}
* @todo stability experimental
* @todo api
*/
ol.BrowserFeature.HAS_GEOLOCATION = 'geolocation' in goog.global.navigator;
@@ -171,6 +175,7 @@ ol.BrowserFeature.HAS_JSON_PARSE =
* @const
* @type {boolean}
* @todo stability experimental
* @todo api
*/
ol.BrowserFeature.HAS_TOUCH = ol.ASSUME_TOUCH || 'ontouchstart' in goog.global;

View File

@@ -1,13 +0,0 @@
@exportSymbol ol.Collection
@exportProperty ol.Collection.prototype.clear
@exportProperty ol.Collection.prototype.extend
@exportProperty ol.Collection.prototype.forEach
@exportProperty ol.Collection.prototype.getArray
@exportProperty ol.Collection.prototype.getAt
@exportProperty ol.Collection.prototype.getLength
@exportProperty ol.Collection.prototype.insertAt
@exportProperty ol.Collection.prototype.pop
@exportProperty ol.Collection.prototype.push
@exportProperty ol.Collection.prototype.remove
@exportProperty ol.Collection.prototype.removeAt
@exportProperty ol.Collection.prototype.setAt

View File

@@ -72,6 +72,7 @@ ol.CollectionProperty = {
* @param {Array=} opt_array Array.
* @todo stability experimental
* @todo observable length {number} readonly the length of the array
* @todo api
*/
ol.Collection = function(opt_array) {
@@ -92,6 +93,7 @@ goog.inherits(ol.Collection, ol.Object);
/**
* Remove all elements from the collection.
* @todo stability experimental
* @todo api
*/
ol.Collection.prototype.clear = function() {
while (this.getLength() > 0) {
@@ -104,6 +106,7 @@ ol.Collection.prototype.clear = function() {
* @param {Array} arr Array.
* @return {ol.Collection} This collection.
* @todo stability experimental
* @todo api
*/
ol.Collection.prototype.extend = function(arr) {
var i, ii;
@@ -122,6 +125,7 @@ ol.Collection.prototype.extend = function(arr) {
* @param {S=} opt_this The object to use as `this` in `f`.
* @template T,S
* @todo stability experimental
* @todo api
*/
ol.Collection.prototype.forEach = function(f, opt_this) {
goog.array.forEach(this.array_, f, opt_this);
@@ -135,6 +139,7 @@ ol.Collection.prototype.forEach = function(f, opt_this) {
* of the array.
* @return {Array} Array.
* @todo stability experimental
* @todo api
*/
ol.Collection.prototype.getArray = function() {
return this.array_;
@@ -146,6 +151,7 @@ ol.Collection.prototype.getArray = function() {
* @param {number} index Index.
* @return {*} Element.
* @todo stability experimental
* @todo api
*/
ol.Collection.prototype.getAt = function(index) {
return this.array_[index];
@@ -156,6 +162,7 @@ ol.Collection.prototype.getAt = function(index) {
* Get the length of this collection.
* @return {number} Length.
* @todo stability experimental
* @todo api
*/
ol.Collection.prototype.getLength = function() {
return /** @type {number} */ (this.get(ol.CollectionProperty.LENGTH));
@@ -167,6 +174,7 @@ ol.Collection.prototype.getLength = function() {
* @param {number} index Index.
* @param {*} elem Element.
* @todo stability experimental
* @todo api
*/
ol.Collection.prototype.insertAt = function(index, elem) {
goog.array.insertAt(this.array_, elem, index);
@@ -180,6 +188,7 @@ ol.Collection.prototype.insertAt = function(index, elem) {
* Remove the last element of the collection.
* @return {*} Element.
* @todo stability experimental
* @todo api
*/
ol.Collection.prototype.pop = function() {
return this.removeAt(this.getLength() - 1);
@@ -191,6 +200,7 @@ ol.Collection.prototype.pop = function() {
* @param {*} elem Element.
* @return {number} Length.
* @todo stability experimental
* @todo api
*/
ol.Collection.prototype.push = function(elem) {
var n = this.array_.length;
@@ -204,6 +214,7 @@ ol.Collection.prototype.push = function(elem) {
* @param {*} elem Element.
* @return {*} The removed element or undefined if elem was not found.
* @todo stability experimental
* @todo api
*/
ol.Collection.prototype.remove = function(elem) {
var arr = this.array_;
@@ -222,6 +233,7 @@ ol.Collection.prototype.remove = function(elem) {
* @param {number} index Index.
* @return {*} Value.
* @todo stability experimental
* @todo api
*/
ol.Collection.prototype.removeAt = function(index) {
var prev = this.array_[index];
@@ -238,6 +250,7 @@ ol.Collection.prototype.removeAt = function(index) {
* @param {number} index Index.
* @param {*} elem Element.
* @todo stability experimental
* @todo api
*/
ol.Collection.prototype.setAt = function(index, elem) {
var n = this.getLength();

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.color.asArray
@exportSymbol ol.color.asString

View File

@@ -103,6 +103,7 @@ ol.color.blend = function(dst, src, opt_color) {
/**
* @param {ol.Color|string} color Color.
* @return {ol.Color} Color.
* @todo api
*/
ol.color.asArray = function(color) {
if (goog.isArray(color)) {
@@ -117,6 +118,7 @@ ol.color.asArray = function(color) {
/**
* @param {ol.Color|string} color Color.
* @return {string} String.
* @todo api
*/
ol.color.asString = function(color) {
if (goog.isString(color)) {

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.control.Attribution
@exportProperty ol.control.Attribution.prototype.setMap

View File

@@ -22,6 +22,7 @@ goog.require('ol.css');
* @extends {ol.control.Control}
* @param {olx.control.AttributionOptions=} opt_options Attribution options.
* @todo stability experimental
* @todo api
*/
ol.control.Attribution = function(opt_options) {

View File

@@ -1,3 +0,0 @@
@exportSymbol ol.control.Control
@exportProperty ol.control.Control.prototype.getMap
@exportProperty ol.control.Control.prototype.setMap

View File

@@ -17,6 +17,7 @@ goog.require('ol.Object');
* @implements {oli.control.Control}
* @param {olx.control.ControlOptions} options Control options.
* @todo stability stable
* @todo api
*/
ol.control.Control = function(options) {
@@ -64,6 +65,7 @@ ol.control.Control.prototype.disposeInternal = function() {
* Get the map associated with this control.
* @return {ol.Map} Map.
* @todo stability experimental
* @todo api
*/
ol.control.Control.prototype.getMap = function() {
return this.map_;
@@ -85,6 +87,7 @@ ol.control.Control.prototype.handleMapPostrender = goog.nullFunction;
* the map here.
* @param {ol.Map} map Map.
* @todo stability stable
* @todo api
*/
ol.control.Control.prototype.setMap = function(map) {
if (!goog.isNull(this.map_)) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.control.defaults

View File

@@ -10,6 +10,7 @@ goog.require('ol.control.Zoom');
* @param {olx.control.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} Controls.
* @todo stability experimental
* @todo api
*/
ol.control.defaults = function(opt_options) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.control.FullScreen

View File

@@ -25,6 +25,7 @@ goog.require('ol.pointer.PointerEventHandler');
* @extends {ol.control.Control}
* @param {olx.control.FullScreenOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.control.FullScreen = function(opt_options) {

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.control.Logo
@exportProperty ol.control.Logo.prototype.setMap

View File

@@ -18,6 +18,7 @@ goog.require('ol.css');
* @extends {ol.control.Control}
* @param {olx.control.LogoOptions=} opt_options Logo options.
* @todo stability experimental
* @todo api
*/
ol.control.Logo = function(opt_options) {

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.control.MousePosition
@exportProperty ol.control.MousePosition.prototype.setMap

View File

@@ -43,6 +43,7 @@ ol.control.MousePositionProperty = {
* mouse position in
* @todo observable coordinateFormat {ol.CoordinateFormatType} the format to
* render the current position in
* @todo api
*/
ol.control.MousePosition = function(opt_options) {
@@ -184,6 +185,7 @@ ol.control.MousePosition.prototype.handleMouseOut = function(browserEvent) {
/**
* @inheritDoc
* @todo api
*/
ol.control.MousePosition.prototype.setMap = function(map) {
goog.base(this, 'setMap', map);

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.control.ScaleLine
@exportProperty ol.control.ScaleLine.prototype.setMap

View File

@@ -52,6 +52,7 @@ ol.control.ScaleLineUnits = {
* @todo stability experimental
* @todo observable units {ol.control.ScaleLineUnits} the units to use in the
* scale line
* @todo api
*/
ol.control.ScaleLine = function(opt_options) {

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.control.Zoom
@exportProperty ol.control.Zoom.prototype.setMap

View File

@@ -24,6 +24,7 @@ goog.require('ol.pointer.PointerEventHandler');
* @extends {ol.control.Control}
* @param {olx.control.ZoomOptions=} opt_options Zoom options.
* @todo stability experimental
* @todo api
*/
ol.control.Zoom = function(opt_options) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.control.ZoomSlider

View File

@@ -39,6 +39,7 @@ ol.control.ZOOMSLIDER_ANIMATION_DURATION = 200;
* @extends {ol.control.Control}
* @param {olx.control.ZoomSliderOptions=} opt_options Zoom slider options.
* @todo stability experimental
* @todo api
*/
ol.control.ZoomSlider = function(opt_options) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.control.ZoomToExtent

View File

@@ -21,6 +21,7 @@ goog.require('ol.pointer.PointerEventHandler');
* @extends {ol.control.Control}
* @param {olx.control.ZoomToExtentOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.control.ZoomToExtent = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : {};

View File

@@ -1,7 +0,0 @@
@exportSymbol ol.coordinate.add
@exportSymbol ol.coordinate.createStringXY
@exportSymbol ol.coordinate.format
@exportSymbol ol.coordinate.fromProjectedArray
@exportSymbol ol.coordinate.rotate
@exportSymbol ol.coordinate.toStringHDMS
@exportSymbol ol.coordinate.toStringXY

View File

@@ -36,6 +36,7 @@ ol.CoordinateArray;
* @param {ol.Coordinate} coordinate Coordinate.
* @param {ol.Coordinate} delta Delta.
* @return {ol.Coordinate} Coordinate.
* @todo api
*/
ol.coordinate.add = function(coordinate, delta) {
coordinate[0] += delta[0];
@@ -88,6 +89,7 @@ ol.coordinate.closestOnSegment = function(coordinate, segment) {
* after the decimal point. Default is `0`.
* @return {ol.CoordinateFormatType} Coordinate format.
* @todo stability experimental
* @todo api
*/
ol.coordinate.createStringXY = function(opt_fractionDigits) {
return (
@@ -125,6 +127,7 @@ ol.coordinate.degreesToStringHDMS_ = function(degrees, hemispheres) {
* after the decimal point. Default is `0`.
* @return {string} Formated coordinate.
* @todo stability experimental
* @todo api
*/
ol.coordinate.format = function(coordinate, template, opt_fractionDigits) {
if (goog.isDef(coordinate)) {
@@ -158,6 +161,7 @@ ol.coordinate.equals = function(coordinate1, coordinate2) {
* @param {ol.Coordinate} coordinate Coordinate.
* @param {number} angle Angle.
* @return {ol.Coordinate} Coordinate.
* @todo api
*/
ol.coordinate.rotate = function(coordinate, angle) {
var cosAngle = Math.cos(angle);
@@ -223,6 +227,7 @@ ol.coordinate.squaredDistanceToSegment = function(coordinate, segment) {
* @param {ol.Coordinate|undefined} coordinate Coordinate.
* @return {string} Hemisphere, degrees, minutes and seconds.
* @todo stability experimental
* @todo api
*/
ol.coordinate.toStringHDMS = function(coordinate) {
if (goog.isDef(coordinate)) {
@@ -240,6 +245,7 @@ ol.coordinate.toStringHDMS = function(coordinate) {
* after the decimal point. Default is `0`.
* @return {string} XY.
* @todo stability experimental
* @todo api
*/
ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) {
return ol.coordinate.format(coordinate, '{x}, {y}', opt_fractionDigits);
@@ -252,6 +258,7 @@ ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) {
* @param {string} axis the axis info.
* @return {ol.Coordinate} The coordinate created.
* @todo stability experimental
* @todo api
*/
ol.coordinate.fromProjectedArray = function(array, axis) {
var firstAxis = axis.charAt(0);

View File

@@ -1 +0,0 @@
@exportSymbol ol.DeviceOrientation

View File

@@ -80,6 +80,7 @@ ol.DeviceOrientationProperty = {
* device from the planar Y axis
* @todo observable tracking {boolean} the status of tracking changes to alpha,
* beta and gamma. If true, changes are tracked and reported immediately.
* @todo api
*/
ol.DeviceOrientation = function(opt_options) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.dom.Input

View File

@@ -32,6 +32,7 @@ ol.dom.InputProperty = {
* @todo stability experimental
* @todo observable value {string} the value of the Input
* @todo observable checked {boolean} the checked state of the Input
* @todo api
*/
ol.dom.Input = function(target) {
goog.base(this);

View File

@@ -1,7 +0,0 @@
@exportSymbol ol.easing.bounce
@exportSymbol ol.easing.easeIn
@exportSymbol ol.easing.easeOut
@exportSymbol ol.easing.elastic
@exportSymbol ol.easing.inAndOut
@exportSymbol ol.easing.linear
@exportSymbol ol.easing.upAndDown

View File

@@ -7,6 +7,7 @@ goog.require('goog.fx.easing');
* from https://raw.github.com/DmitryBaranovskiy/raphael/master/raphael.js
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
* @todo api
*/
ol.easing.bounce = function(t) {
var s = 7.5625, p = 2.75, l;
@@ -33,6 +34,7 @@ ol.easing.bounce = function(t) {
/**
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
* @todo api
*/
ol.easing.easeIn = goog.fx.easing.easeIn;
@@ -40,6 +42,7 @@ ol.easing.easeIn = goog.fx.easing.easeIn;
/**
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
* @todo api
*/
ol.easing.easeOut = goog.fx.easing.easeOut;
@@ -48,6 +51,7 @@ ol.easing.easeOut = goog.fx.easing.easeOut;
* from https://raw.github.com/DmitryBaranovskiy/raphael/master/raphael.js
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
* @todo api
*/
ol.easing.elastic = function(t) {
return Math.pow(2, -10 * t) * Math.sin((t - 0.075) * (2 * Math.PI) / 0.3) + 1;
@@ -57,6 +61,7 @@ ol.easing.elastic = function(t) {
/**
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
* @todo api
*/
ol.easing.inAndOut = goog.fx.easing.inAndOut;
@@ -64,6 +69,7 @@ ol.easing.inAndOut = goog.fx.easing.inAndOut;
/**
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
* @todo api
*/
ol.easing.linear = function(t) {
return t;
@@ -73,6 +79,7 @@ ol.easing.linear = function(t) {
/**
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
* @todo api
*/
ol.easing.upAndDown = function(t) {
if (t < 0.5) {

View File

@@ -1,8 +0,0 @@
@exportSymbol ol.events.condition.altKeyOnly
@exportSymbol ol.events.condition.altShiftKeysOnly
@exportSymbol ol.events.condition.always
@exportSymbol ol.events.condition.never
@exportSymbol ol.events.condition.noModifierKeys
@exportSymbol ol.events.condition.platformModifierKeyOnly
@exportSymbol ol.events.condition.shiftKeyOnly
@exportSymbol ol.events.condition.targetNotEditable

View File

@@ -22,6 +22,7 @@ ol.events.ConditionType;
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the alt key is pressed.
* @todo stability experimental
* @todo api
*/
ol.events.condition.altKeyOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -36,6 +37,7 @@ ol.events.condition.altKeyOnly = function(mapBrowserEvent) {
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the alt and shift keys are pressed.
* @todo stability experimental
* @todo api
*/
ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -51,6 +53,7 @@ ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) {
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True.
* @todo stability experimental
* @todo api
*/
ol.events.condition.always = goog.functions.TRUE;
@@ -60,6 +63,7 @@ ol.events.condition.always = goog.functions.TRUE;
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} False.
* @todo stability experimental
* @todo api
*/
ol.events.condition.never = goog.functions.FALSE;
@@ -78,6 +82,7 @@ ol.events.condition.singleClick = function(mapBrowserEvent) {
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True only if there no modifier keys are pressed.
* @todo stability experimental
* @todo api
*/
ol.events.condition.noModifierKeys = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -92,6 +97,7 @@ ol.events.condition.noModifierKeys = function(mapBrowserEvent) {
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the platform modifier key is pressed.
* @todo stability experimental
* @todo api
*/
ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -106,6 +112,7 @@ ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the shift key is pressed.
* @todo stability experimental
* @todo api
*/
ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) {
var browserEvent = mapBrowserEvent.browserEvent;
@@ -120,6 +127,7 @@ ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) {
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True only if the target element is not editable.
* @todo stability experimental
* @todo api
*/
ol.events.condition.targetNotEditable = function(mapBrowserEvent) {
var target = mapBrowserEvent.browserEvent.target;

View File

@@ -1,18 +0,0 @@
@exportSymbol ol.extent.boundingExtent
@exportSymbol ol.extent.buffer
@exportSymbol ol.extent.containsCoordinate
@exportSymbol ol.extent.containsExtent
@exportSymbol ol.extent.createEmpty
@exportSymbol ol.extent.equals
@exportSymbol ol.extent.extend
@exportSymbol ol.extent.getBottomLeft
@exportSymbol ol.extent.getBottomRight
@exportSymbol ol.extent.getCenter
@exportSymbol ol.extent.getHeight
@exportSymbol ol.extent.getSize
@exportSymbol ol.extent.getTopLeft
@exportSymbol ol.extent.getTopRight
@exportSymbol ol.extent.getWidth
@exportSymbol ol.extent.intersects
@exportSymbol ol.extent.isEmpty
@exportSymbol ol.extent.transform

View File

@@ -37,6 +37,7 @@ ol.extent.Relationship = {
* @param {Array.<ol.Coordinate>} coordinates Coordinates.
* @return {ol.Extent} Bounding extent.
* @todo stability experimental
* @todo api
*/
ol.extent.boundingExtent = function(coordinates) {
var extent = ol.extent.createEmpty();
@@ -72,6 +73,7 @@ ol.extent.boundingExtentXYs_ = function(xs, ys, opt_extent) {
* @param {number} value The amount by wich the extent should be buffered.
* @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} Extent.
* @todo api
*/
ol.extent.buffer = function(extent, value, opt_extent) {
if (goog.isDef(opt_extent)) {
@@ -145,6 +147,7 @@ ol.extent.closestSquaredDistanceXY = function(extent, x, y) {
* @param {ol.Coordinate} coordinate Coordinate.
* @return {boolean} Contains.
* @todo stability experimental
* @todo api
*/
ol.extent.containsCoordinate = function(extent, coordinate) {
return extent[0] <= coordinate[0] && coordinate[0] <= extent[2] &&
@@ -159,6 +162,7 @@ ol.extent.containsCoordinate = function(extent, coordinate) {
* @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Contains.
* @todo stability experimental
* @todo api
*/
ol.extent.containsExtent = function(extent1, extent2) {
return extent1[0] <= extent2[0] && extent2[2] <= extent1[2] &&
@@ -201,6 +205,7 @@ ol.extent.coordinateRelationship = function(extent, coordinate) {
/**
* @return {ol.Extent} Empty extent.
* @todo stability experimental
* @todo api
*/
ol.extent.createEmpty = function() {
return [Infinity, Infinity, -Infinity, -Infinity];
@@ -307,6 +312,7 @@ ol.extent.empty = function(extent) {
* @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Equals.
* @todo stability experimental
* @todo api
*/
ol.extent.equals = function(extent1, extent2) {
return extent1[0] == extent2[0] && extent1[2] == extent2[2] &&
@@ -319,6 +325,7 @@ ol.extent.equals = function(extent1, extent2) {
* @param {ol.Extent} extent2 Extent 2.
* @return {ol.Extent} Extent.
* @todo stability experimental
* @todo api
*/
ol.extent.extend = function(extent1, extent2) {
if (extent2[0] < extent1[0]) {
@@ -430,6 +437,7 @@ ol.extent.getArea = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Bottom left coordinate.
* @todo stability experimental
* @todo api
*/
ol.extent.getBottomLeft = function(extent) {
return [extent[0], extent[1]];
@@ -440,6 +448,7 @@ ol.extent.getBottomLeft = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Bottom right coordinate.
* @todo stability experimental
* @todo api
*/
ol.extent.getBottomRight = function(extent) {
return [extent[2], extent[1]];
@@ -450,6 +459,7 @@ ol.extent.getBottomRight = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Center.
* @todo stability experimental
* @todo api
*/
ol.extent.getCenter = function(extent) {
return [(extent[0] + extent[2]) / 2, (extent[1] + extent[3]) / 2];
@@ -504,6 +514,7 @@ ol.extent.getForView2DAndSize =
* @param {ol.Extent} extent Extent.
* @return {number} Height.
* @todo stability experimental
* @todo api
*/
ol.extent.getHeight = function(extent) {
return extent[3] - extent[1];
@@ -537,6 +548,7 @@ ol.extent.getMargin = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {ol.Size} Size.
* @todo stability experimental
* @todo api
*/
ol.extent.getSize = function(extent) {
return [extent[2] - extent[0], extent[3] - extent[1]];
@@ -547,6 +559,7 @@ ol.extent.getSize = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Top left coordinate.
* @todo stability experimental
* @todo api
*/
ol.extent.getTopLeft = function(extent) {
return [extent[0], extent[3]];
@@ -557,6 +570,7 @@ ol.extent.getTopLeft = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Top right coordinate.
* @todo stability experimental
* @todo api
*/
ol.extent.getTopRight = function(extent) {
return [extent[2], extent[3]];
@@ -567,6 +581,7 @@ ol.extent.getTopRight = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {number} Width.
* @todo stability experimental
* @todo api
*/
ol.extent.getWidth = function(extent) {
return extent[2] - extent[0];
@@ -578,6 +593,7 @@ ol.extent.getWidth = function(extent) {
* @param {ol.Extent} extent2 Extent.
* @return {boolean} Intersects.
* @todo stability experimental
* @todo api
*/
ol.extent.intersects = function(extent1, extent2) {
return extent1[0] <= extent2[2] &&
@@ -591,6 +607,7 @@ ol.extent.intersects = function(extent1, extent2) {
* @param {ol.Extent} extent Extent.
* @return {boolean} Is empty.
* @todo stability experimental
* @todo api
*/
ol.extent.isEmpty = function(extent) {
return extent[2] < extent[0] || extent[3] < extent[1];
@@ -728,6 +745,7 @@ ol.extent.touches = function(extent1, extent2) {
* @param {ol.Extent=} opt_extent Destination extent.
* @return {ol.Extent} Extent.
* @todo stability experimental
* @todo api
*/
ol.extent.transform = function(extent, transformFn, opt_extent) {
var coordinates = [

View File

@@ -1,8 +0,0 @@
@exportSymbol ol.Feature
@exportProperty ol.Feature.prototype.getGeometryName
@exportProperty ol.Feature.prototype.getId
@exportProperty ol.Feature.prototype.getStyle
@exportProperty ol.Feature.prototype.getStyleFunction
@exportProperty ol.Feature.prototype.setGeometryName
@exportProperty ol.Feature.prototype.setId
@exportProperty ol.Feature.prototype.setStyle

View File

@@ -21,6 +21,7 @@ goog.require('ol.style.Style');
* @param {ol.geom.Geometry|Object.<string, *>=} opt_geometryOrValues
* Values or geometry.
* @todo stability experimental
* @todo api
*/
ol.Feature = function(opt_geometryOrValues) {
@@ -81,6 +82,7 @@ goog.inherits(ol.Feature, ol.Object);
/**
* @return {ol.geom.Geometry|undefined} Geometry.
* @todo stability experimental
* @todo api
*/
ol.Feature.prototype.getGeometry = function() {
return /** @type {ol.geom.Geometry|undefined} */ (
@@ -95,6 +97,7 @@ goog.exportProperty(
/**
* @return {number|string|undefined} Id.
* @todo stability experimental
* @todo api
*/
ol.Feature.prototype.getId = function() {
return this.id_;
@@ -104,6 +107,7 @@ ol.Feature.prototype.getId = function() {
/**
* @return {string} Geometry property name.
* @todo stability experimental
* @todo api
*/
ol.Feature.prototype.getGeometryName = function() {
return this.geometryName_;
@@ -114,6 +118,7 @@ ol.Feature.prototype.getGeometryName = function() {
* @return {ol.style.Style|Array.<ol.style.Style>|
* ol.feature.FeatureStyleFunction} User provided style.
* @todo stability experimental
* @todo api
*/
ol.Feature.prototype.getStyle = function() {
return this.style_;
@@ -123,6 +128,7 @@ ol.Feature.prototype.getStyle = function() {
/**
* @return {ol.feature.FeatureStyleFunction|undefined} Style function.
* @todo stability experimental
* @todo api
*/
ol.Feature.prototype.getStyleFunction = function() {
return this.styleFunction_;
@@ -157,6 +163,7 @@ ol.Feature.prototype.handleGeometryChanged_ = function() {
/**
* @param {ol.geom.Geometry|undefined} geometry Geometry.
* @todo stability experimental
* @todo api
*/
ol.Feature.prototype.setGeometry = function(geometry) {
this.set(this.geometryName_, geometry);
@@ -171,6 +178,7 @@ goog.exportProperty(
* @param {ol.style.Style|Array.<ol.style.Style>|
* ol.feature.FeatureStyleFunction} style Feature style.
* @todo stability experimental
* @todo api
*/
ol.Feature.prototype.setStyle = function(style) {
this.style_ = style;
@@ -182,6 +190,7 @@ ol.Feature.prototype.setStyle = function(style) {
/**
* @param {number|string|undefined} id Id.
* @todo stability experimental
* @todo api
*/
ol.Feature.prototype.setId = function(id) {
this.id_ = id;
@@ -191,6 +200,7 @@ ol.Feature.prototype.setId = function(id) {
/**
* @param {string} name Geometry property name.
* @todo stability experimental
* @todo api
*/
ol.Feature.prototype.setGeometryName = function(name) {
goog.events.unlisten(

View File

@@ -1,9 +0,0 @@
@exportSymbol ol.FeatureOverlay
@exportProperty ol.FeatureOverlay.prototype.addFeature
@exportProperty ol.FeatureOverlay.prototype.getFeatures
@exportProperty ol.FeatureOverlay.prototype.getStyle
@exportProperty ol.FeatureOverlay.prototype.getStyleFunction
@exportProperty ol.FeatureOverlay.prototype.removeFeature
@exportProperty ol.FeatureOverlay.prototype.setFeatures
@exportProperty ol.FeatureOverlay.prototype.setMap
@exportProperty ol.FeatureOverlay.prototype.setStyle

View File

@@ -17,6 +17,7 @@ goog.require('ol.render.EventType');
* @constructor
* @param {olx.FeatureOverlayOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.FeatureOverlay = function(opt_options) {
@@ -86,6 +87,7 @@ ol.FeatureOverlay = function(opt_options) {
/**
* @param {ol.Feature} feature Feature.
* @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.addFeature = function(feature) {
this.features_.push(feature);
@@ -95,6 +97,7 @@ ol.FeatureOverlay.prototype.addFeature = function(feature) {
/**
* @return {ol.Collection} Features collection.
* @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.getFeatures = function() {
return this.features_;
@@ -168,6 +171,7 @@ ol.FeatureOverlay.prototype.handleMapPostCompose_ = function(event) {
/**
* @param {ol.Feature} feature Feature.
* @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.removeFeature = function(feature) {
this.features_.remove(feature);
@@ -187,6 +191,7 @@ ol.FeatureOverlay.prototype.render_ = function() {
/**
* @param {ol.Collection} features Features collection.
* @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.setFeatures = function(features) {
if (!goog.isNull(this.featuresListenerKeys_)) {
@@ -221,6 +226,7 @@ ol.FeatureOverlay.prototype.setFeatures = function(features) {
/**
* @param {ol.Map} map Map.
* @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.setMap = function(map) {
if (!goog.isNull(this.postComposeListenerKey_)) {
@@ -245,6 +251,7 @@ ol.FeatureOverlay.prototype.setMap = function(map) {
* @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style
* Overlay style.
* @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.setStyle = function(style) {
this.style_ = style;
@@ -258,6 +265,7 @@ ol.FeatureOverlay.prototype.setStyle = function(style) {
* option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction}
* Overlay style.
* @todo api
*/
ol.FeatureOverlay.prototype.getStyle = function() {
return this.style_;
@@ -267,6 +275,7 @@ ol.FeatureOverlay.prototype.getStyle = function() {
/**
* Get the style function.
* @return {ol.feature.StyleFunction|undefined} Style function.
* @todo api
*/
ol.FeatureOverlay.prototype.getStyleFunction = function() {
return this.styleFunction_;

View File

@@ -1,8 +0,0 @@
@exportSymbol ol.format.GeoJSON
@exportProperty ol.format.GeoJSON.prototype.readFeature
@exportProperty ol.format.GeoJSON.prototype.readFeatures
@exportProperty ol.format.GeoJSON.prototype.readGeometry
@exportProperty ol.format.GeoJSON.prototype.readProjection
@exportProperty ol.format.GeoJSON.prototype.writeFeature
@exportProperty ol.format.GeoJSON.prototype.writeFeatures
@exportProperty ol.format.GeoJSON.prototype.writeGeometry

View File

@@ -27,6 +27,7 @@ goog.require('ol.proj');
* @extends {ol.format.JSONFeature}
* @param {olx.format.GeoJSONOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.format.GeoJSON = function(opt_options) {
@@ -322,6 +323,7 @@ ol.format.GeoJSON.prototype.getExtensions = function() {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
*/
ol.format.GeoJSON.prototype.readFeature;
@@ -333,6 +335,7 @@ ol.format.GeoJSON.prototype.readFeature;
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
*/
ol.format.GeoJSON.prototype.readFeatures;
@@ -386,6 +389,7 @@ ol.format.GeoJSON.prototype.readFeaturesFromObject = function(object) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.geom.Geometry} Geometry.
* @todo api
*/
ol.format.GeoJSON.prototype.readGeometry;
@@ -404,6 +408,7 @@ ol.format.GeoJSON.prototype.readGeometryFromObject = function(object) {
*
* @param {ArrayBuffer|Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection.
* @todo api
*/
ol.format.GeoJSON.prototype.readProjection = function(object) {
var geoJSONObject = /** @type {GeoJSONObject} */ (object);
@@ -433,6 +438,7 @@ ol.format.GeoJSON.prototype.readProjection = function(object) {
* @function
* @param {ol.Feature} feature Feature.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo api
*/
ol.format.GeoJSON.prototype.writeFeature;
@@ -468,6 +474,7 @@ ol.format.GeoJSON.prototype.writeFeatureObject = function(feature) {
* @function
* @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo api
*/
ol.format.GeoJSON.prototype.writeFeatures;

View File

@@ -1,5 +0,0 @@
@exportSymbol ol.format.GPX
@exportProperty ol.format.GPX.prototype.readFeature
@exportProperty ol.format.GPX.prototype.readFeatures
@exportProperty ol.format.GPX.prototype.readProjection
@exportProperty ol.format.GPX.prototype.writeFeatures

View File

@@ -20,6 +20,7 @@ goog.require('ol.xml');
* @constructor
* @extends {ol.format.XMLFeature}
* @todo stability experimental
* @todo api
*/
ol.format.GPX = function() {
goog.base(this);
@@ -369,6 +370,7 @@ ol.format.GPX.WPT_PARSERS_ = ol.xml.makeParsersNS(
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
*/
ol.format.GPX.prototype.readFeature;
@@ -399,6 +401,7 @@ ol.format.GPX.prototype.readFeatureFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
*/
ol.format.GPX.prototype.readFeatures;
@@ -430,6 +433,7 @@ ol.format.GPX.prototype.readFeaturesFromNode = function(node) {
*
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo api
*/
ol.format.GPX.prototype.readProjection;
@@ -805,6 +809,7 @@ goog.inherits(ol.format.GPX.V1_1, ol.format.GPX);
* @function
* @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result.
* @todo api
*/
ol.format.GPX.prototype.writeFeatures;

View File

@@ -1,4 +0,0 @@
@exportSymbol ol.format.IGC
@exportProperty ol.format.IGC.prototype.readFeature
@exportProperty ol.format.IGC.prototype.readFeatures
@exportProperty ol.format.IGC.prototype.readProjection

View File

@@ -26,6 +26,7 @@ ol.format.IGCZ = {
* @extends {ol.format.TextFeature}
* @param {olx.format.IGCOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.format.IGC = function(opt_options) {
@@ -91,6 +92,7 @@ ol.format.IGC.prototype.getExtensions = function() {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
*/
ol.format.IGC.prototype.readFeature;
@@ -176,6 +178,7 @@ ol.format.IGC.prototype.readFeatureFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
*/
ol.format.IGC.prototype.readFeatures;
@@ -199,6 +202,7 @@ ol.format.IGC.prototype.readFeaturesFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo api
*/
ol.format.IGC.prototype.readProjection;

View File

@@ -1,5 +0,0 @@
@exportSymbol ol.format.KML
@exportProperty ol.format.KML.prototype.readFeature
@exportProperty ol.format.KML.prototype.readFeatures
@exportProperty ol.format.KML.prototype.readName
@exportProperty ol.format.KML.prototype.readProjection

View File

@@ -55,6 +55,7 @@ ol.format.KMLGxTrackObject_;
* @extends {ol.format.XMLFeature}
* @param {olx.format.KMLOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.format.KML = function(opt_options) {
@@ -1450,6 +1451,7 @@ ol.format.KML.prototype.readSharedStyleMap_ = function(node, objectStack) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
* @todo api
*/
ol.format.KML.prototype.readFeature;
@@ -1478,6 +1480,7 @@ ol.format.KML.prototype.readFeatureFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
*/
ol.format.KML.prototype.readFeatures;
@@ -1596,6 +1599,7 @@ ol.format.KML.prototype.readNameFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
* @todo api
*/
ol.format.KML.prototype.readProjection;

View File

@@ -1 +0,0 @@
@exportSymbol ol.format.OSMXML

View File

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

View File

@@ -1,3 +0,0 @@
@exportSymbol ol.format.TopoJSON
@exportProperty ol.format.TopoJSON.prototype.readFeatures
@exportProperty ol.format.TopoJSON.prototype.readProjection

View File

@@ -20,6 +20,7 @@ goog.require('ol.proj');
* @extends {ol.format.JSONFeature}
* @param {olx.format.TopoJSONOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.format.TopoJSON = function(opt_options) {
@@ -271,6 +272,7 @@ ol.format.TopoJSON.readFeatureFromGeometry_ = function(object, arcs,
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
*/
ol.format.TopoJSON.prototype.readFeatures;
@@ -380,6 +382,7 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection.
* @todo api
*/
ol.format.TopoJSON.prototype.readProjection = function(object) {
return this.defaultProjection_;

View File

@@ -1,6 +0,0 @@
@exportSymbol ol.format.WFS
@exportProperty ol.format.WFS.prototype.readFeatures
@exportProperty ol.format.WFS.prototype.readTransactionResponse
@exportProperty ol.format.WFS.prototype.readFeatureCollectionMetadata
@exportProperty ol.format.WFS.prototype.writeGetFeature
@exportProperty ol.format.WFS.prototype.writeTransaction

View File

@@ -18,6 +18,7 @@ goog.require('ol.xml');
* Optional configuration object.
* @extends {ol.format.XMLFeature}
* @todo stability experimental
* @todo api
*/
ol.format.WFS = function(opt_options) {
var options = /** @type {olx.format.WFSOptions} */
@@ -92,6 +93,7 @@ ol.format.WFS.prototype.readFeaturesFromNode = function(node) {
/**
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.format.WFS.TransactionResponse|undefined} Transaction response.
* @todo api
*/
ol.format.WFS.prototype.readTransactionResponse = function(source) {
if (ol.xml.isDocument(source)) {
@@ -113,6 +115,7 @@ ol.format.WFS.prototype.readTransactionResponse = function(source) {
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.format.WFS.FeatureCollectionMetadata|undefined}
* FeatureCollection metadata.
* @todo api
*/
ol.format.WFS.prototype.readFeatureCollectionMetadata = function(source) {
if (ol.xml.isDocument(source)) {
@@ -549,6 +552,7 @@ ol.format.WFS.writeGetFeature_ = function(node, featureTypes, objectStack) {
/**
* @param {olx.format.WFSWriteGetFeatureOptions} options Options.
* @return {Node} Result.
* @todo api
*/
ol.format.WFS.prototype.writeGetFeature = function(options) {
var node = ol.xml.createElementNS('http://www.opengis.net/wfs',
@@ -600,6 +604,7 @@ ol.format.WFS.prototype.writeGetFeature = function(options) {
* @param {Array.<ol.Feature>} deletes The features to delete.
* @param {olx.format.WFSWriteTransactionOptions} options Write options.
* @return {Node} Result.
* @todo api
*/
ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes,
options) {

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.format.WMSCapabilities
@exportProperty ol.format.WMSCapabilities.prototype.read

View File

@@ -15,6 +15,7 @@ goog.require('ol.xml');
/**
* @constructor
* @extends {ol.format.XML}
* @todo api
*/
ol.format.WMSCapabilities = function() {
@@ -28,6 +29,17 @@ ol.format.WMSCapabilities = function() {
goog.inherits(ol.format.WMSCapabilities, ol.format.XML);
/**
* Read a WMS capabilities document.
*
* @function
* @param {Document|Node|string} source The XML source.
* @return {Object} An object representing the WMS capabilities.
* @todo api
*/
ol.format.WMSCapabilities.prototype.read;
/**
* @param {Document} doc Document.
* @return {Object} WMS Capability object.

View File

@@ -1 +0,0 @@
@exportSymbol ol.Geolocation

View File

@@ -72,6 +72,7 @@ ol.GeolocationProperty = {
* @todo observable trackingOptions {GeolocationPositionOptions} PositionOptions
* as defined by the HTML5 Geolocation spec at
* http://www.w3.org/TR/geolocation-API/#position_options_interface
* @todo api
*/
ol.Geolocation = function(opt_options) {

View File

@@ -1,11 +0,0 @@
@exportSymbol ol.geom.Circle
@exportProperty ol.geom.Circle.prototype.clone
@exportProperty ol.geom.Circle.prototype.getCenter
@exportProperty ol.geom.Circle.prototype.getExtent
@exportProperty ol.geom.Circle.prototype.getRadius
@exportProperty ol.geom.Circle.prototype.getSimplifiedGeometry
@exportProperty ol.geom.Circle.prototype.getType
@exportProperty ol.geom.Circle.prototype.setCenter
@exportProperty ol.geom.Circle.prototype.setCenterAndRadius
@exportProperty ol.geom.Circle.prototype.setRadius
@exportProperty ol.geom.Circle.prototype.transform

View File

@@ -15,6 +15,7 @@ goog.require('ol.geom.flat.deflate');
* @param {number=} opt_radius Radius.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.Circle = function(center, opt_radius, opt_layout) {
goog.base(this);
@@ -27,6 +28,7 @@ goog.inherits(ol.geom.Circle, ol.geom.SimpleGeometry);
/**
* @inheritDoc
* @todo api
*/
ol.geom.Circle.prototype.clone = function() {
var circle = new ol.geom.Circle(null);
@@ -80,6 +82,7 @@ ol.geom.Circle.prototype.containsXY = function(x, y) {
/**
* @return {ol.geom.RawPoint} Center.
* @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.getCenter = function() {
return this.flatCoordinates.slice(0, this.stride);
@@ -88,6 +91,7 @@ ol.geom.Circle.prototype.getCenter = function() {
/**
* @inheritDoc
* @todo api
*/
ol.geom.Circle.prototype.getExtent = function(opt_extent) {
if (this.extentRevision != this.getRevision()) {
@@ -107,6 +111,7 @@ ol.geom.Circle.prototype.getExtent = function(opt_extent) {
/**
* @return {number} Radius.
* @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.getRadius = function() {
return Math.sqrt(this.getRadiusSquared_());
@@ -126,6 +131,7 @@ ol.geom.Circle.prototype.getRadiusSquared_ = function() {
/**
* @inheritDoc
* @todo api
*/
ol.geom.Circle.prototype.getSimplifiedGeometry = function(squaredTolerance) {
return this;
@@ -134,6 +140,7 @@ ol.geom.Circle.prototype.getSimplifiedGeometry = function(squaredTolerance) {
/**
* @inheritDoc
* @todo api
*/
ol.geom.Circle.prototype.getType = function() {
return ol.geom.GeometryType.CIRCLE;
@@ -143,6 +150,7 @@ ol.geom.Circle.prototype.getType = function() {
/**
* @param {ol.geom.RawPoint} center Center.
* @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.setCenter = function(center) {
var stride = this.stride;
@@ -163,6 +171,7 @@ ol.geom.Circle.prototype.setCenter = function(center) {
* @param {number} radius Radius.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.setCenterAndRadius =
function(center, radius, opt_layout) {
@@ -202,6 +211,7 @@ ol.geom.Circle.prototype.setFlatCoordinates =
/**
* @param {number} radius Radius.
* @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.setRadius = function(radius) {
goog.asserts.assert(!goog.isNull(this.flatCoordinates));

View File

@@ -1,3 +0,0 @@
@exportSymbol ol.geom.Geometry
@exportProperty ol.geom.Geometry.prototype.getClosestPoint
@exportProperty ol.geom.Geometry.prototype.getType

View File

@@ -38,6 +38,7 @@ ol.geom.GeometryLayout = {
* @constructor
* @extends {ol.Observable}
* @todo stability experimental
* @todo api
*/
ol.geom.Geometry = function() {
@@ -99,6 +100,7 @@ ol.geom.Geometry.prototype.closestPointXY = goog.abstractMethod;
* @param {ol.Coordinate=} opt_closestPoint Closest point.
* @return {ol.Coordinate} Closest point.
* @todo stability experimental
* @todo api
*/
ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
var closestPoint = goog.isDef(opt_closestPoint) ?
@@ -144,6 +146,7 @@ ol.geom.Geometry.prototype.getSimplifiedGeometry = goog.abstractMethod;
/**
* @return {ol.geom.GeometryType} Geometry type.
* @todo stability experimental
* @todo api
*/
ol.geom.Geometry.prototype.getType = goog.abstractMethod;

View File

@@ -1,7 +0,0 @@
@exportSymbol ol.geom.GeometryCollection
@exportProperty ol.geom.GeometryCollection.prototype.clone
@exportProperty ol.geom.GeometryCollection.prototype.getExtent
@exportProperty ol.geom.GeometryCollection.prototype.getGeometries
@exportProperty ol.geom.GeometryCollection.prototype.getSimplifiedGeometry
@exportProperty ol.geom.GeometryCollection.prototype.getType
@exportProperty ol.geom.GeometryCollection.prototype.setGeometries

View File

@@ -16,6 +16,7 @@ goog.require('ol.geom.GeometryType');
* @extends {ol.geom.Geometry}
* @param {Array.<ol.geom.Geometry>=} opt_geometries Geometries.
* @todo stability experimental
* @todo api
*/
ol.geom.GeometryCollection = function(opt_geometries) {
@@ -81,6 +82,7 @@ ol.geom.GeometryCollection.prototype.listenGeometriesChange_ = function() {
/**
* @inheritDoc
* @todo api
*/
ol.geom.GeometryCollection.prototype.clone = function() {
var geometryCollection = new ol.geom.GeometryCollection(null);
@@ -125,6 +127,7 @@ ol.geom.GeometryCollection.prototype.containsXY = function(x, y) {
/**
* @inheritDoc
* @todo api
*/
ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) {
if (this.extentRevision != this.getRevision()) {
@@ -145,6 +148,7 @@ ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) {
/**
* @return {Array.<ol.geom.Geometry>} Geometries.
* @todo stability experimental
* @todo api
*/
ol.geom.GeometryCollection.prototype.getGeometries = function() {
return ol.geom.GeometryCollection.cloneGeometries_(this.geometries_);
@@ -161,6 +165,7 @@ ol.geom.GeometryCollection.prototype.getGeometriesArray = function() {
/**
* @inheritDoc
* @todo api
*/
ol.geom.GeometryCollection.prototype.getSimplifiedGeometry =
function(squaredTolerance) {
@@ -205,6 +210,7 @@ ol.geom.GeometryCollection.prototype.getSimplifiedGeometry =
/**
* @inheritDoc
* @todo api
*/
ol.geom.GeometryCollection.prototype.getType = function() {
return ol.geom.GeometryType.GEOMETRY_COLLECTION;
@@ -223,6 +229,7 @@ ol.geom.GeometryCollection.prototype.isEmpty = function() {
/**
* @param {Array.<ol.geom.Geometry>} geometries Geometries.
* @todo stability experimental
* @todo api
*/
ol.geom.GeometryCollection.prototype.setGeometries = function(geometries) {
this.setGeometriesArray(

View File

@@ -1,6 +0,0 @@
@exportSymbol ol.geom.LinearRing
@exportProperty ol.geom.LinearRing.prototype.clone
@exportProperty ol.geom.LinearRing.prototype.getArea
@exportProperty ol.geom.LinearRing.prototype.getCoordinates
@exportProperty ol.geom.LinearRing.prototype.getType
@exportProperty ol.geom.LinearRing.prototype.setCoordinates

View File

@@ -17,6 +17,7 @@ goog.require('ol.geom.flat.simplify');
* @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.LinearRing = function(coordinates, opt_layout) {
@@ -43,6 +44,7 @@ goog.inherits(ol.geom.LinearRing, ol.geom.SimpleGeometry);
/**
* @inheritDoc
* @todo api
*/
ol.geom.LinearRing.prototype.clone = function() {
var linearRing = new ol.geom.LinearRing(null);
@@ -74,6 +76,7 @@ ol.geom.LinearRing.prototype.closestPointXY =
/**
* @return {number} Area.
* @todo stability experimental
* @todo api
*/
ol.geom.LinearRing.prototype.getArea = function() {
return ol.geom.flat.area.linearRing(
@@ -84,6 +87,7 @@ ol.geom.LinearRing.prototype.getArea = function() {
/**
* @return {ol.geom.RawLinearRing} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.LinearRing.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinates(
@@ -109,6 +113,7 @@ ol.geom.LinearRing.prototype.getSimplifiedGeometryInternal =
/**
* @inheritDoc
* @todo api
*/
ol.geom.LinearRing.prototype.getType = function() {
return ol.geom.GeometryType.LINEAR_RING;
@@ -119,6 +124,7 @@ ol.geom.LinearRing.prototype.getType = function() {
* @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.LinearRing.prototype.setCoordinates =
function(coordinates, opt_layout) {

View File

@@ -1,8 +0,0 @@
@exportSymbol ol.geom.LineString
@exportProperty ol.geom.LineString.prototype.appendCoordinate
@exportProperty ol.geom.LineString.prototype.clone
@exportProperty ol.geom.LineString.prototype.getCoordinateAtM
@exportProperty ol.geom.LineString.prototype.getCoordinates
@exportProperty ol.geom.LineString.prototype.getLength
@exportProperty ol.geom.LineString.prototype.getType
@exportProperty ol.geom.LineString.prototype.setCoordinates

View File

@@ -21,6 +21,7 @@ goog.require('ol.geom.flat.simplify');
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.LineString = function(coordinates, opt_layout) {
@@ -59,6 +60,7 @@ goog.inherits(ol.geom.LineString, ol.geom.SimpleGeometry);
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @todo api
*/
ol.geom.LineString.prototype.appendCoordinate = function(coordinate) {
goog.asserts.assert(coordinate.length == this.stride);
@@ -73,6 +75,7 @@ ol.geom.LineString.prototype.appendCoordinate = function(coordinate) {
/**
* @inheritDoc
* @todo api
*/
ol.geom.LineString.prototype.clone = function() {
var lineString = new ol.geom.LineString(null);
@@ -113,6 +116,7 @@ ol.geom.LineString.prototype.closestPointXY =
* @param {number} m M.
* @param {boolean=} opt_extrapolate Extrapolate.
* @return {ol.Coordinate} Coordinate.
* @todo api
*/
ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
if (this.layout != ol.geom.GeometryLayout.XYM &&
@@ -128,6 +132,7 @@ ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
/**
* @return {ol.geom.RawLineString} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinates(
@@ -138,6 +143,7 @@ ol.geom.LineString.prototype.getCoordinates = function() {
/**
* @return {number} Length.
* @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.getLength = function() {
return ol.geom.flat.length.lineString(
@@ -177,6 +183,7 @@ ol.geom.LineString.prototype.getSimplifiedGeometryInternal =
/**
* @inheritDoc
* @todo api
*/
ol.geom.LineString.prototype.getType = function() {
return ol.geom.GeometryType.LINE_STRING;
@@ -187,6 +194,7 @@ ol.geom.LineString.prototype.getType = function() {
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.setCoordinates =
function(coordinates, opt_layout) {

View File

@@ -1,9 +0,0 @@
@exportSymbol ol.geom.MultiLineString
@exportProperty ol.geom.MultiLineString.prototype.appendLineString
@exportProperty ol.geom.MultiLineString.prototype.clone
@exportProperty ol.geom.MultiLineString.prototype.getCoordinateAtM
@exportProperty ol.geom.MultiLineString.prototype.getCoordinates
@exportProperty ol.geom.MultiLineString.prototype.getLineString
@exportProperty ol.geom.MultiLineString.prototype.getLineStrings
@exportProperty ol.geom.MultiLineString.prototype.getType
@exportProperty ol.geom.MultiLineString.prototype.setCoordinates

View File

@@ -21,6 +21,7 @@ goog.require('ol.geom.flat.simplify');
* @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString = function(coordinates, opt_layout) {
@@ -53,6 +54,7 @@ goog.inherits(ol.geom.MultiLineString, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.LineString} lineString LineString.
* @todo api
*/
ol.geom.MultiLineString.prototype.appendLineString = function(lineString) {
goog.asserts.assert(lineString.getLayout() == this.layout);
@@ -69,6 +71,7 @@ ol.geom.MultiLineString.prototype.appendLineString = function(lineString) {
/**
* @inheritDoc
* @todo api
*/
ol.geom.MultiLineString.prototype.clone = function() {
var multiLineString = new ol.geom.MultiLineString(null);
@@ -118,6 +121,7 @@ ol.geom.MultiLineString.prototype.closestPointXY =
* @param {boolean=} opt_extrapolate Extrapolate.
* @param {boolean=} opt_interpolate Interpolate.
* @return {ol.Coordinate} Coordinate.
* @todo api
*/
ol.geom.MultiLineString.prototype.getCoordinateAtM =
function(m, opt_extrapolate, opt_interpolate) {
@@ -136,6 +140,7 @@ ol.geom.MultiLineString.prototype.getCoordinateAtM =
/**
* @return {ol.geom.RawMultiLineString} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinatess(
@@ -154,6 +159,7 @@ ol.geom.MultiLineString.prototype.getEnds = function() {
/**
* @param {number} index Index.
* @return {ol.geom.LineString} LineString.
* @todo api
*/
ol.geom.MultiLineString.prototype.getLineString = function(index) {
goog.asserts.assert(0 <= index && index < this.ends_.length);
@@ -170,6 +176,7 @@ ol.geom.MultiLineString.prototype.getLineString = function(index) {
/**
* @return {Array.<ol.geom.LineString>} LineStrings.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.getLineStrings = function() {
var flatCoordinates = this.flatCoordinates;
@@ -230,6 +237,7 @@ ol.geom.MultiLineString.prototype.getSimplifiedGeometryInternal =
/**
* @inheritDoc
* @todo api
*/
ol.geom.MultiLineString.prototype.getType = function() {
return ol.geom.GeometryType.MULTI_LINE_STRING;
@@ -240,6 +248,7 @@ ol.geom.MultiLineString.prototype.getType = function() {
* @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.setCoordinates =
function(coordinates, opt_layout) {

View File

@@ -1,8 +0,0 @@
@exportSymbol ol.geom.MultiPoint
@exportProperty ol.geom.MultiPoint.prototype.appendPoint
@exportProperty ol.geom.MultiPoint.prototype.clone
@exportProperty ol.geom.MultiPoint.prototype.getCoordinates
@exportProperty ol.geom.MultiPoint.prototype.getPoint
@exportProperty ol.geom.MultiPoint.prototype.getPoints
@exportProperty ol.geom.MultiPoint.prototype.getType
@exportProperty ol.geom.MultiPoint.prototype.setCoordinates

View File

@@ -19,6 +19,7 @@ goog.require('ol.math');
* @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint = function(coordinates, opt_layout) {
goog.base(this);
@@ -30,6 +31,7 @@ goog.inherits(ol.geom.MultiPoint, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.Point} point Point.
* @todo api
*/
ol.geom.MultiPoint.prototype.appendPoint = function(point) {
goog.asserts.assert(point.getLayout() == this.layout);
@@ -44,6 +46,7 @@ ol.geom.MultiPoint.prototype.appendPoint = function(point) {
/**
* @inheritDoc
* @todo api
*/
ol.geom.MultiPoint.prototype.clone = function() {
var multiPoint = new ol.geom.MultiPoint(null);
@@ -82,6 +85,7 @@ ol.geom.MultiPoint.prototype.closestPointXY =
/**
* @return {ol.geom.RawMultiPoint} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinates(
@@ -92,6 +96,7 @@ ol.geom.MultiPoint.prototype.getCoordinates = function() {
/**
* @param {number} index Index.
* @return {ol.geom.Point} Point.
* @todo api
*/
ol.geom.MultiPoint.prototype.getPoint = function(index) {
var n = goog.isNull(this.flatCoordinates) ?
@@ -110,6 +115,7 @@ ol.geom.MultiPoint.prototype.getPoint = function(index) {
/**
* @return {Array.<ol.geom.Point>} Points.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.getPoints = function() {
var flatCoordinates = this.flatCoordinates;
@@ -129,6 +135,7 @@ ol.geom.MultiPoint.prototype.getPoints = function() {
/**
* @inheritDoc
* @todo api
*/
ol.geom.MultiPoint.prototype.getType = function() {
return ol.geom.GeometryType.MULTI_POINT;
@@ -139,6 +146,7 @@ ol.geom.MultiPoint.prototype.getType = function() {
* @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.setCoordinates =
function(coordinates, opt_layout) {

View File

@@ -1,10 +0,0 @@
@exportSymbol ol.geom.MultiPolygon
@exportProperty ol.geom.MultiPolygon.prototype.appendPolygon
@exportProperty ol.geom.MultiPolygon.prototype.clone
@exportProperty ol.geom.MultiPolygon.prototype.getArea
@exportProperty ol.geom.MultiPolygon.prototype.getCoordinates
@exportProperty ol.geom.MultiPolygon.prototype.getInteriorPoints
@exportProperty ol.geom.MultiPolygon.prototype.getPolygon
@exportProperty ol.geom.MultiPolygon.prototype.getPolygons
@exportProperty ol.geom.MultiPolygon.prototype.getType
@exportProperty ol.geom.MultiPolygon.prototype.setCoordinates

View File

@@ -26,6 +26,7 @@ goog.require('ol.geom.flat.simplify');
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon = function(coordinates, opt_layout) {
@@ -82,6 +83,7 @@ goog.inherits(ol.geom.MultiPolygon, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.Polygon} polygon Polygon.
* @todo api
*/
ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) {
goog.asserts.assert(polygon.getLayout() == this.layout);
@@ -107,6 +109,7 @@ ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) {
/**
* @inheritDoc
* @todo api
*/
ol.geom.MultiPolygon.prototype.clone = function() {
var multiPolygon = new ol.geom.MultiPolygon(null);
@@ -148,6 +151,7 @@ ol.geom.MultiPolygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getArea = function() {
return ol.geom.flat.area.linearRingss(
@@ -158,6 +162,7 @@ ol.geom.MultiPolygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawMultiPolygon} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinatesss(
@@ -191,6 +196,7 @@ ol.geom.MultiPolygon.prototype.getFlatInteriorPoints = function() {
/**
* @return {ol.geom.MultiPoint} Interior points.
* @todo api
*/
ol.geom.MultiPolygon.prototype.getInteriorPoints = function() {
var interiorPoints = new ol.geom.MultiPoint(null);
@@ -242,6 +248,7 @@ ol.geom.MultiPolygon.prototype.getSimplifiedGeometryInternal =
/**
* @param {number} index Index.
* @return {ol.geom.Polygon} Polygon.
* @todo api
*/
ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
goog.asserts.assert(0 <= index && index < this.endss_.length);
@@ -273,6 +280,7 @@ ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
/**
* @return {Array.<ol.geom.Polygon>} Polygons.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getPolygons = function() {
var layout = this.layout;
@@ -301,6 +309,7 @@ ol.geom.MultiPolygon.prototype.getPolygons = function() {
/**
* @inheritDoc
* @todo api
*/
ol.geom.MultiPolygon.prototype.getType = function() {
return ol.geom.GeometryType.MULTI_POLYGON;
@@ -311,6 +320,7 @@ ol.geom.MultiPolygon.prototype.getType = function() {
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.setCoordinates =
function(coordinates, opt_layout) {

View File

@@ -1,5 +0,0 @@
@exportSymbol ol.geom.Point
@exportProperty ol.geom.Point.prototype.clone
@exportProperty ol.geom.Point.prototype.getCoordinates
@exportProperty ol.geom.Point.prototype.getType
@exportProperty ol.geom.Point.prototype.setCoordinates

View File

@@ -15,6 +15,7 @@ goog.require('ol.math');
* @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.Point = function(coordinates, opt_layout) {
goog.base(this);
@@ -26,6 +27,7 @@ goog.inherits(ol.geom.Point, ol.geom.SimpleGeometry);
/**
* @inheritDoc
* @todo api
*/
ol.geom.Point.prototype.clone = function() {
var point = new ol.geom.Point(null);
@@ -59,6 +61,7 @@ ol.geom.Point.prototype.closestPointXY =
/**
* @return {ol.geom.RawPoint} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.Point.prototype.getCoordinates = function() {
return this.flatCoordinates.slice();
@@ -81,6 +84,7 @@ ol.geom.Point.prototype.getExtent = function(opt_extent) {
/**
* @inheritDoc
* @todo api
*/
ol.geom.Point.prototype.getType = function() {
return ol.geom.GeometryType.POINT;
@@ -91,6 +95,7 @@ ol.geom.Point.prototype.getType = function() {
* @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) {
if (goog.isNull(coordinates)) {

View File

@@ -1,10 +0,0 @@
@exportSymbol ol.geom.Polygon
@exportProperty ol.geom.Polygon.prototype.appendLinearRing
@exportProperty ol.geom.Polygon.prototype.clone
@exportProperty ol.geom.Polygon.prototype.getArea
@exportProperty ol.geom.Polygon.prototype.getCoordinates
@exportProperty ol.geom.Polygon.prototype.getInteriorPoint
@exportProperty ol.geom.Polygon.prototype.getLinearRing
@exportProperty ol.geom.Polygon.prototype.getLinearRings
@exportProperty ol.geom.Polygon.prototype.getType
@exportProperty ol.geom.Polygon.prototype.setCoordinates

View File

@@ -25,6 +25,7 @@ goog.require('ol.geom.flat.simplify');
* @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon = function(coordinates, opt_layout) {
@@ -81,6 +82,7 @@ goog.inherits(ol.geom.Polygon, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.LinearRing} linearRing Linear ring.
* @todo api
*/
ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) {
goog.asserts.assert(linearRing.getLayout() == this.layout);
@@ -96,6 +98,7 @@ ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) {
/**
* @inheritDoc
* @todo api
*/
ol.geom.Polygon.prototype.clone = function() {
var polygon = new ol.geom.Polygon(null);
@@ -137,6 +140,7 @@ ol.geom.Polygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getArea = function() {
return ol.geom.flat.area.linearRings(
@@ -147,6 +151,7 @@ ol.geom.Polygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawPolygon} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinatess(
@@ -179,6 +184,7 @@ ol.geom.Polygon.prototype.getFlatInteriorPoint = function() {
/**
* @return {ol.geom.Point} Interior point.
* @todo api
*/
ol.geom.Polygon.prototype.getInteriorPoint = function() {
return new ol.geom.Point(this.getFlatInteriorPoint());
@@ -188,6 +194,7 @@ ol.geom.Polygon.prototype.getInteriorPoint = function() {
/**
* @param {number} index Index.
* @return {ol.geom.LinearRing} Linear ring.
* @todo api
*/
ol.geom.Polygon.prototype.getLinearRing = function(index) {
goog.asserts.assert(0 <= index && index < this.ends_.length);
@@ -204,6 +211,7 @@ ol.geom.Polygon.prototype.getLinearRing = function(index) {
/**
* @return {Array.<ol.geom.LinearRing>} Linear rings.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getLinearRings = function() {
var layout = this.layout;
@@ -264,6 +272,7 @@ ol.geom.Polygon.prototype.getSimplifiedGeometryInternal =
/**
* @inheritDoc
* @todo api
*/
ol.geom.Polygon.prototype.getType = function() {
return ol.geom.GeometryType.POLYGON;
@@ -274,6 +283,7 @@ ol.geom.Polygon.prototype.getType = function() {
* @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {
if (goog.isNull(coordinates)) {

View File

@@ -1,7 +0,0 @@
@exportSymbol ol.geom.SimpleGeometry
@exportProperty ol.geom.SimpleGeometry.prototype.getExtent
@exportProperty ol.geom.SimpleGeometry.prototype.getFirstCoordinate
@exportProperty ol.geom.SimpleGeometry.prototype.getLastCoordinate
@exportProperty ol.geom.SimpleGeometry.prototype.getLayout
@exportProperty ol.geom.SimpleGeometry.prototype.getSimplifiedGeometry
@exportProperty ol.geom.SimpleGeometry.prototype.transform

View File

@@ -13,6 +13,7 @@ goog.require('ol.geom.flat.transform');
* @constructor
* @extends {ol.geom.Geometry}
* @todo stability experimental
* @todo api
*/
ol.geom.SimpleGeometry = function() {
@@ -86,6 +87,7 @@ ol.geom.SimpleGeometry.prototype.containsXY = goog.functions.FALSE;
/**
* @inheritDoc
* @todo api
*/
ol.geom.SimpleGeometry.prototype.getExtent = function(opt_extent) {
if (this.extentRevision != this.getRevision()) {
@@ -101,6 +103,7 @@ ol.geom.SimpleGeometry.prototype.getExtent = function(opt_extent) {
/**
* @return {ol.Coordinate} First coordinate.
* @todo api
*/
ol.geom.SimpleGeometry.prototype.getFirstCoordinate = function() {
return this.flatCoordinates.slice(0, this.stride);
@@ -117,6 +120,7 @@ ol.geom.SimpleGeometry.prototype.getFlatCoordinates = function() {
/**
* @return {ol.Coordinate} Last point.
* @todo api
*/
ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() {
return this.flatCoordinates.slice(this.flatCoordinates.length - this.stride);
@@ -126,6 +130,7 @@ ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() {
/**
* @return {ol.geom.GeometryLayout} Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.SimpleGeometry.prototype.getLayout = function() {
return this.layout;
@@ -134,6 +139,7 @@ ol.geom.SimpleGeometry.prototype.getLayout = function() {
/**
* @inheritDoc
* @todo api
*/
ol.geom.SimpleGeometry.prototype.getSimplifiedGeometry =
function(squaredTolerance) {
@@ -238,6 +244,7 @@ ol.geom.SimpleGeometry.prototype.setLayout =
/**
* @inheritDoc
* @todo api
*/
ol.geom.SimpleGeometry.prototype.transform = function(transformFn) {
if (!goog.isNull(this.flatCoordinates)) {

View File

@@ -1 +0,0 @@
@exportProperty ol.ImageTile.prototype.getImage

View File

@@ -69,6 +69,7 @@ goog.inherits(ol.ImageTile, ol.Tile);
/**
* @inheritDoc
* @todo stability experimental
* @todo api
*/
ol.ImageTile.prototype.getImage = function(opt_context) {
if (goog.isDef(opt_context)) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.interaction.DoubleClickZoom

View File

@@ -16,6 +16,7 @@ goog.require('ol.interaction.Interaction');
* @extends {ol.interaction.Interaction}
* @param {olx.interaction.DoubleClickZoomOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.interaction.DoubleClickZoom = function(opt_options) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.interaction.DragAndDrop

View File

@@ -22,6 +22,7 @@ goog.require('ol.proj');
* @fires {@link ol.interaction.DragAndDropEvent}
* ol.interaction.DragAndDropEvent
* @param {olx.interaction.DragAndDropOptions=} opt_options Options.
* @todo api
*/
ol.interaction.DragAndDrop = function(opt_options) {

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.interaction.DragBox
@exportProperty ol.interaction.DragBox.prototype.getGeometry

View File

@@ -84,6 +84,7 @@ goog.inherits(ol.DragBoxEvent, goog.events.Event);
* @fires {@link ol.DragBoxEvent} ol.DragBoxEvent
* @param {olx.interaction.DragBoxOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.interaction.DragBox = function(opt_options) {
@@ -135,6 +136,7 @@ ol.interaction.DragBox.prototype.handlePointerDrag = function(mapBrowserEvent) {
/**
* Returns geometry of last drawn box.
* @return {ol.geom.Geometry} Geometry.
* @todo api
*/
ol.interaction.DragBox.prototype.getGeometry = function() {
return this.box_.getGeometry();

View File

@@ -1 +0,0 @@
@exportSymbol ol.interaction.DragPan

View File

@@ -19,6 +19,7 @@ goog.require('ol.interaction.Pointer');
* @extends {ol.interaction.Pointer}
* @param {olx.interaction.DragPanOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.interaction.DragPan = function(opt_options) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.interaction.DragRotate

View File

@@ -1 +0,0 @@
@exportSymbol ol.interaction.DragRotateAndZoom

View File

@@ -32,6 +32,7 @@ ol.interaction.DRAGROTATEANDZOOM_ANIMATION_DURATION = 400;
* @extends {ol.interaction.Pointer}
* @param {olx.interaction.DragRotateAndZoomOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.interaction.DragRotateAndZoom = function(opt_options) {

View File

@@ -25,6 +25,7 @@ ol.interaction.DRAGROTATE_ANIMATION_DURATION = 250;
* @constructor
* @extends {ol.interaction.Pointer}
* @param {olx.interaction.DragRotateOptions=} opt_options Options.
* @todo api
*/
ol.interaction.DragRotate = function(opt_options) {

Some files were not shown because too many files have changed in this diff Show More