Add default stability level to docs of exported things.
This commit is contained in:
2
build.py
2
build.py
@@ -374,6 +374,7 @@ virtual('lint', 'build/lint-timestamp', 'build/lint-generated-timestamp',
|
|||||||
def build_lint_src_timestamp(t):
|
def build_lint_src_timestamp(t):
|
||||||
t.run('%(GJSLINT)s',
|
t.run('%(GJSLINT)s',
|
||||||
'--jslint_error=all',
|
'--jslint_error=all',
|
||||||
|
'--custom_jsdoc_tags=todo',
|
||||||
'--strict',
|
'--strict',
|
||||||
t.newer(t.dependencies))
|
t.newer(t.dependencies))
|
||||||
t.touch()
|
t.touch()
|
||||||
@@ -390,6 +391,7 @@ def build_lint_generated_timestamp(t):
|
|||||||
'--jslint_error=all',
|
'--jslint_error=all',
|
||||||
# ignore error for max line length (for these auto-generated sources)
|
# ignore error for max line length (for these auto-generated sources)
|
||||||
'--disable=110',
|
'--disable=110',
|
||||||
|
'--custom_jsdoc_tags=todo',
|
||||||
# for a complete list of error codes to allow, see
|
# for a complete list of error codes to allow, see
|
||||||
# http://closure-linter.googlecode.com/svn/trunk/closure_linter/errors.py
|
# http://closure-linter.googlecode.com/svn/trunk/closure_linter/errors.py
|
||||||
'--limited_doc_files=%s' % (','.join(limited_doc_files),),
|
'--limited_doc_files=%s' % (','.join(limited_doc_files),),
|
||||||
|
|||||||
@@ -3,11 +3,13 @@
|
|||||||
* @property {string} html HTML markup for this attribution.
|
* @property {string} html HTML markup for this attribution.
|
||||||
* @property {Object.<string, Array.<ol.TileRange>>|undefined} tileRanges
|
* @property {Object.<string, Array.<ol.TileRange>>|undefined} tileRanges
|
||||||
* Tile ranges (FOR INTERNAL USE ONLY).
|
* Tile ranges (FOR INTERNAL USE ONLY).
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} ol.DeviceOrientationOptions
|
* @typedef {Object} ol.DeviceOrientationOptions
|
||||||
* @property {boolean|undefined} tracking Start tracking. Default is false.
|
* @property {boolean|undefined} tracking Start tracking. Default is false.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -15,6 +17,7 @@
|
|||||||
* @property {boolean|undefined} tracking Start Tracking. Default is false.
|
* @property {boolean|undefined} tracking Start Tracking. Default is false.
|
||||||
* @property {GeolocationPositionOptions|undefined} trackingOptions Tracking options.
|
* @property {GeolocationPositionOptions|undefined} trackingOptions Tracking options.
|
||||||
* @property {ol.proj.ProjectionLike} projection Projection.
|
* @property {ol.proj.ProjectionLike} projection Projection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -30,6 +33,7 @@
|
|||||||
* @property {function()|undefined} error Callback for unsuccessful queries.
|
* @property {function()|undefined} error Callback for unsuccessful queries.
|
||||||
* Note that queries with no matching features trigger the success callback,
|
* Note that queries with no matching features trigger the success callback,
|
||||||
* not the error callback.
|
* not the error callback.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -45,6 +49,7 @@
|
|||||||
* @property {function()|undefined} error Callback for unsuccessful queries.
|
* @property {function()|undefined} error Callback for unsuccessful queries.
|
||||||
* Note that queries with no matching features trigger the success callback,
|
* Note that queries with no matching features trigger the success callback,
|
||||||
* not the error callback.
|
* not the error callback.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -63,6 +68,7 @@
|
|||||||
* @property {Element|string|undefined} target The container for the map.
|
* @property {Element|string|undefined} target The container for the map.
|
||||||
* @property {ol.IView|undefined} view The map's view. Currently
|
* @property {ol.IView|undefined} view The map's view. Currently
|
||||||
* {@link ol.View2D} is available as view.
|
* {@link ol.View2D} is available as view.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -74,6 +80,7 @@
|
|||||||
* @property {ol.OverlayPositioning|undefined} positioning Positioning.
|
* @property {ol.OverlayPositioning|undefined} positioning Positioning.
|
||||||
* @property {boolean|undefined} stopEvent Whether event propagation to the map
|
* @property {boolean|undefined} stopEvent Whether event propagation to the map
|
||||||
* should be stopped. Default is `false`.
|
* should be stopped. Default is `false`.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -83,6 +90,7 @@
|
|||||||
* @property {ol.Extent|undefined} extent The validity extent for the SRS.
|
* @property {ol.Extent|undefined} extent The validity extent for the SRS.
|
||||||
* @property {boolean|undefined} global Whether the projection is valid for the
|
* @property {boolean|undefined} global Whether the projection is valid for the
|
||||||
* whole globe. Default is false.
|
* whole globe. Default is false.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -95,6 +103,7 @@
|
|||||||
* specified in Proj4. The default is `enu`.
|
* specified in Proj4. The default is `enu`.
|
||||||
* @property {boolean|undefined} global Whether the projection is valid for the
|
* @property {boolean|undefined} global Whether the projection is valid for the
|
||||||
* whole globe. Default is false.
|
* whole globe. Default is false.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -131,6 +140,7 @@
|
|||||||
* @property {number|undefined} zoomFactor The zoom factor used to determine the
|
* @property {number|undefined} zoomFactor The zoom factor used to determine the
|
||||||
* resolution constraint. Used together with `maxResolution` and `maxZoom`.
|
* resolution constraint. Used together with `maxResolution` and `maxZoom`.
|
||||||
* Default is 2.
|
* Default is 2.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -139,6 +149,7 @@
|
|||||||
* @property {number|undefined} start The start time of the animation. Default is immediately.
|
* @property {number|undefined} start The start time of the animation. Default is immediately.
|
||||||
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is 1000.
|
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is 1000.
|
||||||
* @property {function(number):number|undefined} easing The easing function to use. Default is `ol.easing.upAndDown`
|
* @property {function(number):number|undefined} easing The easing function to use. Default is `ol.easing.upAndDown`
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -147,6 +158,7 @@
|
|||||||
* @property {number|undefined} start The start time of the animation. Default is immediately.
|
* @property {number|undefined} start The start time of the animation. Default is immediately.
|
||||||
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is 1000.
|
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is 1000.
|
||||||
* @property {function(number):number|undefined} easing The easing function to use. Default is `ol.easing.inAndOut`
|
* @property {function(number):number|undefined} easing The easing function to use. Default is `ol.easing.inAndOut`
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -155,6 +167,7 @@
|
|||||||
* @property {number|undefined} start The start time of the animation. Default is immediately.
|
* @property {number|undefined} start The start time of the animation. Default is immediately.
|
||||||
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is 1000.
|
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is 1000.
|
||||||
* @property {function(number):number|undefined} easing The easing function to use. Default is `ol.easing.inAndOut`
|
* @property {function(number):number|undefined} easing The easing function to use. Default is `ol.easing.inAndOut`
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -163,18 +176,21 @@
|
|||||||
* @property {number|undefined} start The start time of the animation. Default is immediately.
|
* @property {number|undefined} start The start time of the animation. Default is immediately.
|
||||||
* @property {number|undefined} duration The duration of the animation in milliseconds.
|
* @property {number|undefined} duration The duration of the animation in milliseconds.
|
||||||
* @property {function(number):number|undefined} easing Easing function.
|
* @property {function(number):number|undefined} easing Easing function.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} ol.control.AttributionOptions
|
* @typedef {Object} ol.control.AttributionOptions
|
||||||
* @property {string|undefined} className CSS class name. Default is `ol-attribution`.
|
* @property {string|undefined} className CSS class name. Default is `ol-attribution`.
|
||||||
* @property {Element|undefined} target Target.
|
* @property {Element|undefined} target Target.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} ol.control.ControlOptions
|
* @typedef {Object} ol.control.ControlOptions
|
||||||
* @property {Element|undefined} element Element.
|
* @property {Element|undefined} element Element.
|
||||||
* @property {Element|undefined} target Target.
|
* @property {Element|undefined} target Target.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -186,6 +202,7 @@
|
|||||||
* @property {ol.control.LogoOptions|undefined} logoOptions Logo options.
|
* @property {ol.control.LogoOptions|undefined} logoOptions Logo options.
|
||||||
* @property {boolean|undefined} zoom Zoom.
|
* @property {boolean|undefined} zoom Zoom.
|
||||||
* @property {ol.control.ZoomOptions|undefined} zoomOptions Zoom options.
|
* @property {ol.control.ZoomOptions|undefined} zoomOptions Zoom options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -193,12 +210,14 @@
|
|||||||
* @property {string|undefined} className CSS class name. Default is `ol-full-screen`.
|
* @property {string|undefined} className CSS class name. Default is `ol-full-screen`.
|
||||||
* @property {boolean|undefined} keys Full keyboard access.
|
* @property {boolean|undefined} keys Full keyboard access.
|
||||||
* @property {Element|undefined} target Target.
|
* @property {Element|undefined} target Target.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} ol.control.LogoOptions
|
* @typedef {Object} ol.control.LogoOptions
|
||||||
* @property {string|undefined} className CSS class name. Default is `ol-logo`.
|
* @property {string|undefined} className CSS class name. Default is `ol-logo`.
|
||||||
* @property {Element|undefined} target Target.
|
* @property {Element|undefined} target Target.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -210,6 +229,7 @@
|
|||||||
* @property {Element|undefined} target Target.
|
* @property {Element|undefined} target Target.
|
||||||
* @property {string|undefined} undefinedHTML Markup for undefined coordinates.
|
* @property {string|undefined} undefinedHTML Markup for undefined coordinates.
|
||||||
* Default is `` (empty string).
|
* Default is `` (empty string).
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -218,6 +238,7 @@
|
|||||||
* @property {number|undefined} minWidth Minimum width in pixels.
|
* @property {number|undefined} minWidth Minimum width in pixels.
|
||||||
* @property {Element|undefined} target Target.
|
* @property {Element|undefined} target Target.
|
||||||
* @property {ol.control.ScaleLineUnits|undefined} units Units.
|
* @property {ol.control.ScaleLineUnits|undefined} units Units.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -226,6 +247,7 @@
|
|||||||
* @property {string|undefined} className CSS class name. Default is `ol-zoom`.
|
* @property {string|undefined} className CSS class name. Default is `ol-zoom`.
|
||||||
* @property {number|undefined} delta The zoom delta applied on each click.
|
* @property {number|undefined} delta The zoom delta applied on each click.
|
||||||
* @property {Element|undefined} target Target.
|
* @property {Element|undefined} target Target.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -233,6 +255,7 @@
|
|||||||
* @property {string|undefined} className CSS class name.
|
* @property {string|undefined} className CSS class name.
|
||||||
* @property {number|undefined} maxResolution Maximum resolution.
|
* @property {number|undefined} maxResolution Maximum resolution.
|
||||||
* @property {number|undefined} minResolution Minimum resolution.
|
* @property {number|undefined} minResolution Minimum resolution.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -241,6 +264,7 @@
|
|||||||
* @property {Element|undefined} target Target.
|
* @property {Element|undefined} target Target.
|
||||||
* @property {ol.Extent|undefined} extent The extent to zoom to. If
|
* @property {ol.Extent|undefined} extent The extent to zoom to. If
|
||||||
* undefined the validity extent of the view projection is used.
|
* undefined the validity extent of the view projection is used.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -248,6 +272,7 @@
|
|||||||
* @property {number|undefined} duration Animation duration. Default is 250ms.
|
* @property {number|undefined} duration Animation duration. Default is 250ms.
|
||||||
* @property {number|undefined} delta The zoom delta applied on each double
|
* @property {number|undefined} delta The zoom delta applied on each double
|
||||||
* click, default is 1.
|
* click, default is 1.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -256,6 +281,7 @@
|
|||||||
* @property {ol.interaction.ConditionType|undefined} condition A conditional
|
* @property {ol.interaction.ConditionType|undefined} condition A conditional
|
||||||
* modifier (i.e. Shift key) that determines if the interaction is active
|
* modifier (i.e. Shift key) that determines if the interaction is active
|
||||||
* or not, default is no modifiers.
|
* or not, default is no modifiers.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -263,6 +289,7 @@
|
|||||||
* @property {ol.interaction.ConditionType|undefined} condition A conditional
|
* @property {ol.interaction.ConditionType|undefined} condition A conditional
|
||||||
* modifier (i.e. Shift key) that determines if the interaction is active
|
* modifier (i.e. Shift key) that determines if the interaction is active
|
||||||
* or not, default is both shift and alt keys.
|
* or not, default is both shift and alt keys.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -270,6 +297,7 @@
|
|||||||
* @property {ol.interaction.ConditionType|undefined} condition A conditional
|
* @property {ol.interaction.ConditionType|undefined} condition A conditional
|
||||||
* modifier (i.e. Shift key) that determines if the interaction is active
|
* modifier (i.e. Shift key) that determines if the interaction is active
|
||||||
* or not, default is shify key.
|
* or not, default is shify key.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -277,6 +305,7 @@
|
|||||||
* @property {ol.interaction.ConditionType|undefined} condition A conditional
|
* @property {ol.interaction.ConditionType|undefined} condition A conditional
|
||||||
* modifier (i.e. Shift key) that determines if the interaction is active
|
* modifier (i.e. Shift key) that determines if the interaction is active
|
||||||
* or not, default is shift key.
|
* or not, default is shift key.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -299,6 +328,7 @@
|
|||||||
* @property {boolean|undefined} touchZoom Whether touch zoom is desired.
|
* @property {boolean|undefined} touchZoom Whether touch zoom is desired.
|
||||||
* @property {number|undefined} zoomDelta Zoom delta.
|
* @property {number|undefined} zoomDelta Zoom delta.
|
||||||
* @property {number|undefined} zoomDuration Zoom duration.
|
* @property {number|undefined} zoomDuration Zoom duration.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -308,6 +338,7 @@
|
|||||||
* or not, default is no modifiers.
|
* or not, default is no modifiers.
|
||||||
* @property {number|undefined} pixelDelta Pixel The amount to pan on each key
|
* @property {number|undefined} pixelDelta Pixel The amount to pan on each key
|
||||||
* press
|
* press
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -317,11 +348,13 @@
|
|||||||
* modifier (i.e. Shift key) that determines if the interaction is active
|
* modifier (i.e. Shift key) that determines if the interaction is active
|
||||||
* or not, default is no modifiers.
|
* or not, default is no modifiers.
|
||||||
* @property {number|undefined} delta The amount to zoom on each key press.
|
* @property {number|undefined} delta The amount to zoom on each key press.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} ol.interaction.MouseWheelZoomOptions
|
* @typedef {Object} ol.interaction.MouseWheelZoomOptions
|
||||||
* @property {number|undefined} duration Animation duration. Default is 250ms.
|
* @property {number|undefined} duration Animation duration. Default is 250ms.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -336,22 +369,26 @@
|
|||||||
* toggles the selection.
|
* toggles the selection.
|
||||||
* @property {undefined|function(ol.layer.Layer):boolean} layerFilter Filter
|
* @property {undefined|function(ol.layer.Layer):boolean} layerFilter Filter
|
||||||
* function to restrict selection to a subset of layers.
|
* function to restrict selection to a subset of layers.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} ol.interaction.TouchPanOptions
|
* @typedef {Object} ol.interaction.TouchPanOptions
|
||||||
* @property {ol.Kinetic|undefined} kinetic Kinetic inertia to apply to the
|
* @property {ol.Kinetic|undefined} kinetic Kinetic inertia to apply to the
|
||||||
* pan.
|
* pan.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} ol.interaction.TouchRotateOptions
|
* @typedef {Object} ol.interaction.TouchRotateOptions
|
||||||
* @property {number|undefined} threshold Minimal angle to start a rotation.
|
* @property {number|undefined} threshold Minimal angle to start a rotation.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} ol.interaction.TouchZoomOptions
|
* @typedef {Object} ol.interaction.TouchZoomOptions
|
||||||
* @property {number|undefined} duration Animation duration. Default is 400ms.
|
* @property {number|undefined} duration Animation duration. Default is 400ms.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -366,6 +403,7 @@
|
|||||||
* (inclusive) at which this layer will be visible.
|
* (inclusive) at which this layer will be visible.
|
||||||
* @property {number|undefined} maxResolution The maximum resolution
|
* @property {number|undefined} maxResolution The maximum resolution
|
||||||
* (exclusive) below which this layer will be visible.
|
* (exclusive) below which this layer will be visible.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -381,6 +419,7 @@
|
|||||||
* (inclusive) at which this layer will be visible.
|
* (inclusive) at which this layer will be visible.
|
||||||
* @property {number|undefined} maxResolution The maximum resolution
|
* @property {number|undefined} maxResolution The maximum resolution
|
||||||
* (exclusive) below which this layer will be visible.
|
* (exclusive) below which this layer will be visible.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -396,6 +435,7 @@
|
|||||||
* @property {number|undefined} maxResolution The maximum resolution
|
* @property {number|undefined} maxResolution The maximum resolution
|
||||||
* (exclusive) below which this layer will be visible.
|
* (exclusive) below which this layer will be visible.
|
||||||
* @property {Array.<ol.layer.Base>|ol.Collection|undefined} layers Child layers.
|
* @property {Array.<ol.layer.Base>|ol.Collection|undefined} layers Child layers.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -412,6 +452,7 @@
|
|||||||
* (inclusive) at which this layer will be visible.
|
* (inclusive) at which this layer will be visible.
|
||||||
* @property {number|undefined} maxResolution The maximum resolution
|
* @property {number|undefined} maxResolution The maximum resolution
|
||||||
* (exclusive) below which this layer will be visible.
|
* (exclusive) below which this layer will be visible.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -428,6 +469,7 @@
|
|||||||
* (inclusive) at which this layer will be visible.
|
* (inclusive) at which this layer will be visible.
|
||||||
* @property {number|undefined} maxResolution The maximum resolution
|
* @property {number|undefined} maxResolution The maximum resolution
|
||||||
* (exclusive) below which this layer will be visible.
|
* (exclusive) below which this layer will be visible.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -440,17 +482,20 @@
|
|||||||
* Default is 0, which means we don't follow network links at all.
|
* Default is 0, which means we don't follow network links at all.
|
||||||
* @property {Array.<string>|undefined} trackAttributes Track attributes to
|
* @property {Array.<string>|undefined} trackAttributes Track attributes to
|
||||||
* parse.
|
* parse.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} ol.parser.GMLReadOptions
|
* @typedef {Object} ol.parser.GMLReadOptions
|
||||||
* @property {string|undefined} axisOrientation The axis orientation.
|
* @property {string|undefined} axisOrientation The axis orientation.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} ol.parser.GMLWriteOptions
|
* @typedef {Object} ol.parser.GMLWriteOptions
|
||||||
* @property {ol.proj.ProjectionLike} srsName The srsName to use when writing.
|
* @property {ol.proj.ProjectionLike} srsName The srsName to use when writing.
|
||||||
* @property {string|undefined} axisOrientation The axis orientation.
|
* @property {string|undefined} axisOrientation The axis orientation.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -482,6 +527,7 @@
|
|||||||
* use for this instance.
|
* use for this instance.
|
||||||
* @property {ol.parser.GMLWriteOptions|undefined} writeOptions writeOptions
|
* @property {ol.parser.GMLWriteOptions|undefined} writeOptions writeOptions
|
||||||
* to use for this instance.
|
* to use for this instance.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -499,6 +545,7 @@
|
|||||||
* Default is `true´.
|
* Default is `true´.
|
||||||
* @property {boolean|undefined} extractRoutes Extract routes from GPX.
|
* @property {boolean|undefined} extractRoutes Extract routes from GPX.
|
||||||
* Default is `true´.
|
* Default is `true´.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -507,6 +554,7 @@
|
|||||||
* out.
|
* out.
|
||||||
* @property {Object|undefined} metadata Metadata key/value pair with keys:
|
* @property {Object|undefined} metadata Metadata key/value pair with keys:
|
||||||
* name, desc and author.
|
* name, desc and author.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -517,12 +565,14 @@
|
|||||||
* @property {string} style Style.
|
* @property {string} style Style.
|
||||||
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
|
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
|
||||||
* function to load a tile given a URL.
|
* function to load a tile given a URL.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} ol.source.MapQuestOptions
|
* @typedef {Object} ol.source.MapQuestOptions
|
||||||
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
|
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
|
||||||
* function to load a tile given a URL.
|
* function to load a tile given a URL.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -530,6 +580,7 @@
|
|||||||
* @property {ol.Extent|undefined} extent Extent.
|
* @property {ol.Extent|undefined} extent Extent.
|
||||||
* @property {ol.proj.ProjectionLike} projection Projection.
|
* @property {ol.proj.ProjectionLike} projection Projection.
|
||||||
* @property {ol.tilegrid.TileGrid|undefined} tileGrid Tile grid.
|
* @property {ol.tilegrid.TileGrid|undefined} tileGrid Tile grid.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -539,6 +590,7 @@
|
|||||||
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
|
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
|
||||||
* function to load a tile given a URL.
|
* function to load a tile given a URL.
|
||||||
* @property {string|undefined} url URL.
|
* @property {string|undefined} url URL.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -560,6 +612,7 @@
|
|||||||
* @property {Array.<number>|undefined} resolutions Resolutions. If specified,
|
* @property {Array.<number>|undefined} resolutions Resolutions. If specified,
|
||||||
* requests will be made for these resolutions only.
|
* requests will be made for these resolutions only.
|
||||||
* @property {string|undefined} url WMS service URL.
|
* @property {string|undefined} url WMS service URL.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -571,6 +624,7 @@
|
|||||||
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
|
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
|
||||||
* function to load a tile given a URL.
|
* function to load a tile given a URL.
|
||||||
* @property {string|undefined} url URL.
|
* @property {string|undefined} url URL.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -583,6 +637,7 @@
|
|||||||
* @property {ol.Size|undefined} imageSize Size of the image.
|
* @property {ol.Size|undefined} imageSize Size of the image.
|
||||||
* @property {ol.proj.ProjectionLike} projection Projection.
|
* @property {ol.proj.ProjectionLike} projection Projection.
|
||||||
* @property {string|undefined} url URL.
|
* @property {string|undefined} url URL.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -592,6 +647,7 @@
|
|||||||
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
|
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
|
||||||
* function to load a tile given a URL.
|
* function to load a tile given a URL.
|
||||||
* @property {string} url URL.
|
* @property {string} url URL.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -615,6 +671,7 @@
|
|||||||
* @property {string|undefined} url WMS service URL.
|
* @property {string|undefined} url WMS service URL.
|
||||||
* @property {Array.<string>|undefined} urls WMS service urls. Use this instead
|
* @property {Array.<string>|undefined} urls WMS service urls. Use this instead
|
||||||
* of `url` when the WMS supports multiple urls for GetMap requests.
|
* of `url` when the WMS supports multiple urls for GetMap requests.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -630,6 +687,7 @@
|
|||||||
* the parser does not know the SRS (e.g. in some GML flavors), or if the
|
* the parser does not know the SRS (e.g. in some GML flavors), or if the
|
||||||
* projection determined by the parser needs to be overridden.
|
* projection determined by the parser needs to be overridden.
|
||||||
* @property {string|undefined} url Server url providing the vector data.
|
* @property {string|undefined} url Server url providing the vector data.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -641,6 +699,7 @@
|
|||||||
* @property {Array.<ol.geom2.PointCollection>|undefined} pointCollections
|
* @property {Array.<ol.geom2.PointCollection>|undefined} pointCollections
|
||||||
* Point collections.
|
* Point collections.
|
||||||
* @property {ol.proj.ProjectionLike} projection Projection.
|
* @property {ol.proj.ProjectionLike} projection Projection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
@@ -650,6 +709,7 @@
|
|||||||
* GetFeatureInfo. Default is `ol.source.WMSGetFeatureInfoMethod.IFRAME`.
|
* GetFeatureInfo. Default is `ol.source.WMSGetFeatureInfoMethod.IFRAME`.
|
||||||
* @property {Object} params Params for the GetFeatureInfo request. Default is
|
* @property {Object} params Params for the GetFeatureInfo request. Default is
|
||||||
* `{'INFO_FORMAT': 'text/html'}`.
|
* `{'INFO_FORMAT': 'text/html'}`.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
@@ -675,6 +735,7 @@
|
|||||||
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
|
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
|
||||||
* function to load a tile given a URL.
|
* function to load a tile given a URL.
|
||||||
* @property {Array.<string>|undefined} urls Urls.
|
* @property {Array.<string>|undefined} urls Urls.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -696,6 +757,7 @@
|
|||||||
* @property {string|undefined} url URL template. Must include `{x}`, `{y}`,
|
* @property {string|undefined} url URL template. Must include `{x}`, `{y}`,
|
||||||
* and `{z}` placeholders.
|
* and `{z}` placeholders.
|
||||||
* @property {Array.<string>|undefined} urls An array of URL templates.
|
* @property {Array.<string>|undefined} urls An array of URL templates.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -714,6 +776,7 @@
|
|||||||
* @property {number|ol.expr.Expression|undefined} yOffset Pixel offset from the
|
* @property {number|ol.expr.Expression|undefined} yOffset Pixel offset from the
|
||||||
* point to the center of the icon (positive values shift image down).
|
* point to the center of the icon (positive values shift image down).
|
||||||
* @property {number|ol.expr.Expression|undefined} zIndex Stack order.
|
* @property {number|ol.expr.Expression|undefined} zIndex Stack order.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -722,6 +785,7 @@
|
|||||||
* code.
|
* code.
|
||||||
* @property {number|ol.expr.Expression|undefined} opacity Opacity (0-1).
|
* @property {number|ol.expr.Expression|undefined} opacity Opacity (0-1).
|
||||||
* @property {number|ol.expr.Expression|undefined} zIndex Stack order.
|
* @property {number|ol.expr.Expression|undefined} zIndex Stack order.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -734,6 +798,7 @@
|
|||||||
* a value is provided, the rule will apply at resolutions greater than or
|
* a value is provided, the rule will apply at resolutions greater than or
|
||||||
* equal to this value.
|
* equal to this value.
|
||||||
* @property {Array.<ol.style.Symbolizer>|undefined} symbolizers Symbolizers.
|
* @property {Array.<ol.style.Symbolizer>|undefined} symbolizers Symbolizers.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -743,6 +808,7 @@
|
|||||||
* @property {ol.style.Fill|undefined} fill Fill symbolizer for shape.
|
* @property {ol.style.Fill|undefined} fill Fill symbolizer for shape.
|
||||||
* @property {ol.style.Stroke|undefined} stroke Stroke symbolizer for shape.
|
* @property {ol.style.Stroke|undefined} stroke Stroke symbolizer for shape.
|
||||||
* @property {number|ol.expr.Expression|undefined} zIndex Stack order.
|
* @property {number|ol.expr.Expression|undefined} zIndex Stack order.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -752,6 +818,7 @@
|
|||||||
* @property {number|ol.expr.Expression|undefined} opacity Stroke opacity (0-1).
|
* @property {number|ol.expr.Expression|undefined} opacity Stroke opacity (0-1).
|
||||||
* @property {number|ol.expr.Expression|undefined} width Stroke width in pixels.
|
* @property {number|ol.expr.Expression|undefined} width Stroke width in pixels.
|
||||||
* @property {number|ol.expr.Expression|undefined} zIndex Stack order.
|
* @property {number|ol.expr.Expression|undefined} zIndex Stack order.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -760,6 +827,7 @@
|
|||||||
* @property {Array.<ol.style.Symbolizer>|undefined} symbolizers Symbolizers
|
* @property {Array.<ol.style.Symbolizer>|undefined} symbolizers Symbolizers
|
||||||
* (that apply if no rules are provided or where none of the provided rules
|
* (that apply if no rules are provided or where none of the provided rules
|
||||||
* apply).
|
* apply).
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -772,6 +840,7 @@
|
|||||||
* @property {number|ol.expr.Expression|undefined} opacity Opacity (0-1).
|
* @property {number|ol.expr.Expression|undefined} opacity Opacity (0-1).
|
||||||
* @property {ol.style.Stroke|undefined} stroke Stroke symbolizer for text.
|
* @property {ol.style.Stroke|undefined} stroke Stroke symbolizer for text.
|
||||||
* @property {number|ol.expr.Expression|undefined} zIndex Stack order.
|
* @property {number|ol.expr.Expression|undefined} zIndex Stack order.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -782,6 +851,7 @@
|
|||||||
* @property {!Array.<number>} resolutions Resolutions.
|
* @property {!Array.<number>} resolutions Resolutions.
|
||||||
* @property {ol.Size|undefined} tileSize Tile size.
|
* @property {ol.Size|undefined} tileSize Tile size.
|
||||||
* @property {Array.<ol.Size>|undefined} tileSizes Tile sizes.
|
* @property {Array.<ol.Size>|undefined} tileSizes Tile sizes.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -792,9 +862,11 @@
|
|||||||
* @property {!Array.<string>} matrixIds matrix IDs.
|
* @property {!Array.<string>} matrixIds matrix IDs.
|
||||||
* @property {ol.Size|undefined} tileSize Tile size.
|
* @property {ol.Size|undefined} tileSize Tile size.
|
||||||
* @property {Array.<ol.Size>|undefined} tileSizes Tile sizes.
|
* @property {Array.<ol.Size>|undefined} tileSizes Tile sizes.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} ol.tilegrid.XYZOptions
|
* @typedef {Object} ol.tilegrid.XYZOptions
|
||||||
* @property {number} maxZoom Maximum zoom.
|
* @property {number} maxZoom Maximum zoom.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ goog.require('ol.easing');
|
|||||||
/**
|
/**
|
||||||
* @param {ol.animation.BounceOptions} options Bounce options.
|
* @param {ol.animation.BounceOptions} options Bounce options.
|
||||||
* @return {ol.PreRenderFunction} Pre-render function.
|
* @return {ol.PreRenderFunction} Pre-render function.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.animation.bounce = function(options) {
|
ol.animation.bounce = function(options) {
|
||||||
var resolution = options.resolution;
|
var resolution = options.resolution;
|
||||||
@@ -44,6 +45,7 @@ ol.animation.bounce = function(options) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.animation.PanOptions} options Pan options.
|
* @param {ol.animation.PanOptions} options Pan options.
|
||||||
* @return {ol.PreRenderFunction} Pre-render function.
|
* @return {ol.PreRenderFunction} Pre-render function.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.animation.pan = function(options) {
|
ol.animation.pan = function(options) {
|
||||||
var source = options.source;
|
var source = options.source;
|
||||||
@@ -82,6 +84,7 @@ ol.animation.pan = function(options) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.animation.RotateOptions} options Rotate options.
|
* @param {ol.animation.RotateOptions} options Rotate options.
|
||||||
* @return {ol.PreRenderFunction} Pre-render function.
|
* @return {ol.PreRenderFunction} Pre-render function.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.animation.rotate = function(options) {
|
ol.animation.rotate = function(options) {
|
||||||
var sourceRotation = options.rotation;
|
var sourceRotation = options.rotation;
|
||||||
@@ -118,6 +121,7 @@ ol.animation.rotate = function(options) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.animation.ZoomOptions} options Zoom options.
|
* @param {ol.animation.ZoomOptions} options Zoom options.
|
||||||
* @return {ol.PreRenderFunction} Pre-render function.
|
* @return {ol.PreRenderFunction} Pre-render function.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.animation.zoom = function(options) {
|
ol.animation.zoom = function(options) {
|
||||||
var sourceResolution = options.resolution;
|
var sourceResolution = options.resolution;
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ goog.require('ol.TileRange');
|
|||||||
*
|
*
|
||||||
* @constructor
|
* @constructor
|
||||||
* @param {ol.AttributionOptions} options Attribution options.
|
* @param {ol.AttributionOptions} options Attribution options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Attribution = function(options) {
|
ol.Attribution = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ goog.require('goog.math');
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {function((ol.Coordinate|undefined)): (ol.Coordinate|undefined)}
|
* @typedef {function((ol.Coordinate|undefined)): (ol.Coordinate|undefined)}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.CenterConstraintType;
|
ol.CenterConstraintType;
|
||||||
|
|
||||||
|
|||||||
@@ -66,6 +66,7 @@ ol.CollectionProperty = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.Object}
|
* @extends {ol.Object}
|
||||||
* @param {Array=} opt_array Array.
|
* @param {Array=} opt_array Array.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection = function(opt_array) {
|
ol.Collection = function(opt_array) {
|
||||||
|
|
||||||
@@ -85,6 +86,7 @@ goog.inherits(ol.Collection, ol.Object);
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove all elements from the collection.
|
* Remove all elements from the collection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection.prototype.clear = function() {
|
ol.Collection.prototype.clear = function() {
|
||||||
while (this.getLength() > 0) {
|
while (this.getLength() > 0) {
|
||||||
@@ -96,6 +98,7 @@ ol.Collection.prototype.clear = function() {
|
|||||||
/**
|
/**
|
||||||
* @param {Array} arr Array.
|
* @param {Array} arr Array.
|
||||||
* @return {ol.Collection} This collection.
|
* @return {ol.Collection} This collection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection.prototype.extend = function(arr) {
|
ol.Collection.prototype.extend = function(arr) {
|
||||||
var i, ii;
|
var i, ii;
|
||||||
@@ -113,6 +116,7 @@ ol.Collection.prototype.extend = function(arr) {
|
|||||||
* value is ignored.
|
* value is ignored.
|
||||||
* @param {Object=} opt_obj The object to be used as the value of 'this'
|
* @param {Object=} opt_obj The object to be used as the value of 'this'
|
||||||
* within f.
|
* within f.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection.prototype.forEach = function(f, opt_obj) {
|
ol.Collection.prototype.forEach = function(f, opt_obj) {
|
||||||
goog.array.forEach(this.array_, f, opt_obj);
|
goog.array.forEach(this.array_, f, opt_obj);
|
||||||
@@ -125,6 +129,7 @@ ol.Collection.prototype.forEach = function(f, opt_obj) {
|
|||||||
* collection's "length" property won't be in sync with the actual length
|
* collection's "length" property won't be in sync with the actual length
|
||||||
* of the array.
|
* of the array.
|
||||||
* @return {Array} Array.
|
* @return {Array} Array.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection.prototype.getArray = function() {
|
ol.Collection.prototype.getArray = function() {
|
||||||
return this.array_;
|
return this.array_;
|
||||||
@@ -135,6 +140,7 @@ ol.Collection.prototype.getArray = function() {
|
|||||||
* Get the element at the provided index.
|
* Get the element at the provided index.
|
||||||
* @param {number} index Index.
|
* @param {number} index Index.
|
||||||
* @return {*} Element.
|
* @return {*} Element.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection.prototype.getAt = function(index) {
|
ol.Collection.prototype.getAt = function(index) {
|
||||||
return this.array_[index];
|
return this.array_[index];
|
||||||
@@ -144,6 +150,7 @@ ol.Collection.prototype.getAt = function(index) {
|
|||||||
/**
|
/**
|
||||||
* Get the length of this collection.
|
* Get the length of this collection.
|
||||||
* @return {number} Length.
|
* @return {number} Length.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection.prototype.getLength = function() {
|
ol.Collection.prototype.getLength = function() {
|
||||||
return /** @type {number} */ (this.get(ol.CollectionProperty.LENGTH));
|
return /** @type {number} */ (this.get(ol.CollectionProperty.LENGTH));
|
||||||
@@ -154,6 +161,7 @@ ol.Collection.prototype.getLength = function() {
|
|||||||
* Insert an element at the provided index.
|
* Insert an element at the provided index.
|
||||||
* @param {number} index Index.
|
* @param {number} index Index.
|
||||||
* @param {*} elem Element.
|
* @param {*} elem Element.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection.prototype.insertAt = function(index, elem) {
|
ol.Collection.prototype.insertAt = function(index, elem) {
|
||||||
goog.array.insertAt(this.array_, elem, index);
|
goog.array.insertAt(this.array_, elem, index);
|
||||||
@@ -166,6 +174,7 @@ ol.Collection.prototype.insertAt = function(index, elem) {
|
|||||||
/**
|
/**
|
||||||
* Remove the last element of the collection.
|
* Remove the last element of the collection.
|
||||||
* @return {*} Element.
|
* @return {*} Element.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection.prototype.pop = function() {
|
ol.Collection.prototype.pop = function() {
|
||||||
return this.removeAt(this.getLength() - 1);
|
return this.removeAt(this.getLength() - 1);
|
||||||
@@ -176,6 +185,7 @@ ol.Collection.prototype.pop = function() {
|
|||||||
* Insert the provided element at the end of the collection.
|
* Insert the provided element at the end of the collection.
|
||||||
* @param {*} elem Element.
|
* @param {*} elem Element.
|
||||||
* @return {number} Length.
|
* @return {number} Length.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection.prototype.push = function(elem) {
|
ol.Collection.prototype.push = function(elem) {
|
||||||
var n = this.array_.length;
|
var n = this.array_.length;
|
||||||
@@ -188,6 +198,7 @@ ol.Collection.prototype.push = function(elem) {
|
|||||||
* Removes the first occurence of elem from the collection.
|
* Removes the first occurence of elem from the collection.
|
||||||
* @param {*} elem Element.
|
* @param {*} elem Element.
|
||||||
* @return {*} The removed element or undefined if elem was not found.
|
* @return {*} The removed element or undefined if elem was not found.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection.prototype.remove = function(elem) {
|
ol.Collection.prototype.remove = function(elem) {
|
||||||
var arr = this.array_;
|
var arr = this.array_;
|
||||||
@@ -205,6 +216,7 @@ ol.Collection.prototype.remove = function(elem) {
|
|||||||
* Remove the element at the provided index.
|
* Remove the element at the provided index.
|
||||||
* @param {number} index Index.
|
* @param {number} index Index.
|
||||||
* @return {*} Value.
|
* @return {*} Value.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection.prototype.removeAt = function(index) {
|
ol.Collection.prototype.removeAt = function(index) {
|
||||||
var prev = this.array_[index];
|
var prev = this.array_[index];
|
||||||
@@ -220,6 +232,7 @@ ol.Collection.prototype.removeAt = function(index) {
|
|||||||
* Set the element at the provided index.
|
* Set the element at the provided index.
|
||||||
* @param {number} index Index.
|
* @param {number} index Index.
|
||||||
* @param {*} elem Element.
|
* @param {*} elem Element.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Collection.prototype.setAt = function(index, elem) {
|
ol.Collection.prototype.setAt = function(index, elem) {
|
||||||
var n = this.getLength();
|
var n = this.getLength();
|
||||||
|
|||||||
@@ -22,6 +22,7 @@ goog.require('ol.css');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.control.Control}
|
* @extends {ol.control.Control}
|
||||||
* @param {ol.control.AttributionOptions=} opt_options Attribution options.
|
* @param {ol.control.AttributionOptions=} opt_options Attribution options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.Attribution = function(opt_options) {
|
ol.control.Attribution = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ goog.require('ol.Object');
|
|||||||
* @extends {ol.Object}
|
* @extends {ol.Object}
|
||||||
* @implements {oli.control.Control}
|
* @implements {oli.control.Control}
|
||||||
* @param {ol.control.ControlOptions} options Control options.
|
* @param {ol.control.ControlOptions} options Control options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.Control = function(options) {
|
ol.control.Control = function(options) {
|
||||||
|
|
||||||
@@ -61,6 +62,7 @@ ol.control.Control.prototype.disposeInternal = function() {
|
|||||||
/**
|
/**
|
||||||
* Get the map associated with this control.
|
* Get the map associated with this control.
|
||||||
* @return {ol.Map} Map.
|
* @return {ol.Map} Map.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.Control.prototype.getMap = function() {
|
ol.control.Control.prototype.getMap = function() {
|
||||||
return this.map_;
|
return this.map_;
|
||||||
@@ -81,6 +83,7 @@ ol.control.Control.prototype.handleMapPostrender = goog.nullFunction;
|
|||||||
* Subclasses may set up event handlers to get notified about changes to
|
* Subclasses may set up event handlers to get notified about changes to
|
||||||
* the map here.
|
* the map here.
|
||||||
* @param {ol.Map} map Map.
|
* @param {ol.Map} map Map.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.Control.prototype.setMap = function(map) {
|
ol.control.Control.prototype.setMap = function(map) {
|
||||||
if (!goog.isNull(this.map_)) {
|
if (!goog.isNull(this.map_)) {
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ goog.require('ol.control.Zoom');
|
|||||||
/**
|
/**
|
||||||
* @param {ol.control.DefaultsOptions=} opt_options Defaults options.
|
* @param {ol.control.DefaultsOptions=} opt_options Defaults options.
|
||||||
* @return {ol.Collection} Controls.
|
* @return {ol.Collection} Controls.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.defaults = function(opt_options) {
|
ol.control.defaults = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -27,6 +27,7 @@ ol.control.DragBoxOptions;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.control.Control}
|
* @extends {ol.control.Control}
|
||||||
* @param {ol.control.DragBoxOptions} options Drag box options.
|
* @param {ol.control.DragBoxOptions} options Drag box options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.DragBox = function(options) {
|
ol.control.DragBox = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ goog.require('ol.css');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.control.Control}
|
* @extends {ol.control.Control}
|
||||||
* @param {ol.control.FullScreenOptions=} opt_options Options.
|
* @param {ol.control.FullScreenOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.FullScreen = function(opt_options) {
|
ol.control.FullScreen = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ goog.require('ol.css');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.control.Control}
|
* @extends {ol.control.Control}
|
||||||
* @param {ol.control.LogoOptions=} opt_options Logo options.
|
* @param {ol.control.LogoOptions=} opt_options Logo options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.Logo = function(opt_options) {
|
ol.control.Logo = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -37,6 +37,7 @@ ol.control.MousePositionProperty = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.control.Control}
|
* @extends {ol.control.Control}
|
||||||
* @param {ol.control.MousePositionOptions=} opt_options Mouse position options.
|
* @param {ol.control.MousePositionOptions=} opt_options Mouse position options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.MousePosition = function(opt_options) {
|
ol.control.MousePosition = function(opt_options) {
|
||||||
|
|
||||||
@@ -127,6 +128,7 @@ ol.control.MousePosition.prototype.handleProjectionChanged_ = function() {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {ol.CoordinateFormatType|undefined} projection.
|
* @return {ol.CoordinateFormatType|undefined} projection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.MousePosition.prototype.getCoordinateFormat = function() {
|
ol.control.MousePosition.prototype.getCoordinateFormat = function() {
|
||||||
return /** @type {ol.CoordinateFormatType|undefined} */ (
|
return /** @type {ol.CoordinateFormatType|undefined} */ (
|
||||||
@@ -140,6 +142,7 @@ goog.exportProperty(
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {ol.proj.Projection|undefined} projection.
|
* @return {ol.proj.Projection|undefined} projection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.MousePosition.prototype.getProjection = function() {
|
ol.control.MousePosition.prototype.getProjection = function() {
|
||||||
return /** @type {ol.proj.Projection|undefined} */ (
|
return /** @type {ol.proj.Projection|undefined} */ (
|
||||||
@@ -193,6 +196,7 @@ ol.control.MousePosition.prototype.setMap = function(map) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {ol.CoordinateFormatType} format Coordinate format.
|
* @param {ol.CoordinateFormatType} format Coordinate format.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.MousePosition.prototype.setCoordinateFormat = function(format) {
|
ol.control.MousePosition.prototype.setCoordinateFormat = function(format) {
|
||||||
this.set(ol.control.MousePositionProperty.COORDINATE_FORMAT, format);
|
this.set(ol.control.MousePositionProperty.COORDINATE_FORMAT, format);
|
||||||
@@ -205,6 +209,7 @@ goog.exportProperty(
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {ol.proj.Projection} projection Projection.
|
* @param {ol.proj.Projection} projection Projection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.MousePosition.prototype.setProjection = function(projection) {
|
ol.control.MousePosition.prototype.setProjection = function(projection) {
|
||||||
this.set(ol.control.MousePositionProperty.PROJECTION, projection);
|
this.set(ol.control.MousePositionProperty.PROJECTION, projection);
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ goog.require('ol.sphere.NORMAL');
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @enum {string}
|
* @enum {string}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.ScaleLineProperty = {
|
ol.control.ScaleLineProperty = {
|
||||||
UNITS: 'units'
|
UNITS: 'units'
|
||||||
@@ -29,6 +30,7 @@ ol.control.ScaleLineProperty = {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @enum {string}
|
* @enum {string}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.ScaleLineUnits = {
|
ol.control.ScaleLineUnits = {
|
||||||
DEGREES: 'degrees',
|
DEGREES: 'degrees',
|
||||||
@@ -48,6 +50,7 @@ ol.control.ScaleLineUnits = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.control.Control}
|
* @extends {ol.control.Control}
|
||||||
* @param {ol.control.ScaleLineOptions=} opt_options Scale line options.
|
* @param {ol.control.ScaleLineOptions=} opt_options Scale line options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.ScaleLine = function(opt_options) {
|
ol.control.ScaleLine = function(opt_options) {
|
||||||
|
|
||||||
@@ -126,12 +129,14 @@ goog.inherits(ol.control.ScaleLine, ol.control.Control);
|
|||||||
/**
|
/**
|
||||||
* @const
|
* @const
|
||||||
* @type {Array.<number>}
|
* @type {Array.<number>}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
|
ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {ol.control.ScaleLineUnits|undefined} units.
|
* @return {ol.control.ScaleLineUnits|undefined} units.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.ScaleLine.prototype.getUnits = function() {
|
ol.control.ScaleLine.prototype.getUnits = function() {
|
||||||
return /** @type {ol.control.ScaleLineUnits|undefined} */ (
|
return /** @type {ol.control.ScaleLineUnits|undefined} */ (
|
||||||
@@ -167,6 +172,7 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {ol.control.ScaleLineUnits} units Units.
|
* @param {ol.control.ScaleLineUnits} units Units.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.ScaleLine.prototype.setUnits = function(units) {
|
ol.control.ScaleLine.prototype.setUnits = function(units) {
|
||||||
this.set(ol.control.ScaleLineProperty.UNITS, units);
|
this.set(ol.control.ScaleLineProperty.UNITS, units);
|
||||||
|
|||||||
@@ -20,6 +20,7 @@ goog.require('ol.easing');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.control.Control}
|
* @extends {ol.control.Control}
|
||||||
* @param {ol.control.ZoomOptions=} opt_options Zoom options.
|
* @param {ol.control.ZoomOptions=} opt_options Zoom options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.Zoom = function(opt_options) {
|
ol.control.Zoom = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -38,6 +38,7 @@ ol.control.ZOOMSLIDER_ANIMATION_DURATION = 200;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.control.Control}
|
* @extends {ol.control.Control}
|
||||||
* @param {ol.control.ZoomSliderOptions=} opt_options Zoom slider options.
|
* @param {ol.control.ZoomSliderOptions=} opt_options Zoom slider options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.ZoomSlider = function(opt_options) {
|
ol.control.ZoomSlider = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ goog.require('ol.css');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.control.Control}
|
* @extends {ol.control.Control}
|
||||||
* @param {ol.control.ZoomToExtentOptions=} opt_options Options.
|
* @param {ol.control.ZoomToExtentOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.control.ZoomToExtent = function(opt_options) {
|
ol.control.ZoomToExtent = function(opt_options) {
|
||||||
var options = goog.isDef(opt_options) ? opt_options : {};
|
var options = goog.isDef(opt_options) ? opt_options : {};
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ goog.require('goog.math');
|
|||||||
/**
|
/**
|
||||||
* A function that formats a {@link ol.Coordinate} into a string.
|
* A function that formats a {@link ol.Coordinate} into a string.
|
||||||
* @typedef {function((ol.Coordinate|undefined)): string}
|
* @typedef {function((ol.Coordinate|undefined)): string}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.CoordinateFormatType;
|
ol.CoordinateFormatType;
|
||||||
|
|
||||||
@@ -16,6 +17,7 @@ ol.CoordinateFormatType;
|
|||||||
/**
|
/**
|
||||||
* An array of numbers representing a coordinate.
|
* An array of numbers representing a coordinate.
|
||||||
* @typedef {Array.<number>} ol.Coordinate
|
* @typedef {Array.<number>} ol.Coordinate
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Coordinate;
|
ol.Coordinate;
|
||||||
|
|
||||||
@@ -23,6 +25,7 @@ ol.Coordinate;
|
|||||||
/**
|
/**
|
||||||
* An array of coordinate arrays.
|
* An array of coordinate arrays.
|
||||||
* @typedef {Array.<ol.Coordinate>}
|
* @typedef {Array.<ol.Coordinate>}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.CoordinateArray;
|
ol.CoordinateArray;
|
||||||
|
|
||||||
@@ -42,6 +45,7 @@ ol.coordinate.add = function(coordinate, delta) {
|
|||||||
/**
|
/**
|
||||||
* @param {number=} opt_precision Precision.
|
* @param {number=} opt_precision Precision.
|
||||||
* @return {ol.CoordinateFormatType} Coordinate format.
|
* @return {ol.CoordinateFormatType} Coordinate format.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.coordinate.createStringXY = function(opt_precision) {
|
ol.coordinate.createStringXY = function(opt_precision) {
|
||||||
return (
|
return (
|
||||||
@@ -114,6 +118,7 @@ ol.coordinate.squaredDistance = function(coord1, coord2) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Coordinate|undefined} coordinate Coordinate.
|
* @param {ol.Coordinate|undefined} coordinate Coordinate.
|
||||||
* @return {string} Hemisphere, degrees, minutes and seconds.
|
* @return {string} Hemisphere, degrees, minutes and seconds.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.coordinate.toStringHDMS = function(coordinate) {
|
ol.coordinate.toStringHDMS = function(coordinate) {
|
||||||
if (goog.isDef(coordinate)) {
|
if (goog.isDef(coordinate)) {
|
||||||
@@ -129,6 +134,7 @@ ol.coordinate.toStringHDMS = function(coordinate) {
|
|||||||
* @param {ol.Coordinate|undefined} coordinate Coordinate.
|
* @param {ol.Coordinate|undefined} coordinate Coordinate.
|
||||||
* @param {number=} opt_precision Precision.
|
* @param {number=} opt_precision Precision.
|
||||||
* @return {string} XY.
|
* @return {string} XY.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.coordinate.toStringXY = function(coordinate, opt_precision) {
|
ol.coordinate.toStringXY = function(coordinate, opt_precision) {
|
||||||
if (goog.isDef(coordinate)) {
|
if (goog.isDef(coordinate)) {
|
||||||
@@ -146,6 +152,7 @@ ol.coordinate.toStringXY = function(coordinate, opt_precision) {
|
|||||||
* @param {Array} array The array with coordinates.
|
* @param {Array} array The array with coordinates.
|
||||||
* @param {string} axis the axis info.
|
* @param {string} axis the axis info.
|
||||||
* @return {ol.Coordinate} The coordinate created.
|
* @return {ol.Coordinate} The coordinate created.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.coordinate.fromProjectedArray = function(array, axis) {
|
ol.coordinate.fromProjectedArray = function(array, axis) {
|
||||||
var firstAxis = axis.charAt(0);
|
var firstAxis = axis.charAt(0);
|
||||||
|
|||||||
@@ -68,6 +68,7 @@ ol.DeviceOrientationProperty = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.Object}
|
* @extends {ol.Object}
|
||||||
* @param {ol.DeviceOrientationOptions=} opt_options Options.
|
* @param {ol.DeviceOrientationOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.DeviceOrientation = function(opt_options) {
|
ol.DeviceOrientation = function(opt_options) {
|
||||||
|
|
||||||
@@ -104,6 +105,7 @@ ol.DeviceOrientation.prototype.disposeInternal = function() {
|
|||||||
* Indicates if DeviceOrientation is supported in the user's browser.
|
* Indicates if DeviceOrientation is supported in the user's browser.
|
||||||
* @const
|
* @const
|
||||||
* @type {boolean}
|
* @type {boolean}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.DeviceOrientation.SUPPORTED = 'DeviceOrientationEvent' in goog.global;
|
ol.DeviceOrientation.SUPPORTED = 'DeviceOrientationEvent' in goog.global;
|
||||||
|
|
||||||
@@ -142,6 +144,7 @@ ol.DeviceOrientation.prototype.orientationChange_ = function(browserEvent) {
|
|||||||
/**
|
/**
|
||||||
* @return {number|undefined} The alpha value of the DeviceOrientation,
|
* @return {number|undefined} The alpha value of the DeviceOrientation,
|
||||||
* in radians.
|
* in radians.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.DeviceOrientation.prototype.getAlpha = function() {
|
ol.DeviceOrientation.prototype.getAlpha = function() {
|
||||||
return /** @type {number|undefined} */ (
|
return /** @type {number|undefined} */ (
|
||||||
@@ -156,6 +159,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* @return {number|undefined} The beta value of the DeviceOrientation,
|
* @return {number|undefined} The beta value of the DeviceOrientation,
|
||||||
* in radians.
|
* in radians.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.DeviceOrientation.prototype.getBeta = function() {
|
ol.DeviceOrientation.prototype.getBeta = function() {
|
||||||
return /** @type {number|undefined} */ (
|
return /** @type {number|undefined} */ (
|
||||||
@@ -170,6 +174,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* @return {number|undefined} The gamma value of the DeviceOrientation,
|
* @return {number|undefined} The gamma value of the DeviceOrientation,
|
||||||
* in radians.
|
* in radians.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.DeviceOrientation.prototype.getGamma = function() {
|
ol.DeviceOrientation.prototype.getGamma = function() {
|
||||||
return /** @type {number|undefined} */ (
|
return /** @type {number|undefined} */ (
|
||||||
@@ -184,6 +189,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* @return {number|undefined} The heading of the device relative to
|
* @return {number|undefined} The heading of the device relative to
|
||||||
* north, in radians, normalizing for different browser behavior.
|
* north, in radians, normalizing for different browser behavior.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.DeviceOrientation.prototype.getHeading = function() {
|
ol.DeviceOrientation.prototype.getHeading = function() {
|
||||||
return /** @type {number|undefined} */ (
|
return /** @type {number|undefined} */ (
|
||||||
@@ -198,6 +204,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Are we tracking the device's orientation?
|
* Are we tracking the device's orientation?
|
||||||
* @return {boolean} The current tracking state, true if tracking is on.
|
* @return {boolean} The current tracking state, true if tracking is on.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.DeviceOrientation.prototype.getTracking = function() {
|
ol.DeviceOrientation.prototype.getTracking = function() {
|
||||||
return /** @type {boolean} */ (
|
return /** @type {boolean} */ (
|
||||||
@@ -229,6 +236,7 @@ ol.DeviceOrientation.prototype.handleTrackingChanged_ = function() {
|
|||||||
/**
|
/**
|
||||||
* Enable or disable tracking of DeviceOrientation events.
|
* Enable or disable tracking of DeviceOrientation events.
|
||||||
* @param {boolean} tracking True to enable and false to disable tracking.
|
* @param {boolean} tracking True to enable and false to disable tracking.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.DeviceOrientation.prototype.setTracking = function(tracking) {
|
ol.DeviceOrientation.prototype.setTracking = function(tracking) {
|
||||||
this.set(ol.DeviceOrientationProperty.TRACKING, tracking);
|
this.set(ol.DeviceOrientationProperty.TRACKING, tracking);
|
||||||
|
|||||||
@@ -29,6 +29,7 @@ ol.dom.InputProperty = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.Object}
|
* @extends {ol.Object}
|
||||||
* @param {Element} target Target element.
|
* @param {Element} target Target element.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.dom.Input = function(target) {
|
ol.dom.Input = function(target) {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
@@ -58,6 +59,7 @@ goog.inherits(ol.dom.Input, ol.Object);
|
|||||||
/**
|
/**
|
||||||
* If the input is a checkbox, return whether or not the checbox is checked.
|
* If the input is a checkbox, return whether or not the checbox is checked.
|
||||||
* @return {boolean|undefined} checked.
|
* @return {boolean|undefined} checked.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.dom.Input.prototype.getChecked = function() {
|
ol.dom.Input.prototype.getChecked = function() {
|
||||||
return /** @type {boolean} */ (this.get(ol.dom.InputProperty.CHECKED));
|
return /** @type {boolean} */ (this.get(ol.dom.InputProperty.CHECKED));
|
||||||
@@ -71,6 +73,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Get the value of the input.
|
* Get the value of the input.
|
||||||
* @return {string|undefined} input value.
|
* @return {string|undefined} input value.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.dom.Input.prototype.getValue = function() {
|
ol.dom.Input.prototype.getValue = function() {
|
||||||
return /** @type {string} */ (this.get(ol.dom.InputProperty.VALUE));
|
return /** @type {string} */ (this.get(ol.dom.InputProperty.VALUE));
|
||||||
@@ -84,6 +87,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Get the value of the input as a number.
|
* Get the value of the input as a number.
|
||||||
* @return {number|null|undefined} input value as number.
|
* @return {number|null|undefined} input value as number.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.dom.Input.prototype.getValueAsNumber = function() {
|
ol.dom.Input.prototype.getValueAsNumber = function() {
|
||||||
return /** @type {number} */ (this.get(ol.dom.InputProperty.VALUE_AS_NUMBER));
|
return /** @type {number} */ (this.get(ol.dom.InputProperty.VALUE_AS_NUMBER));
|
||||||
@@ -97,6 +101,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Sets the value of the input.
|
* Sets the value of the input.
|
||||||
* @param {string} value Value.
|
* @param {string} value Value.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.dom.Input.prototype.setValue = function(value) {
|
ol.dom.Input.prototype.setValue = function(value) {
|
||||||
this.set(ol.dom.InputProperty.VALUE, value);
|
this.set(ol.dom.InputProperty.VALUE, value);
|
||||||
@@ -110,6 +115,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Sets the number value of the input.
|
* Sets the number value of the input.
|
||||||
* @param {number} value Number value.
|
* @param {number} value Number value.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.dom.Input.prototype.setValueAsNumber = function(value) {
|
ol.dom.Input.prototype.setValueAsNumber = function(value) {
|
||||||
this.set(ol.dom.InputProperty.VALUE_AS_NUMBER, value);
|
this.set(ol.dom.InputProperty.VALUE_AS_NUMBER, value);
|
||||||
@@ -123,6 +129,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Set whether or not a checkbox is checked.
|
* Set whether or not a checkbox is checked.
|
||||||
* @param {boolean} checked Checked.
|
* @param {boolean} checked Checked.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.dom.Input.prototype.setChecked = function(checked) {
|
ol.dom.Input.prototype.setChecked = function(checked) {
|
||||||
this.set(ol.dom.InputProperty.CHECKED, checked);
|
this.set(ol.dom.InputProperty.CHECKED, checked);
|
||||||
|
|||||||
@@ -34,6 +34,7 @@ ol.expr.evaluateFeature = function(expr, opt_feature) {
|
|||||||
* @param {string} source The expression source (e.g. `'foo + 2'`).
|
* @param {string} source The expression source (e.g. `'foo + 2'`).
|
||||||
* @return {ol.expr.Expression} An expression instance that can be
|
* @return {ol.expr.Expression} An expression instance that can be
|
||||||
* evaluated within some scope to provide a value.
|
* evaluated within some scope to provide a value.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.expr.parse = function(source) {
|
ol.expr.parse = function(source) {
|
||||||
var parser = new ol.expr.Parser();
|
var parser = new ol.expr.Parser();
|
||||||
@@ -47,6 +48,7 @@ ol.expr.parse = function(source) {
|
|||||||
* @param {function(this:ol.Feature)} func The function to be called in an
|
* @param {function(this:ol.Feature)} func The function to be called in an
|
||||||
* expression. This function will be called with a feature as the `this`
|
* expression. This function will be called with a feature as the `this`
|
||||||
* argument when the expression is evaluated in the context of a features.
|
* argument when the expression is evaluated in the context of a features.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.expr.register = function(name, func) {
|
ol.expr.register = function(name, func) {
|
||||||
ol.expr.lib[name] = func;
|
ol.expr.lib[name] = func;
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ goog.require('ol.TransformFunction');
|
|||||||
/**
|
/**
|
||||||
* An array of numbers representing an extent: `[minx, miny, maxx, maxy]`.
|
* An array of numbers representing an extent: `[minx, miny, maxx, maxy]`.
|
||||||
* @typedef {Array.<number>}
|
* @typedef {Array.<number>}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Extent;
|
ol.Extent;
|
||||||
|
|
||||||
@@ -19,6 +20,7 @@ ol.Extent;
|
|||||||
*
|
*
|
||||||
* @param {Array.<ol.Coordinate>} coordinates Coordinates.
|
* @param {Array.<ol.Coordinate>} coordinates Coordinates.
|
||||||
* @return {ol.Extent} Bounding extent.
|
* @return {ol.Extent} Bounding extent.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.boundingExtent = function(coordinates) {
|
ol.extent.boundingExtent = function(coordinates) {
|
||||||
var extent = ol.extent.createEmpty();
|
var extent = ol.extent.createEmpty();
|
||||||
@@ -37,6 +39,7 @@ ol.extent.boundingExtent = function(coordinates) {
|
|||||||
* @param {ol.Extent=} opt_extent Destination extent.
|
* @param {ol.Extent=} opt_extent Destination extent.
|
||||||
* @private
|
* @private
|
||||||
* @return {ol.Extent} Extent.
|
* @return {ol.Extent} Extent.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.boundingExtentXYs_ = function(xs, ys, opt_extent) {
|
ol.extent.boundingExtentXYs_ = function(xs, ys, opt_extent) {
|
||||||
goog.asserts.assert(xs.length > 0);
|
goog.asserts.assert(xs.length > 0);
|
||||||
@@ -54,6 +57,7 @@ ol.extent.boundingExtentXYs_ = function(xs, ys, opt_extent) {
|
|||||||
*
|
*
|
||||||
* @param {ol.Extent} extent Extent to clone.
|
* @param {ol.Extent} extent Extent to clone.
|
||||||
* @return {ol.Extent} The clone.
|
* @return {ol.Extent} The clone.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.clone = function(extent) {
|
ol.extent.clone = function(extent) {
|
||||||
return extent.slice();
|
return extent.slice();
|
||||||
@@ -66,6 +70,7 @@ ol.extent.clone = function(extent) {
|
|||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @param {ol.Coordinate} coordinate Coordinate.
|
* @param {ol.Coordinate} coordinate Coordinate.
|
||||||
* @return {boolean} Contains.
|
* @return {boolean} Contains.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.containsCoordinate = function(extent, coordinate) {
|
ol.extent.containsCoordinate = function(extent, coordinate) {
|
||||||
return extent[0] <= coordinate[0] && coordinate[0] <= extent[2] &&
|
return extent[0] <= coordinate[0] && coordinate[0] <= extent[2] &&
|
||||||
@@ -79,6 +84,7 @@ ol.extent.containsCoordinate = function(extent, coordinate) {
|
|||||||
* @param {ol.Extent} extent1 Extent 1.
|
* @param {ol.Extent} extent1 Extent 1.
|
||||||
* @param {ol.Extent} extent2 Extent 2.
|
* @param {ol.Extent} extent2 Extent 2.
|
||||||
* @return {boolean} Contains.
|
* @return {boolean} Contains.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.containsExtent = function(extent1, extent2) {
|
ol.extent.containsExtent = function(extent1, extent2) {
|
||||||
return extent1[0] <= extent2[0] && extent2[2] <= extent1[2] &&
|
return extent1[0] <= extent2[0] && extent2[2] <= extent1[2] &&
|
||||||
@@ -88,6 +94,7 @@ ol.extent.containsExtent = function(extent1, extent2) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {ol.Extent} Empty extent.
|
* @return {ol.Extent} Empty extent.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.createEmpty = function() {
|
ol.extent.createEmpty = function() {
|
||||||
return [Infinity, Infinity, -Infinity, -Infinity];
|
return [Infinity, Infinity, -Infinity, -Infinity];
|
||||||
@@ -101,6 +108,7 @@ ol.extent.createEmpty = function() {
|
|||||||
* @param {number} maxY Maximum Y.
|
* @param {number} maxY Maximum Y.
|
||||||
* @param {ol.Extent=} opt_extent Destination extent.
|
* @param {ol.Extent=} opt_extent Destination extent.
|
||||||
* @return {ol.Extent} Extent.
|
* @return {ol.Extent} Extent.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.createOrUpdate = function(minX, maxX, minY, maxY, opt_extent) {
|
ol.extent.createOrUpdate = function(minX, maxX, minY, maxY, opt_extent) {
|
||||||
if (goog.isDef(opt_extent)) {
|
if (goog.isDef(opt_extent)) {
|
||||||
@@ -119,6 +127,7 @@ ol.extent.createOrUpdate = function(minX, maxX, minY, maxY, opt_extent) {
|
|||||||
* Empties extent in place.
|
* Empties extent in place.
|
||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @return {ol.Extent} Extent.
|
* @return {ol.Extent} Extent.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.empty = function(extent) {
|
ol.extent.empty = function(extent) {
|
||||||
extent[0] = extent[1] = Infinity;
|
extent[0] = extent[1] = Infinity;
|
||||||
@@ -131,6 +140,7 @@ ol.extent.empty = function(extent) {
|
|||||||
* @param {ol.Extent} extent1 Extent 1.
|
* @param {ol.Extent} extent1 Extent 1.
|
||||||
* @param {ol.Extent} extent2 Extent 2.
|
* @param {ol.Extent} extent2 Extent 2.
|
||||||
* @return {boolean} Equals.
|
* @return {boolean} Equals.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.equals = function(extent1, extent2) {
|
ol.extent.equals = function(extent1, extent2) {
|
||||||
return extent1[0] == extent2[0] && extent1[2] == extent2[2] &&
|
return extent1[0] == extent2[0] && extent1[2] == extent2[2] &&
|
||||||
@@ -141,6 +151,7 @@ ol.extent.equals = function(extent1, extent2) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Extent} extent1 Extent 1.
|
* @param {ol.Extent} extent1 Extent 1.
|
||||||
* @param {ol.Extent} extent2 Extent 2.
|
* @param {ol.Extent} extent2 Extent 2.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.extend = function(extent1, extent2) {
|
ol.extent.extend = function(extent1, extent2) {
|
||||||
if (extent2[0] < extent1[0]) {
|
if (extent2[0] < extent1[0]) {
|
||||||
@@ -161,6 +172,7 @@ ol.extent.extend = function(extent1, extent2) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @param {ol.Coordinate} coordinate Coordinate.
|
* @param {ol.Coordinate} coordinate Coordinate.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.extendCoordinate = function(extent, coordinate) {
|
ol.extent.extendCoordinate = function(extent, coordinate) {
|
||||||
if (coordinate[0] < extent[0]) {
|
if (coordinate[0] < extent[0]) {
|
||||||
@@ -181,6 +193,7 @@ ol.extent.extendCoordinate = function(extent, coordinate) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @return {ol.Coordinate} Bottom left coordinate.
|
* @return {ol.Coordinate} Bottom left coordinate.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.getBottomLeft = function(extent) {
|
ol.extent.getBottomLeft = function(extent) {
|
||||||
return [extent[0], extent[1]];
|
return [extent[0], extent[1]];
|
||||||
@@ -190,6 +203,7 @@ ol.extent.getBottomLeft = function(extent) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @return {ol.Coordinate} Bottom right coordinate.
|
* @return {ol.Coordinate} Bottom right coordinate.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.getBottomRight = function(extent) {
|
ol.extent.getBottomRight = function(extent) {
|
||||||
return [extent[2], extent[1]];
|
return [extent[2], extent[1]];
|
||||||
@@ -199,6 +213,7 @@ ol.extent.getBottomRight = function(extent) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @return {ol.Coordinate} Center.
|
* @return {ol.Coordinate} Center.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.getCenter = function(extent) {
|
ol.extent.getCenter = function(extent) {
|
||||||
return [(extent[0] + extent[2]) / 2, (extent[1] + extent[3]) / 2];
|
return [(extent[0] + extent[2]) / 2, (extent[1] + extent[3]) / 2];
|
||||||
@@ -212,6 +227,7 @@ ol.extent.getCenter = function(extent) {
|
|||||||
* @param {ol.Size} size Size.
|
* @param {ol.Size} size Size.
|
||||||
* @param {ol.Extent=} opt_extent Destination extent.
|
* @param {ol.Extent=} opt_extent Destination extent.
|
||||||
* @return {ol.Extent} Extent.
|
* @return {ol.Extent} Extent.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.getForView2DAndSize =
|
ol.extent.getForView2DAndSize =
|
||||||
function(center, resolution, rotation, size, opt_extent) {
|
function(center, resolution, rotation, size, opt_extent) {
|
||||||
@@ -237,6 +253,7 @@ ol.extent.getForView2DAndSize =
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @return {number} Height.
|
* @return {number} Height.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.getHeight = function(extent) {
|
ol.extent.getHeight = function(extent) {
|
||||||
return extent[3] - extent[1];
|
return extent[3] - extent[1];
|
||||||
@@ -246,6 +263,7 @@ ol.extent.getHeight = function(extent) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @return {ol.Size} Size.
|
* @return {ol.Size} Size.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.getSize = function(extent) {
|
ol.extent.getSize = function(extent) {
|
||||||
return [extent[2] - extent[0], extent[3] - extent[1]];
|
return [extent[2] - extent[0], extent[3] - extent[1]];
|
||||||
@@ -255,6 +273,7 @@ ol.extent.getSize = function(extent) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @return {ol.Coordinate} Top left coordinate.
|
* @return {ol.Coordinate} Top left coordinate.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.getTopLeft = function(extent) {
|
ol.extent.getTopLeft = function(extent) {
|
||||||
return [extent[0], extent[3]];
|
return [extent[0], extent[3]];
|
||||||
@@ -264,6 +283,7 @@ ol.extent.getTopLeft = function(extent) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @return {ol.Coordinate} Top right coordinate.
|
* @return {ol.Coordinate} Top right coordinate.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.getTopRight = function(extent) {
|
ol.extent.getTopRight = function(extent) {
|
||||||
return [extent[2], extent[3]];
|
return [extent[2], extent[3]];
|
||||||
@@ -273,6 +293,7 @@ ol.extent.getTopRight = function(extent) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @return {number} Width.
|
* @return {number} Width.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.getWidth = function(extent) {
|
ol.extent.getWidth = function(extent) {
|
||||||
return extent[2] - extent[0];
|
return extent[2] - extent[0];
|
||||||
@@ -283,6 +304,7 @@ ol.extent.getWidth = function(extent) {
|
|||||||
* @param {ol.Extent} extent1 Extent 1.
|
* @param {ol.Extent} extent1 Extent 1.
|
||||||
* @param {ol.Extent} extent2 Extent.
|
* @param {ol.Extent} extent2 Extent.
|
||||||
* @return {boolean} Intersects.
|
* @return {boolean} Intersects.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.intersects = function(extent1, extent2) {
|
ol.extent.intersects = function(extent1, extent2) {
|
||||||
return extent1[0] <= extent2[2] &&
|
return extent1[0] <= extent2[2] &&
|
||||||
@@ -295,6 +317,7 @@ ol.extent.intersects = function(extent1, extent2) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @return {boolean} Is empty.
|
* @return {boolean} Is empty.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.isEmpty = function(extent) {
|
ol.extent.isEmpty = function(extent) {
|
||||||
return extent[2] < extent[0] || extent[3] < extent[1];
|
return extent[2] < extent[0] || extent[3] < extent[1];
|
||||||
@@ -305,6 +328,7 @@ ol.extent.isEmpty = function(extent) {
|
|||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @param {ol.Coordinate} coordinate Coordinate.
|
* @param {ol.Coordinate} coordinate Coordinate.
|
||||||
* @return {ol.Coordinate} Coordinate.
|
* @return {ol.Coordinate} Coordinate.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.normalize = function(extent, coordinate) {
|
ol.extent.normalize = function(extent, coordinate) {
|
||||||
return [
|
return [
|
||||||
@@ -317,6 +341,7 @@ ol.extent.normalize = function(extent, coordinate) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Extent} extent Extent.
|
* @param {ol.Extent} extent Extent.
|
||||||
* @param {number} value Value.
|
* @param {number} value Value.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.scaleFromCenter = function(extent, value) {
|
ol.extent.scaleFromCenter = function(extent, value) {
|
||||||
var deltaX = ((extent[2] - extent[0]) / 2) * (value - 1);
|
var deltaX = ((extent[2] - extent[0]) / 2) * (value - 1);
|
||||||
@@ -332,6 +357,7 @@ ol.extent.scaleFromCenter = function(extent, value) {
|
|||||||
* @param {ol.Extent} extent1 Extent 1.
|
* @param {ol.Extent} extent1 Extent 1.
|
||||||
* @param {ol.Extent} extent2 Extent 2.
|
* @param {ol.Extent} extent2 Extent 2.
|
||||||
* @return {boolean} Touches.
|
* @return {boolean} Touches.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.touches = function(extent1, extent2) {
|
ol.extent.touches = function(extent1, extent2) {
|
||||||
var intersects = ol.extent.intersects(extent1, extent2);
|
var intersects = ol.extent.intersects(extent1, extent2);
|
||||||
@@ -346,6 +372,7 @@ ol.extent.touches = function(extent1, extent2) {
|
|||||||
* @param {ol.TransformFunction} transformFn Transform function.
|
* @param {ol.TransformFunction} transformFn Transform function.
|
||||||
* @param {ol.Extent=} opt_extent Destination extent.
|
* @param {ol.Extent=} opt_extent Destination extent.
|
||||||
* @return {ol.Extent} Extent.
|
* @return {ol.Extent} Extent.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.extent.transform = function(extent, transformFn, opt_extent) {
|
ol.extent.transform = function(extent, transformFn, opt_extent) {
|
||||||
var coordinates = [
|
var coordinates = [
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ goog.require('ol.layer.VectorLayerRenderIntent');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.Object}
|
* @extends {ol.Object}
|
||||||
* @param {Object.<string, *>=} opt_values Attributes.
|
* @param {Object.<string, *>=} opt_values Attributes.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Feature = function(opt_values) {
|
ol.Feature = function(opt_values) {
|
||||||
|
|
||||||
@@ -60,6 +61,7 @@ goog.inherits(ol.Feature, ol.Object);
|
|||||||
/**
|
/**
|
||||||
* Gets a copy of the attributes of this feature.
|
* Gets a copy of the attributes of this feature.
|
||||||
* @return {Object.<string, *>} Attributes object.
|
* @return {Object.<string, *>} Attributes object.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Feature.prototype.getAttributes = function() {
|
ol.Feature.prototype.getAttributes = function() {
|
||||||
var keys = this.getKeys(),
|
var keys = this.getKeys(),
|
||||||
@@ -79,6 +81,7 @@ ol.Feature.prototype.getAttributes = function() {
|
|||||||
* the unique id in the source store.
|
* the unique id in the source store.
|
||||||
*
|
*
|
||||||
* @return {string|undefined} The feature's identifier.
|
* @return {string|undefined} The feature's identifier.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Feature.prototype.getId = function() {
|
ol.Feature.prototype.getId = function() {
|
||||||
return this.featureId_;
|
return this.featureId_;
|
||||||
@@ -88,6 +91,7 @@ ol.Feature.prototype.getId = function() {
|
|||||||
/**
|
/**
|
||||||
* Get the geometry associated with this feature.
|
* Get the geometry associated with this feature.
|
||||||
* @return {ol.geom.Geometry} The geometry (or null if none).
|
* @return {ol.geom.Geometry} The geometry (or null if none).
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Feature.prototype.getGeometry = function() {
|
ol.Feature.prototype.getGeometry = function() {
|
||||||
return goog.isDef(this.geometryName_) ?
|
return goog.isDef(this.geometryName_) ?
|
||||||
@@ -120,6 +124,7 @@ ol.Feature.prototype.handleGeometryChange_ = function(evt) {
|
|||||||
* @inheritDoc
|
* @inheritDoc
|
||||||
* @param {string} key Key.
|
* @param {string} key Key.
|
||||||
* @param {*} value Value.
|
* @param {*} value Value.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Feature.prototype.set = function(key, value) {
|
ol.Feature.prototype.set = function(key, value) {
|
||||||
var geometry = this.getGeometry();
|
var geometry = this.getGeometry();
|
||||||
@@ -160,6 +165,7 @@ ol.Feature.prototype.setId = function(featureId) {
|
|||||||
/**
|
/**
|
||||||
* Set the geometry to be associated with this feature after its creation.
|
* Set the geometry to be associated with this feature after its creation.
|
||||||
* @param {ol.geom.Geometry} geometry The geometry.
|
* @param {ol.geom.Geometry} geometry The geometry.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Feature.prototype.setGeometry = function(geometry) {
|
ol.Feature.prototype.setGeometry = function(geometry) {
|
||||||
if (!goog.isDef(this.geometryName_)) {
|
if (!goog.isDef(this.geometryName_)) {
|
||||||
|
|||||||
@@ -46,6 +46,7 @@ ol.GeolocationProperty = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.Object}
|
* @extends {ol.Object}
|
||||||
* @param {ol.GeolocationOptions=} opt_options Options.
|
* @param {ol.GeolocationOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation = function(opt_options) {
|
ol.Geolocation = function(opt_options) {
|
||||||
|
|
||||||
@@ -140,6 +141,7 @@ ol.Geolocation.prototype.handleTrackingChanged_ = function() {
|
|||||||
* Is HTML5 geolocation supported in the current browser?
|
* Is HTML5 geolocation supported in the current browser?
|
||||||
* @const
|
* @const
|
||||||
* @type {boolean}
|
* @type {boolean}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.SUPPORTED = 'geolocation' in goog.global.navigator;
|
ol.Geolocation.SUPPORTED = 'geolocation' in goog.global.navigator;
|
||||||
|
|
||||||
@@ -183,6 +185,7 @@ ol.Geolocation.prototype.positionError_ = function(error) {
|
|||||||
/**
|
/**
|
||||||
* Get the accuracy of the position in meters.
|
* Get the accuracy of the position in meters.
|
||||||
* @return {number|undefined} Position accuracy in meters.
|
* @return {number|undefined} Position accuracy in meters.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.prototype.getAccuracy = function() {
|
ol.Geolocation.prototype.getAccuracy = function() {
|
||||||
return /** @type {number|undefined} */ (
|
return /** @type {number|undefined} */ (
|
||||||
@@ -197,6 +200,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Get the altitude associated with the position.
|
* Get the altitude associated with the position.
|
||||||
* @return {number|undefined} The altitude in meters above the mean sea level.
|
* @return {number|undefined} The altitude in meters above the mean sea level.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.prototype.getAltitude = function() {
|
ol.Geolocation.prototype.getAltitude = function() {
|
||||||
return /** @type {number|undefined} */ (
|
return /** @type {number|undefined} */ (
|
||||||
@@ -211,6 +215,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Get the altitude accuracy of the position.
|
* Get the altitude accuracy of the position.
|
||||||
* @return {number|undefined} Altitude accuracy in meters.
|
* @return {number|undefined} Altitude accuracy in meters.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.prototype.getAltitudeAccuracy = function() {
|
ol.Geolocation.prototype.getAltitudeAccuracy = function() {
|
||||||
return /** @type {number|undefined} */ (
|
return /** @type {number|undefined} */ (
|
||||||
@@ -225,6 +230,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Get the heading as radians clockwise from North.
|
* Get the heading as radians clockwise from North.
|
||||||
* @return {number|undefined} Heading.
|
* @return {number|undefined} Heading.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.prototype.getHeading = function() {
|
ol.Geolocation.prototype.getHeading = function() {
|
||||||
return /** @type {number|undefined} */ (
|
return /** @type {number|undefined} */ (
|
||||||
@@ -239,6 +245,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Get the position of the device.
|
* Get the position of the device.
|
||||||
* @return {ol.Coordinate|undefined} position.
|
* @return {ol.Coordinate|undefined} position.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.prototype.getPosition = function() {
|
ol.Geolocation.prototype.getPosition = function() {
|
||||||
return /** @type {ol.Coordinate|undefined} */ (
|
return /** @type {ol.Coordinate|undefined} */ (
|
||||||
@@ -253,6 +260,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Get the projection associated with the position.
|
* Get the projection associated with the position.
|
||||||
* @return {ol.proj.Projection|undefined} projection.
|
* @return {ol.proj.Projection|undefined} projection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.prototype.getProjection = function() {
|
ol.Geolocation.prototype.getProjection = function() {
|
||||||
return /** @type {ol.proj.Projection|undefined} */ (
|
return /** @type {ol.proj.Projection|undefined} */ (
|
||||||
@@ -267,6 +275,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Get the speed in meters per second.
|
* Get the speed in meters per second.
|
||||||
* @return {number|undefined} Speed.
|
* @return {number|undefined} Speed.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.prototype.getSpeed = function() {
|
ol.Geolocation.prototype.getSpeed = function() {
|
||||||
return /** @type {number|undefined} */ (
|
return /** @type {number|undefined} */ (
|
||||||
@@ -281,6 +290,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Are we tracking the user's position?
|
* Are we tracking the user's position?
|
||||||
* @return {boolean} tracking.
|
* @return {boolean} tracking.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.prototype.getTracking = function() {
|
ol.Geolocation.prototype.getTracking = function() {
|
||||||
return /** @type {boolean} */ (
|
return /** @type {boolean} */ (
|
||||||
@@ -297,6 +307,7 @@ goog.exportProperty(
|
|||||||
* @see http://www.w3.org/TR/geolocation-API/#position-options
|
* @see http://www.w3.org/TR/geolocation-API/#position-options
|
||||||
* @return {GeolocationPositionOptions|undefined} HTML 5 Gelocation
|
* @return {GeolocationPositionOptions|undefined} HTML 5 Gelocation
|
||||||
* tracking options.
|
* tracking options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.prototype.getTrackingOptions = function() {
|
ol.Geolocation.prototype.getTrackingOptions = function() {
|
||||||
return /** @type {GeolocationPositionOptions|undefined} */ (
|
return /** @type {GeolocationPositionOptions|undefined} */ (
|
||||||
@@ -311,6 +322,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Set the projection to use for transforming the coordinates.
|
* Set the projection to use for transforming the coordinates.
|
||||||
* @param {ol.proj.Projection} projection Projection.
|
* @param {ol.proj.Projection} projection Projection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.prototype.setProjection = function(projection) {
|
ol.Geolocation.prototype.setProjection = function(projection) {
|
||||||
this.set(ol.GeolocationProperty.PROJECTION, projection);
|
this.set(ol.GeolocationProperty.PROJECTION, projection);
|
||||||
@@ -324,6 +336,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Enable/disable tracking.
|
* Enable/disable tracking.
|
||||||
* @param {boolean} tracking Enable or disable tracking.
|
* @param {boolean} tracking Enable or disable tracking.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.prototype.setTracking = function(tracking) {
|
ol.Geolocation.prototype.setTracking = function(tracking) {
|
||||||
this.set(ol.GeolocationProperty.TRACKING, tracking);
|
this.set(ol.GeolocationProperty.TRACKING, tracking);
|
||||||
@@ -339,6 +352,7 @@ goog.exportProperty(
|
|||||||
* @see http://www.w3.org/TR/geolocation-API/#position-options
|
* @see http://www.w3.org/TR/geolocation-API/#position-options
|
||||||
* @param {GeolocationPositionOptions} options HTML 5 Geolocation
|
* @param {GeolocationPositionOptions} options HTML 5 Geolocation
|
||||||
* tracking options.
|
* tracking options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Geolocation.prototype.setTrackingOptions = function(options) {
|
ol.Geolocation.prototype.setTrackingOptions = function(options) {
|
||||||
this.set(ol.GeolocationProperty.TRACKING_OPTIONS, options);
|
this.set(ol.GeolocationProperty.TRACKING_OPTIONS, options);
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ goog.require('ol.TransformFunction');
|
|||||||
/**
|
/**
|
||||||
* @constructor
|
* @constructor
|
||||||
* @extends {goog.events.EventTarget}
|
* @extends {goog.events.EventTarget}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom.Geometry = function() {
|
ol.geom.Geometry = function() {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
@@ -76,6 +77,7 @@ goog.inherits(ol.geom.GeometryEvent, goog.events.Event);
|
|||||||
* Geometry types.
|
* Geometry types.
|
||||||
*
|
*
|
||||||
* @enum {string}
|
* @enum {string}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom.GeometryType = {
|
ol.geom.GeometryType = {
|
||||||
POINT: 'point',
|
POINT: 'point',
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ goog.require('ol.geom.GeometryType');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.geom.AbstractCollection}
|
* @extends {ol.geom.AbstractCollection}
|
||||||
* @param {Array.<ol.geom.Geometry>} geometries Array of geometries.
|
* @param {Array.<ol.geom.Geometry>} geometries Array of geometries.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom.GeometryCollection = function(geometries) {
|
ol.geom.GeometryCollection = function(geometries) {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ goog.require('ol.geom.LineString');
|
|||||||
* @extends {ol.geom.LineString}
|
* @extends {ol.geom.LineString}
|
||||||
* @param {ol.CoordinateArray} coordinates Vertex array (e.g.
|
* @param {ol.CoordinateArray} coordinates Vertex array (e.g.
|
||||||
* [[x0, y0], [x1, y1]]).
|
* [[x0, y0], [x1, y1]]).
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom.LinearRing = function(coordinates) {
|
ol.geom.LinearRing = function(coordinates) {
|
||||||
goog.base(this, coordinates);
|
goog.base(this, coordinates);
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ goog.require('ol.geom.GeometryType');
|
|||||||
* @extends {ol.geom.Geometry}
|
* @extends {ol.geom.Geometry}
|
||||||
* @param {ol.CoordinateArray} coordinates Array of coordinates (e.g.
|
* @param {ol.CoordinateArray} coordinates Array of coordinates (e.g.
|
||||||
* [[x0, y0], [x1, y1]]).
|
* [[x0, y0], [x1, y1]]).
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom.LineString = function(coordinates) {
|
ol.geom.LineString = function(coordinates) {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ goog.require('ol.geom.LineString');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.geom.AbstractCollection}
|
* @extends {ol.geom.AbstractCollection}
|
||||||
* @param {Array.<ol.CoordinateArray>} coordinates Coordinates array.
|
* @param {Array.<ol.CoordinateArray>} coordinates Coordinates array.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom.MultiLineString = function(coordinates) {
|
ol.geom.MultiLineString = function(coordinates) {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ goog.require('ol.geom.Point');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.geom.AbstractCollection}
|
* @extends {ol.geom.AbstractCollection}
|
||||||
* @param {ol.CoordinateArray} coordinates Coordinates array.
|
* @param {ol.CoordinateArray} coordinates Coordinates array.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom.MultiPoint = function(coordinates) {
|
ol.geom.MultiPoint = function(coordinates) {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ goog.require('ol.geom.Polygon');
|
|||||||
* @extends {ol.geom.AbstractCollection}
|
* @extends {ol.geom.AbstractCollection}
|
||||||
* @param {Array.<Array.<ol.CoordinateArray>>} coordinates Coordinates
|
* @param {Array.<Array.<ol.CoordinateArray>>} coordinates Coordinates
|
||||||
* array.
|
* array.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom.MultiPolygon = function(coordinates) {
|
ol.geom.MultiPolygon = function(coordinates) {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ goog.require('ol.geom.GeometryType');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.geom.Geometry}
|
* @extends {ol.geom.Geometry}
|
||||||
* @param {ol.Coordinate} coordinates Coordinate values (e.g. [x, y]).
|
* @param {ol.Coordinate} coordinates Coordinate values (e.g. [x, y]).
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom.Point = function(coordinates) {
|
ol.geom.Point = function(coordinates) {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ goog.require('ol.geom.LinearRing');
|
|||||||
* @extends {ol.geom.Geometry}
|
* @extends {ol.geom.Geometry}
|
||||||
* @param {Array.<ol.CoordinateArray>} coordinates Array of rings. First
|
* @param {Array.<ol.CoordinateArray>} coordinates Array of rings. First
|
||||||
* is outer, any remaining are inner.
|
* is outer, any remaining are inner.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom.Polygon = function(coordinates) {
|
ol.geom.Polygon = function(coordinates) {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
@@ -75,6 +76,7 @@ ol.geom.Polygon.prototype.getBounds = function() {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {Array.<ol.CoordinateArray>} Coordinates array.
|
* @return {Array.<ol.CoordinateArray>} Coordinates array.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom.Polygon.prototype.getCoordinates = function() {
|
ol.geom.Polygon.prototype.getCoordinates = function() {
|
||||||
var count = this.rings_.length;
|
var count = this.rings_.length;
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ ol.geom2.LineString;
|
|||||||
* @param {ol.structs.Buffer} buf Buffer.
|
* @param {ol.structs.Buffer} buf Buffer.
|
||||||
* @param {Object.<string, number>=} opt_ranges Ranges.
|
* @param {Object.<string, number>=} opt_ranges Ranges.
|
||||||
* @param {number=} opt_dim Dimension.
|
* @param {number=} opt_dim Dimension.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom2.LineStringCollection = function(buf, opt_ranges, opt_dim) {
|
ol.geom2.LineStringCollection = function(buf, opt_ranges, opt_dim) {
|
||||||
|
|
||||||
@@ -61,6 +62,7 @@ ol.geom2.LineStringCollection.createEmpty = function(capacity, opt_dim) {
|
|||||||
* @param {number=} opt_capacity Capacity.
|
* @param {number=} opt_capacity Capacity.
|
||||||
* @param {number=} opt_dim Dimension.
|
* @param {number=} opt_dim Dimension.
|
||||||
* @return {ol.geom2.LineStringCollection} Line string collection.
|
* @return {ol.geom2.LineStringCollection} Line string collection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom2.LineStringCollection.pack =
|
ol.geom2.LineStringCollection.pack =
|
||||||
function(unpackedLineStrings, opt_capacity, opt_dim) {
|
function(unpackedLineStrings, opt_capacity, opt_dim) {
|
||||||
|
|||||||
@@ -19,6 +19,7 @@ ol.geom2.Point;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @param {ol.structs.Buffer} buf Buffer.
|
* @param {ol.structs.Buffer} buf Buffer.
|
||||||
* @param {number=} opt_dim Dimension.
|
* @param {number=} opt_dim Dimension.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom2.PointCollection = function(buf, opt_dim) {
|
ol.geom2.PointCollection = function(buf, opt_dim) {
|
||||||
|
|
||||||
@@ -40,6 +41,7 @@ ol.geom2.PointCollection = function(buf, opt_dim) {
|
|||||||
* @param {number} capacity Capacity.
|
* @param {number} capacity Capacity.
|
||||||
* @param {number=} opt_dim Dimension.
|
* @param {number=} opt_dim Dimension.
|
||||||
* @return {ol.geom2.PointCollection} Point collection.
|
* @return {ol.geom2.PointCollection} Point collection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom2.PointCollection.createEmpty = function(capacity, opt_dim) {
|
ol.geom2.PointCollection.createEmpty = function(capacity, opt_dim) {
|
||||||
var dim = goog.isDef(opt_dim) ? opt_dim : 2;
|
var dim = goog.isDef(opt_dim) ? opt_dim : 2;
|
||||||
@@ -54,6 +56,7 @@ ol.geom2.PointCollection.createEmpty = function(capacity, opt_dim) {
|
|||||||
* @param {number=} opt_capacity Capacity.
|
* @param {number=} opt_capacity Capacity.
|
||||||
* @param {number=} opt_dim Dimension.
|
* @param {number=} opt_dim Dimension.
|
||||||
* @return {ol.geom2.PointCollection} Point collection.
|
* @return {ol.geom2.PointCollection} Point collection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom2.PointCollection.pack =
|
ol.geom2.PointCollection.pack =
|
||||||
function(unpackedPoints, opt_capacity, opt_dim) {
|
function(unpackedPoints, opt_capacity, opt_dim) {
|
||||||
@@ -72,6 +75,7 @@ ol.geom2.PointCollection.pack =
|
|||||||
/**
|
/**
|
||||||
* @param {ol.geom2.Point} point Point.
|
* @param {ol.geom2.Point} point Point.
|
||||||
* @return {number} Offset.
|
* @return {number} Offset.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.geom2.PointCollection.prototype.add = function(point) {
|
ol.geom2.PointCollection.prototype.add = function(point) {
|
||||||
goog.asserts.assert(point.length == this.dim);
|
goog.asserts.assert(point.length == this.dim);
|
||||||
|
|||||||
@@ -20,6 +20,7 @@ goog.require('ol.TileState');
|
|||||||
* @param {string} src Image source URI.
|
* @param {string} src Image source URI.
|
||||||
* @param {?string} crossOrigin Cross origin.
|
* @param {?string} crossOrigin Cross origin.
|
||||||
* @param {ol.TileLoadFunctionType} tileLoadFunction Tile load function.
|
* @param {ol.TileLoadFunctionType} tileLoadFunction Tile load function.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.ImageTile =
|
ol.ImageTile =
|
||||||
function(tileCoord, state, src, crossOrigin, tileLoadFunction) {
|
function(tileCoord, state, src, crossOrigin, tileLoadFunction) {
|
||||||
@@ -67,6 +68,7 @@ goog.inherits(ol.ImageTile, ol.Tile);
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* @inheritDoc
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.ImageTile.prototype.getImage = function(opt_context) {
|
ol.ImageTile.prototype.getImage = function(opt_context) {
|
||||||
if (goog.isDef(opt_context)) {
|
if (goog.isDef(opt_context)) {
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ ol.interaction.ConditionType;
|
|||||||
/**
|
/**
|
||||||
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
||||||
* @return {boolean} True if only the alt key is pressed.
|
* @return {boolean} True if only the alt key is pressed.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.condition.altKeyOnly = function(mapBrowserEvent) {
|
ol.interaction.condition.altKeyOnly = function(mapBrowserEvent) {
|
||||||
var browserEvent = mapBrowserEvent.browserEvent;
|
var browserEvent = mapBrowserEvent.browserEvent;
|
||||||
@@ -28,6 +29,7 @@ ol.interaction.condition.altKeyOnly = function(mapBrowserEvent) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
||||||
* @return {boolean} True if only the alt and shift keys are pressed.
|
* @return {boolean} True if only the alt and shift keys are pressed.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.condition.altShiftKeysOnly = function(mapBrowserEvent) {
|
ol.interaction.condition.altShiftKeysOnly = function(mapBrowserEvent) {
|
||||||
var browserEvent = mapBrowserEvent.browserEvent;
|
var browserEvent = mapBrowserEvent.browserEvent;
|
||||||
@@ -42,6 +44,7 @@ ol.interaction.condition.altShiftKeysOnly = function(mapBrowserEvent) {
|
|||||||
* Always true.
|
* Always true.
|
||||||
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
||||||
* @return {boolean} True.
|
* @return {boolean} True.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.condition.always = goog.functions.TRUE;
|
ol.interaction.condition.always = goog.functions.TRUE;
|
||||||
|
|
||||||
@@ -49,6 +52,7 @@ ol.interaction.condition.always = goog.functions.TRUE;
|
|||||||
/**
|
/**
|
||||||
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
||||||
* @return {boolean} True if the event is a click event.
|
* @return {boolean} True if the event is a click event.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.condition.clickOnly = function(mapBrowserEvent) {
|
ol.interaction.condition.clickOnly = function(mapBrowserEvent) {
|
||||||
var browserEvent = mapBrowserEvent.browserEvent;
|
var browserEvent = mapBrowserEvent.browserEvent;
|
||||||
@@ -59,6 +63,7 @@ ol.interaction.condition.clickOnly = function(mapBrowserEvent) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
||||||
* @return {boolean} True only if there no modifier keys are pressed.
|
* @return {boolean} True only if there no modifier keys are pressed.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.condition.noModifierKeys = function(mapBrowserEvent) {
|
ol.interaction.condition.noModifierKeys = function(mapBrowserEvent) {
|
||||||
var browserEvent = mapBrowserEvent.browserEvent;
|
var browserEvent = mapBrowserEvent.browserEvent;
|
||||||
@@ -72,6 +77,7 @@ ol.interaction.condition.noModifierKeys = function(mapBrowserEvent) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
||||||
* @return {boolean} True if only the platform modifier key is pressed.
|
* @return {boolean} True if only the platform modifier key is pressed.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
|
ol.interaction.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
|
||||||
var browserEvent = mapBrowserEvent.browserEvent;
|
var browserEvent = mapBrowserEvent.browserEvent;
|
||||||
@@ -85,6 +91,7 @@ ol.interaction.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
||||||
* @return {boolean} True if only the shift key is pressed.
|
* @return {boolean} True if only the shift key is pressed.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.condition.shiftKeyOnly = function(mapBrowserEvent) {
|
ol.interaction.condition.shiftKeyOnly = function(mapBrowserEvent) {
|
||||||
var browserEvent = mapBrowserEvent.browserEvent;
|
var browserEvent = mapBrowserEvent.browserEvent;
|
||||||
@@ -98,6 +105,7 @@ ol.interaction.condition.shiftKeyOnly = function(mapBrowserEvent) {
|
|||||||
/**
|
/**
|
||||||
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
|
||||||
* @return {boolean} True only if the target element is not editable.
|
* @return {boolean} True only if the target element is not editable.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.condition.targetNotEditable = function(mapBrowserEvent) {
|
ol.interaction.condition.targetNotEditable = function(mapBrowserEvent) {
|
||||||
var browserEvent = mapBrowserEvent.browserEvent;
|
var browserEvent = mapBrowserEvent.browserEvent;
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ goog.require('ol.interaction.Interaction');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.interaction.Interaction}
|
* @extends {ol.interaction.Interaction}
|
||||||
* @param {ol.interaction.DoubleClickZoomOptions=} opt_options Options.
|
* @param {ol.interaction.DoubleClickZoomOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.DoubleClickZoom = function(opt_options) {
|
ol.interaction.DoubleClickZoom = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ goog.require('ol.interaction.condition');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.interaction.Drag}
|
* @extends {ol.interaction.Drag}
|
||||||
* @param {ol.interaction.DragPanOptions=} opt_options Options.
|
* @param {ol.interaction.DragPanOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.DragPan = function(opt_options) {
|
ol.interaction.DragPan = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -26,6 +26,7 @@ ol.interaction.DRAGROTATEANDZOOM_ANIMATION_DURATION = 400;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.interaction.Drag}
|
* @extends {ol.interaction.Drag}
|
||||||
* @param {ol.interaction.DragRotateAndZoomOptions=} opt_options Options.
|
* @param {ol.interaction.DragRotateAndZoomOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.DragRotateAndZoom = function(opt_options) {
|
ol.interaction.DragRotateAndZoom = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -35,6 +35,7 @@ ol.SHIFT_DRAG_ZOOM_HYSTERESIS_PIXELS_SQUARED =
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.interaction.Drag}
|
* @extends {ol.interaction.Drag}
|
||||||
* @param {ol.interaction.DragZoomOptions=} opt_options Options.
|
* @param {ol.interaction.DragZoomOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.DragZoom = function(opt_options) {
|
ol.interaction.DragZoom = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -26,6 +26,7 @@ goog.require('ol.interaction.TouchZoom');
|
|||||||
* @param {ol.interaction.DefaultsOptions=} opt_options Defaults options.
|
* @param {ol.interaction.DefaultsOptions=} opt_options Defaults options.
|
||||||
* @return {ol.Collection} A collection of interactions to be used with
|
* @return {ol.Collection} A collection of interactions to be used with
|
||||||
* the ol.Map constructor's interactions option.
|
* the ol.Map constructor's interactions option.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.defaults = function(opt_options) {
|
ol.interaction.defaults = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -25,6 +25,7 @@ ol.interaction.KEYBOARD_PAN_DURATION = 100;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.interaction.Interaction}
|
* @extends {ol.interaction.Interaction}
|
||||||
* @param {ol.interaction.KeyboardPanOptions=} opt_options Options.
|
* @param {ol.interaction.KeyboardPanOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.KeyboardPan = function(opt_options) {
|
ol.interaction.KeyboardPan = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ goog.require('ol.interaction.condition');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @param {ol.interaction.KeyboardZoomOptions=} opt_options Options.
|
* @param {ol.interaction.KeyboardZoomOptions=} opt_options Options.
|
||||||
* @extends {ol.interaction.Interaction}
|
* @extends {ol.interaction.Interaction}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.KeyboardZoom = function(opt_options) {
|
ol.interaction.KeyboardZoom = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -28,6 +28,7 @@ ol.interaction.MOUSEWHEELZOOM_TIMEOUT_DURATION = 80;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.interaction.Interaction}
|
* @extends {ol.interaction.Interaction}
|
||||||
* @param {ol.interaction.MouseWheelZoomOptions=} opt_options Options.
|
* @param {ol.interaction.MouseWheelZoomOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.MouseWheelZoom = function(opt_options) {
|
ol.interaction.MouseWheelZoom = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ goog.require('ol.source.Vector');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.interaction.Interaction}
|
* @extends {ol.interaction.Interaction}
|
||||||
* @param {ol.interaction.SelectOptions=} opt_options Options.
|
* @param {ol.interaction.SelectOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.Select = function(opt_options) {
|
ol.interaction.Select = function(opt_options) {
|
||||||
var options = goog.isDef(opt_options) ? opt_options : {};
|
var options = goog.isDef(opt_options) ? opt_options : {};
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ goog.require('ol.interaction.Touch');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.interaction.Touch}
|
* @extends {ol.interaction.Touch}
|
||||||
* @param {ol.interaction.TouchPanOptions=} opt_options Options.
|
* @param {ol.interaction.TouchPanOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.TouchPan = function(opt_options) {
|
ol.interaction.TouchPan = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -22,6 +22,7 @@ ol.interaction.TOUCHROTATE_ANIMATION_DURATION = 250;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.interaction.Touch}
|
* @extends {ol.interaction.Touch}
|
||||||
* @param {ol.interaction.TouchRotateOptions=} opt_options Options.
|
* @param {ol.interaction.TouchRotateOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.TouchRotate = function(opt_options) {
|
ol.interaction.TouchRotate = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ goog.require('ol.interaction.Touch');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.interaction.Touch}
|
* @extends {ol.interaction.Touch}
|
||||||
* @param {ol.interaction.TouchZoomOptions=} opt_options Options.
|
* @param {ol.interaction.TouchZoomOptions=} opt_options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.interaction.TouchZoom = function(opt_options) {
|
ol.interaction.TouchZoom = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ ol.IView2D = function() {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {ol.Coordinate|undefined} Map center.
|
* @return {ol.Coordinate|undefined} Map center.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.IView2D.prototype.getCenter = function() {
|
ol.IView2D.prototype.getCenter = function() {
|
||||||
};
|
};
|
||||||
@@ -31,6 +32,7 @@ ol.IView2D.prototype.getCenter = function() {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {ol.proj.Projection|undefined} Map projection.
|
* @return {ol.proj.Projection|undefined} Map projection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.IView2D.prototype.getProjection = function() {
|
ol.IView2D.prototype.getProjection = function() {
|
||||||
};
|
};
|
||||||
@@ -38,6 +40,7 @@ ol.IView2D.prototype.getProjection = function() {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {number|undefined} Map resolution.
|
* @return {number|undefined} Map resolution.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.IView2D.prototype.getResolution = function() {
|
ol.IView2D.prototype.getResolution = function() {
|
||||||
};
|
};
|
||||||
@@ -45,6 +48,7 @@ ol.IView2D.prototype.getResolution = function() {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {number|undefined} Map rotation.
|
* @return {number|undefined} Map rotation.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.IView2D.prototype.getRotation = function() {
|
ol.IView2D.prototype.getRotation = function() {
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ goog.require('ol.animation');
|
|||||||
* @param {number} minVelocity Minimum velocity (pixels/millisecond).
|
* @param {number} minVelocity Minimum velocity (pixels/millisecond).
|
||||||
* @param {number} delay Delay to consider to calculate the kinetic
|
* @param {number} delay Delay to consider to calculate the kinetic
|
||||||
* initial values (milliseconds).
|
* initial values (milliseconds).
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Kinetic = function(decay, minVelocity, delay) {
|
ol.Kinetic = function(decay, minVelocity, delay) {
|
||||||
|
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ goog.require('ol.source.Image');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.layer.Layer}
|
* @extends {ol.layer.Layer}
|
||||||
* @param {ol.layer.LayerOptions} options Layer options.
|
* @param {ol.layer.LayerOptions} options Layer options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.layer.Image = function(options) {
|
ol.layer.Image = function(options) {
|
||||||
goog.base(this, options);
|
goog.base(this, options);
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ goog.require('ol.source.Source');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.layer.Base}
|
* @extends {ol.layer.Base}
|
||||||
* @param {ol.layer.LayerOptions} options Layer options.
|
* @param {ol.layer.LayerOptions} options Layer options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.layer.Layer = function(options) {
|
ol.layer.Layer = function(options) {
|
||||||
|
|
||||||
@@ -62,6 +63,7 @@ ol.layer.Layer.prototype.getLayerStatesArray = function(opt_obj) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {ol.source.Source} Source.
|
* @return {ol.source.Source} Source.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.layer.Layer.prototype.getSource = function() {
|
ol.layer.Layer.prototype.getSource = function() {
|
||||||
return this.source_;
|
return this.source_;
|
||||||
|
|||||||
@@ -27,6 +27,7 @@ ol.layer.GroupProperty = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.layer.Base}
|
* @extends {ol.layer.Base}
|
||||||
* @param {ol.layer.GroupOptions=} opt_options Layer options.
|
* @param {ol.layer.GroupOptions=} opt_options Layer options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.layer.Group = function(opt_options) {
|
ol.layer.Group = function(opt_options) {
|
||||||
|
|
||||||
@@ -146,6 +147,7 @@ ol.layer.Group.prototype.handleLayersRemove_ = function(collectionEvent) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {ol.Collection} Collection of layers.
|
* @return {ol.Collection} Collection of layers.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.layer.Group.prototype.getLayers = function() {
|
ol.layer.Group.prototype.getLayers = function() {
|
||||||
return /** @type {ol.Collection} */ (this.get(
|
return /** @type {ol.Collection} */ (this.get(
|
||||||
@@ -159,6 +161,7 @@ goog.exportProperty(
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {ol.Collection} layers Collection of layers.
|
* @param {ol.Collection} layers Collection of layers.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.layer.Group.prototype.setLayers = function(layers) {
|
ol.layer.Group.prototype.setLayers = function(layers) {
|
||||||
this.set(ol.layer.GroupProperty.LAYERS, layers);
|
this.set(ol.layer.GroupProperty.LAYERS, layers);
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ ol.layer.TileProperty = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.layer.Layer}
|
* @extends {ol.layer.Layer}
|
||||||
* @param {ol.layer.TileOptions} options Tile layer options.
|
* @param {ol.layer.TileOptions} options Tile layer options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.layer.Tile = function(options) {
|
ol.layer.Tile = function(options) {
|
||||||
|
|
||||||
@@ -31,6 +32,7 @@ goog.inherits(ol.layer.Tile, ol.layer.Layer);
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {number} Preload.
|
* @return {number} Preload.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.layer.Tile.prototype.getPreload = function() {
|
ol.layer.Tile.prototype.getPreload = function() {
|
||||||
return /** @type {number} */ (this.get(ol.layer.TileProperty.PRELOAD));
|
return /** @type {number} */ (this.get(ol.layer.TileProperty.PRELOAD));
|
||||||
@@ -51,6 +53,7 @@ ol.layer.Tile.prototype.getTileSource = function() {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {number} preload Preload.
|
* @param {number} preload Preload.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.layer.Tile.prototype.setPreload = function(preload) {
|
ol.layer.Tile.prototype.setPreload = function(preload) {
|
||||||
this.set(ol.layer.TileProperty.PRELOAD, preload);
|
this.set(ol.layer.TileProperty.PRELOAD, preload);
|
||||||
|
|||||||
@@ -137,6 +137,7 @@ ol.layer.FeatureCache.prototype.remove = function(feature, opt_extent) {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.layer.Layer}
|
* @extends {ol.layer.Layer}
|
||||||
* @param {ol.layer.VectorLayerOptions} options Vector layer options.
|
* @param {ol.layer.VectorLayerOptions} options Vector layer options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.layer.Vector = function(options) {
|
ol.layer.Vector = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ goog.require('ol.source.Vector2');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.layer.Layer}
|
* @extends {ol.layer.Layer}
|
||||||
* @param {ol.layer.LayerOptions} options Options.
|
* @param {ol.layer.LayerOptions} options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.layer.Vector2 = function(options) {
|
ol.layer.Vector2 = function(options) {
|
||||||
goog.base(this, options);
|
goog.base(this, options);
|
||||||
|
|||||||
@@ -87,6 +87,7 @@ ol.ENABLE_WEBGL = true;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @enum {string}
|
* @enum {string}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.RendererHint = {
|
ol.RendererHint = {
|
||||||
CANVAS: 'canvas',
|
CANVAS: 'canvas',
|
||||||
@@ -141,6 +142,7 @@ ol.MapProperty = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.Object}
|
* @extends {ol.Object}
|
||||||
* @param {ol.MapOptions} options Map options.
|
* @param {ol.MapOptions} options Map options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map = function(options) {
|
ol.Map = function(options) {
|
||||||
|
|
||||||
@@ -361,6 +363,7 @@ goog.inherits(ol.Map, ol.Object);
|
|||||||
/**
|
/**
|
||||||
* Add the given control to the map.
|
* Add the given control to the map.
|
||||||
* @param {ol.control.Control} control Control.
|
* @param {ol.control.Control} control Control.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.addControl = function(control) {
|
ol.Map.prototype.addControl = function(control) {
|
||||||
var controls = this.getControls();
|
var controls = this.getControls();
|
||||||
@@ -373,6 +376,7 @@ ol.Map.prototype.addControl = function(control) {
|
|||||||
/**
|
/**
|
||||||
* Adds the given layer to the top of this map.
|
* Adds the given layer to the top of this map.
|
||||||
* @param {ol.layer.Base} layer Layer.
|
* @param {ol.layer.Base} layer Layer.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.addLayer = function(layer) {
|
ol.Map.prototype.addLayer = function(layer) {
|
||||||
var layers = this.getLayerGroup().getLayers();
|
var layers = this.getLayerGroup().getLayers();
|
||||||
@@ -384,6 +388,7 @@ ol.Map.prototype.addLayer = function(layer) {
|
|||||||
/**
|
/**
|
||||||
* Add the given overlay to the map.
|
* Add the given overlay to the map.
|
||||||
* @param {ol.Overlay} overlay Overlay.
|
* @param {ol.Overlay} overlay Overlay.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.addOverlay = function(overlay) {
|
ol.Map.prototype.addOverlay = function(overlay) {
|
||||||
var overlays = this.getOverlays();
|
var overlays = this.getOverlays();
|
||||||
@@ -398,6 +403,7 @@ ol.Map.prototype.addOverlay = function(overlay) {
|
|||||||
* animations before updating the map's view. The {@link ol.animation}
|
* animations before updating the map's view. The {@link ol.animation}
|
||||||
* namespace provides several static methods for creating prerender functions.
|
* namespace provides several static methods for creating prerender functions.
|
||||||
* @param {...ol.PreRenderFunction} var_args Any number of pre-render functions.
|
* @param {...ol.PreRenderFunction} var_args Any number of pre-render functions.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.beforeRender = function(var_args) {
|
ol.Map.prototype.beforeRender = function(var_args) {
|
||||||
this.requestRenderFrame();
|
this.requestRenderFrame();
|
||||||
@@ -436,6 +442,7 @@ ol.Map.prototype.freezeRendering = function() {
|
|||||||
* Returns the map pixel position for a a browser event.
|
* Returns the map pixel position for a a browser event.
|
||||||
* @param {Event} event Event.
|
* @param {Event} event Event.
|
||||||
* @return {ol.Coordinate} Coordinate.
|
* @return {ol.Coordinate} Coordinate.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getEventCoordinate = function(event) {
|
ol.Map.prototype.getEventCoordinate = function(event) {
|
||||||
return this.getCoordinateFromPixel(this.getEventPixel(event));
|
return this.getCoordinateFromPixel(this.getEventPixel(event));
|
||||||
@@ -446,6 +453,7 @@ ol.Map.prototype.getEventCoordinate = function(event) {
|
|||||||
* Returns the geographical coordinate for a browser event.
|
* Returns the geographical coordinate for a browser event.
|
||||||
* @param {Event} event Event.
|
* @param {Event} event Event.
|
||||||
* @return {ol.Pixel} Pixel.
|
* @return {ol.Pixel} Pixel.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getEventPixel = function(event) {
|
ol.Map.prototype.getEventPixel = function(event) {
|
||||||
// goog.style.getRelativePosition is based on event.targetTouches,
|
// goog.style.getRelativePosition is based on event.targetTouches,
|
||||||
@@ -470,6 +478,7 @@ ol.Map.prototype.getEventPixel = function(event) {
|
|||||||
/**
|
/**
|
||||||
* Get the map's renderer.
|
* Get the map's renderer.
|
||||||
* @return {ol.renderer.Map} Renderer.
|
* @return {ol.renderer.Map} Renderer.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getRenderer = function() {
|
ol.Map.prototype.getRenderer = function() {
|
||||||
return this.renderer_;
|
return this.renderer_;
|
||||||
@@ -479,6 +488,7 @@ ol.Map.prototype.getRenderer = function() {
|
|||||||
/**
|
/**
|
||||||
* Get the element in which this map is rendered.
|
* Get the element in which this map is rendered.
|
||||||
* @return {Element|string|undefined} Target.
|
* @return {Element|string|undefined} Target.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getTarget = function() {
|
ol.Map.prototype.getTarget = function() {
|
||||||
return /** @type {Element|string|undefined} */ (
|
return /** @type {Element|string|undefined} */ (
|
||||||
@@ -507,6 +517,7 @@ ol.Map.prototype.getCoordinateFromPixel = function(pixel) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {ol.Collection} Controls.
|
* @return {ol.Collection} Controls.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getControls = function() {
|
ol.Map.prototype.getControls = function() {
|
||||||
return this.controls_;
|
return this.controls_;
|
||||||
@@ -515,6 +526,7 @@ ol.Map.prototype.getControls = function() {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {ol.Collection} Overlays.
|
* @return {ol.Collection} Overlays.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getOverlays = function() {
|
ol.Map.prototype.getOverlays = function() {
|
||||||
return this.overlays_;
|
return this.overlays_;
|
||||||
@@ -525,6 +537,7 @@ ol.Map.prototype.getOverlays = function() {
|
|||||||
* Get feature information for a pixel on the map.
|
* Get feature information for a pixel on the map.
|
||||||
*
|
*
|
||||||
* @param {ol.GetFeatureInfoOptions} options Options.
|
* @param {ol.GetFeatureInfoOptions} options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getFeatureInfo = function(options) {
|
ol.Map.prototype.getFeatureInfo = function(options) {
|
||||||
var layers = goog.isDefAndNotNull(options.layers) ?
|
var layers = goog.isDefAndNotNull(options.layers) ?
|
||||||
@@ -538,6 +551,7 @@ ol.Map.prototype.getFeatureInfo = function(options) {
|
|||||||
* Get features for a pixel on the map.
|
* Get features for a pixel on the map.
|
||||||
*
|
*
|
||||||
* @param {ol.GetFeaturesOptions} options Options.
|
* @param {ol.GetFeaturesOptions} options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getFeatures = function(options) {
|
ol.Map.prototype.getFeatures = function(options) {
|
||||||
var layers = goog.isDefAndNotNull(options.layers) ?
|
var layers = goog.isDefAndNotNull(options.layers) ?
|
||||||
@@ -555,6 +569,7 @@ ol.Map.prototype.getFeatures = function(options) {
|
|||||||
*
|
*
|
||||||
* Interactions are used for e.g. pan, zoom and rotate.
|
* Interactions are used for e.g. pan, zoom and rotate.
|
||||||
* @return {ol.Collection} Interactions.
|
* @return {ol.Collection} Interactions.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getInteractions = function() {
|
ol.Map.prototype.getInteractions = function() {
|
||||||
return this.interactions_;
|
return this.interactions_;
|
||||||
@@ -564,6 +579,7 @@ ol.Map.prototype.getInteractions = function() {
|
|||||||
/**
|
/**
|
||||||
* Get the layergroup associated with this map.
|
* Get the layergroup associated with this map.
|
||||||
* @return {ol.layer.Group} LayerGroup.
|
* @return {ol.layer.Group} LayerGroup.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getLayerGroup = function() {
|
ol.Map.prototype.getLayerGroup = function() {
|
||||||
return /** @type {ol.layer.Group} */ (
|
return /** @type {ol.layer.Group} */ (
|
||||||
@@ -578,6 +594,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Get the collection of layers associated with this map.
|
* Get the collection of layers associated with this map.
|
||||||
* @return {ol.Collection} Layers.
|
* @return {ol.Collection} Layers.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getLayers = function() {
|
ol.Map.prototype.getLayers = function() {
|
||||||
return this.getLayerGroup().getLayers();
|
return this.getLayerGroup().getLayers();
|
||||||
@@ -602,6 +619,7 @@ ol.Map.prototype.getPixelFromCoordinate = function(coordinate) {
|
|||||||
/**
|
/**
|
||||||
* Get the size of this map.
|
* Get the size of this map.
|
||||||
* @return {ol.Size|undefined} Size.
|
* @return {ol.Size|undefined} Size.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getSize = function() {
|
ol.Map.prototype.getSize = function() {
|
||||||
return /** @type {ol.Size|undefined} */ (this.get(ol.MapProperty.SIZE));
|
return /** @type {ol.Size|undefined} */ (this.get(ol.MapProperty.SIZE));
|
||||||
@@ -616,6 +634,7 @@ goog.exportProperty(
|
|||||||
* Get the view associated with this map. This can be a 2D or 3D view. A 2D
|
* Get the view associated with this map. This can be a 2D or 3D view. A 2D
|
||||||
* view manages properties such as center and resolution.
|
* view manages properties such as center and resolution.
|
||||||
* @return {ol.View} View.
|
* @return {ol.View} View.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getView = function() {
|
ol.Map.prototype.getView = function() {
|
||||||
return /** @type {ol.View} */ (this.get(ol.MapProperty.VIEW));
|
return /** @type {ol.View} */ (this.get(ol.MapProperty.VIEW));
|
||||||
@@ -628,6 +647,7 @@ goog.exportProperty(
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {Element} Viewport.
|
* @return {Element} Viewport.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.getViewport = function() {
|
ol.Map.prototype.getViewport = function() {
|
||||||
return this.viewport_;
|
return this.viewport_;
|
||||||
@@ -918,6 +938,7 @@ ol.Map.prototype.requestRenderFrame = function() {
|
|||||||
* @param {ol.control.Control} control Control.
|
* @param {ol.control.Control} control Control.
|
||||||
* @return {ol.control.Control|undefined} The removed control of undefined
|
* @return {ol.control.Control|undefined} The removed control of undefined
|
||||||
* if the control was not found.
|
* if the control was not found.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.removeControl = function(control) {
|
ol.Map.prototype.removeControl = function(control) {
|
||||||
var controls = this.getControls();
|
var controls = this.getControls();
|
||||||
@@ -935,6 +956,7 @@ ol.Map.prototype.removeControl = function(control) {
|
|||||||
* @param {ol.layer.Base} layer Layer.
|
* @param {ol.layer.Base} layer Layer.
|
||||||
* @return {ol.layer.Base|undefined} The removed layer or undefined if the
|
* @return {ol.layer.Base|undefined} The removed layer or undefined if the
|
||||||
* layer was not found.
|
* layer was not found.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.removeLayer = function(layer) {
|
ol.Map.prototype.removeLayer = function(layer) {
|
||||||
var layers = this.getLayerGroup().getLayers();
|
var layers = this.getLayerGroup().getLayers();
|
||||||
@@ -948,6 +970,7 @@ ol.Map.prototype.removeLayer = function(layer) {
|
|||||||
* @param {ol.Overlay} overlay Overlay.
|
* @param {ol.Overlay} overlay Overlay.
|
||||||
* @return {ol.Overlay|undefined} The removed overlay of undefined
|
* @return {ol.Overlay|undefined} The removed overlay of undefined
|
||||||
* if the overlay was not found.
|
* if the overlay was not found.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.removeOverlay = function(overlay) {
|
ol.Map.prototype.removeOverlay = function(overlay) {
|
||||||
var overlays = this.getOverlays();
|
var overlays = this.getOverlays();
|
||||||
@@ -1059,6 +1082,7 @@ ol.Map.prototype.renderFrame_ = function(time) {
|
|||||||
/**
|
/**
|
||||||
* Sets the layergroup of this map.
|
* Sets the layergroup of this map.
|
||||||
* @param {ol.layer.Group} layerGroup Layergroup.
|
* @param {ol.layer.Group} layerGroup Layergroup.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.setLayerGroup = function(layerGroup) {
|
ol.Map.prototype.setLayerGroup = function(layerGroup) {
|
||||||
this.set(ol.MapProperty.LAYERGROUP, layerGroup);
|
this.set(ol.MapProperty.LAYERGROUP, layerGroup);
|
||||||
@@ -1072,6 +1096,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Set the size of this map.
|
* Set the size of this map.
|
||||||
* @param {ol.Size|undefined} size Size.
|
* @param {ol.Size|undefined} size Size.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.setSize = function(size) {
|
ol.Map.prototype.setSize = function(size) {
|
||||||
this.set(ol.MapProperty.SIZE, size);
|
this.set(ol.MapProperty.SIZE, size);
|
||||||
@@ -1085,6 +1110,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Set the target element to render this map into.
|
* Set the target element to render this map into.
|
||||||
* @param {Element|string|undefined} target Target.
|
* @param {Element|string|undefined} target Target.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.setTarget = function(target) {
|
ol.Map.prototype.setTarget = function(target) {
|
||||||
this.set(ol.MapProperty.TARGET, target);
|
this.set(ol.MapProperty.TARGET, target);
|
||||||
@@ -1098,6 +1124,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Set the view for this map.
|
* Set the view for this map.
|
||||||
* @param {ol.IView} view View.
|
* @param {ol.IView} view View.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.setView = function(view) {
|
ol.Map.prototype.setView = function(view) {
|
||||||
this.set(ol.MapProperty.VIEW, view);
|
this.set(ol.MapProperty.VIEW, view);
|
||||||
@@ -1122,6 +1149,7 @@ ol.Map.prototype.unfreezeRendering = function() {
|
|||||||
/**
|
/**
|
||||||
* Force a recalculation of the map viewport size. This should be called when
|
* Force a recalculation of the map viewport size. This should be called when
|
||||||
* third-party code changes the size of the map viewport.
|
* third-party code changes the size of the map viewport.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Map.prototype.updateSize = function() {
|
ol.Map.prototype.updateSize = function() {
|
||||||
var target = this.getTarget();
|
var target = this.getTarget();
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ goog.require('ol.Pixel');
|
|||||||
* @param {ol.Map} map Map.
|
* @param {ol.Map} map Map.
|
||||||
* @param {goog.events.BrowserEvent} browserEvent Browser event.
|
* @param {goog.events.BrowserEvent} browserEvent Browser event.
|
||||||
* @param {?ol.FrameState=} opt_frameState Frame state.
|
* @param {?ol.FrameState=} opt_frameState Frame state.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
|
ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
|
||||||
|
|
||||||
@@ -51,6 +52,7 @@ goog.inherits(ol.MapBrowserEvent, ol.MapEvent);
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @return {ol.Coordinate} Coordinate.
|
* @return {ol.Coordinate} Coordinate.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.MapBrowserEvent.prototype.getCoordinate = function() {
|
ol.MapBrowserEvent.prototype.getCoordinate = function() {
|
||||||
if (goog.isNull(this.coordinate_)) {
|
if (goog.isNull(this.coordinate_)) {
|
||||||
@@ -64,6 +66,7 @@ ol.MapBrowserEvent.prototype.getCoordinate = function() {
|
|||||||
/**
|
/**
|
||||||
* Get pixel offset of the event from the top-left corner of the map viewport.
|
* Get pixel offset of the event from the top-left corner of the map viewport.
|
||||||
* @return {ol.Pixel} Pixel offset.
|
* @return {ol.Pixel} Pixel offset.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.MapBrowserEvent.prototype.getPixel = function() {
|
ol.MapBrowserEvent.prototype.getPixel = function() {
|
||||||
if (goog.isNull(this.pixel_)) {
|
if (goog.isNull(this.pixel_)) {
|
||||||
@@ -87,6 +90,7 @@ ol.MapBrowserEvent.prototype.isMouseActionButton = function() {
|
|||||||
* Prevents the default browser action.
|
* Prevents the default browser action.
|
||||||
* @see https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault
|
* @see https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault
|
||||||
* @override
|
* @override
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.MapBrowserEvent.prototype.preventDefault = function() {
|
ol.MapBrowserEvent.prototype.preventDefault = function() {
|
||||||
goog.base(this, 'preventDefault');
|
goog.base(this, 'preventDefault');
|
||||||
@@ -98,6 +102,7 @@ ol.MapBrowserEvent.prototype.preventDefault = function() {
|
|||||||
* Prevents further propagation of the current event.
|
* Prevents further propagation of the current event.
|
||||||
* @see https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation
|
* @see https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation
|
||||||
* @override
|
* @override
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.MapBrowserEvent.prototype.stopPropagation = function() {
|
ol.MapBrowserEvent.prototype.stopPropagation = function() {
|
||||||
goog.base(this, 'stopPropagation');
|
goog.base(this, 'stopPropagation');
|
||||||
|
|||||||
@@ -37,6 +37,7 @@ ol.ObjectProperty = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {goog.events.EventTarget}
|
* @extends {goog.events.EventTarget}
|
||||||
* @param {Object.<string, *>=} opt_values Values.
|
* @param {Object.<string, *>=} opt_values Values.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Object = function(opt_values) {
|
ol.Object = function(opt_values) {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
@@ -142,6 +143,7 @@ ol.Object.getSetterName = function(key) {
|
|||||||
* @param {string} key Key.
|
* @param {string} key Key.
|
||||||
* @param {ol.Object} target Target.
|
* @param {ol.Object} target Target.
|
||||||
* @param {string=} opt_targetKey Target key.
|
* @param {string=} opt_targetKey Target key.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Object.prototype.bindTo =
|
ol.Object.prototype.bindTo =
|
||||||
function(key, target, opt_targetKey) {
|
function(key, target, opt_targetKey) {
|
||||||
@@ -162,6 +164,7 @@ ol.Object.prototype.bindTo =
|
|||||||
* Gets a value.
|
* Gets a value.
|
||||||
* @param {string} key Key.
|
* @param {string} key Key.
|
||||||
* @return {*} Value.
|
* @return {*} Value.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Object.prototype.get = function(key) {
|
ol.Object.prototype.get = function(key) {
|
||||||
var value;
|
var value;
|
||||||
@@ -200,6 +203,7 @@ ol.Object.prototype.getKeys = function() {
|
|||||||
* objects that are bound to the object's property as well as the object
|
* objects that are bound to the object's property as well as the object
|
||||||
* that it is bound to.
|
* that it is bound to.
|
||||||
* @param {string} key Key.
|
* @param {string} key Key.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Object.prototype.notify = function(key) {
|
ol.Object.prototype.notify = function(key) {
|
||||||
var accessors = ol.Object.getAccessors(this);
|
var accessors = ol.Object.getAccessors(this);
|
||||||
@@ -232,6 +236,7 @@ ol.Object.prototype.notifyInternal_ = function(key) {
|
|||||||
* @param {Object=} opt_scope Object is whose scope to call
|
* @param {Object=} opt_scope Object is whose scope to call
|
||||||
* the listener.
|
* the listener.
|
||||||
* @return {goog.events.Key} Unique key for the listener.
|
* @return {goog.events.Key} Unique key for the listener.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Object.prototype.on = function(type, listener, opt_scope) {
|
ol.Object.prototype.on = function(type, listener, opt_scope) {
|
||||||
return goog.events.listen(this, type, listener, false, opt_scope);
|
return goog.events.listen(this, type, listener, false, opt_scope);
|
||||||
@@ -245,6 +250,7 @@ ol.Object.prototype.on = function(type, listener, opt_scope) {
|
|||||||
* @param {Object=} opt_scope Object is whose scope to call
|
* @param {Object=} opt_scope Object is whose scope to call
|
||||||
* the listener.
|
* the listener.
|
||||||
* @return {goog.events.Key} Unique key for the listener.
|
* @return {goog.events.Key} Unique key for the listener.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Object.prototype.once = function(type, listener, opt_scope) {
|
ol.Object.prototype.once = function(type, listener, opt_scope) {
|
||||||
return goog.events.listenOnce(this, type, listener, false, opt_scope);
|
return goog.events.listenOnce(this, type, listener, false, opt_scope);
|
||||||
@@ -255,6 +261,7 @@ ol.Object.prototype.once = function(type, listener, opt_scope) {
|
|||||||
* Sets a value.
|
* Sets a value.
|
||||||
* @param {string} key Key.
|
* @param {string} key Key.
|
||||||
* @param {*} value Value.
|
* @param {*} value Value.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Object.prototype.set = function(key, value) {
|
ol.Object.prototype.set = function(key, value) {
|
||||||
var accessors = ol.Object.getAccessors(this);
|
var accessors = ol.Object.getAccessors(this);
|
||||||
@@ -278,6 +285,7 @@ ol.Object.prototype.set = function(key, value) {
|
|||||||
/**
|
/**
|
||||||
* Sets a collection of key-value pairs.
|
* Sets a collection of key-value pairs.
|
||||||
* @param {Object.<string, *>} values Values.
|
* @param {Object.<string, *>} values Values.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Object.prototype.setValues = function(values) {
|
ol.Object.prototype.setValues = function(values) {
|
||||||
var key, value, setterName;
|
var key, value, setterName;
|
||||||
@@ -297,6 +305,7 @@ ol.Object.prototype.setValues = function(values) {
|
|||||||
* Removes a binding. Unbinding will set the unbound property to the current
|
* Removes a binding. Unbinding will set the unbound property to the current
|
||||||
* value. The object will not be notified, as the value has not changed.
|
* value. The object will not be notified, as the value has not changed.
|
||||||
* @param {string} key Key.
|
* @param {string} key Key.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Object.prototype.unbind = function(key) {
|
ol.Object.prototype.unbind = function(key) {
|
||||||
var listeners = ol.Object.getListeners(this);
|
var listeners = ol.Object.getListeners(this);
|
||||||
@@ -318,6 +327,7 @@ ol.Object.prototype.unbind = function(key) {
|
|||||||
* @param {Function} listener The listener function.
|
* @param {Function} listener The listener function.
|
||||||
* @param {Object=} opt_scope Object is whose scope to call
|
* @param {Object=} opt_scope Object is whose scope to call
|
||||||
* the listener.
|
* the listener.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Object.prototype.un = function(type, listener, opt_scope) {
|
ol.Object.prototype.un = function(type, listener, opt_scope) {
|
||||||
goog.events.unlisten(this, type, listener, false, opt_scope);
|
goog.events.unlisten(this, type, listener, false, opt_scope);
|
||||||
@@ -328,6 +338,7 @@ ol.Object.prototype.un = function(type, listener, opt_scope) {
|
|||||||
* Removes an event listener which was added with listen() by the key returned
|
* Removes an event listener which was added with listen() by the key returned
|
||||||
* by on().
|
* by on().
|
||||||
* @param {?number} key Key.
|
* @param {?number} key Key.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Object.prototype.unByKey = function(key) {
|
ol.Object.prototype.unByKey = function(key) {
|
||||||
goog.events.unlistenByKey(key);
|
goog.events.unlistenByKey(key);
|
||||||
@@ -336,6 +347,7 @@ ol.Object.prototype.unByKey = function(key) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes all bindings.
|
* Removes all bindings.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Object.prototype.unbindAll = function() {
|
ol.Object.prototype.unbindAll = function() {
|
||||||
for (var key in ol.Object.getListeners(this)) {
|
for (var key in ol.Object.getListeners(this)) {
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ goog.provide('ol');
|
|||||||
* linter complains with:
|
* linter complains with:
|
||||||
*
|
*
|
||||||
* "Missing newline between constructor and goog.inherits"
|
* "Missing newline between constructor and goog.inherits"
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.inherits =
|
ol.inherits =
|
||||||
goog.inherits;
|
goog.inherits;
|
||||||
|
|||||||
@@ -26,6 +26,7 @@ ol.OverlayProperty = {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @enum {string}
|
* @enum {string}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.OverlayPositioning = {
|
ol.OverlayPositioning = {
|
||||||
BOTTOM_LEFT: 'bottom-left',
|
BOTTOM_LEFT: 'bottom-left',
|
||||||
@@ -55,6 +56,7 @@ ol.OverlayPositioning = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.Object}
|
* @extends {ol.Object}
|
||||||
* @param {ol.OverlayOptions} options Overlay options.
|
* @param {ol.OverlayOptions} options Overlay options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Overlay = function(options) {
|
ol.Overlay = function(options) {
|
||||||
|
|
||||||
@@ -129,6 +131,7 @@ goog.inherits(ol.Overlay, ol.Object);
|
|||||||
/**
|
/**
|
||||||
* Get the DOM element of this overlay.
|
* Get the DOM element of this overlay.
|
||||||
* @return {Element|undefined} Element.
|
* @return {Element|undefined} Element.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.getElement = function() {
|
ol.Overlay.prototype.getElement = function() {
|
||||||
return /** @type {Element|undefined} */ (
|
return /** @type {Element|undefined} */ (
|
||||||
@@ -143,6 +146,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Get the map associated with this overlay.
|
* Get the map associated with this overlay.
|
||||||
* @return {ol.Map|undefined} Map.
|
* @return {ol.Map|undefined} Map.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.getMap = function() {
|
ol.Overlay.prototype.getMap = function() {
|
||||||
return /** @type {ol.Map|undefined} */ (
|
return /** @type {ol.Map|undefined} */ (
|
||||||
@@ -157,6 +161,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Get the current position of this overlay.
|
* Get the current position of this overlay.
|
||||||
* @return {ol.Coordinate|undefined} Position.
|
* @return {ol.Coordinate|undefined} Position.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.getPosition = function() {
|
ol.Overlay.prototype.getPosition = function() {
|
||||||
return /** @type {ol.Coordinate|undefined} */ (
|
return /** @type {ol.Coordinate|undefined} */ (
|
||||||
@@ -171,6 +176,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Get the current positioning of this overlay.
|
* Get the current positioning of this overlay.
|
||||||
* @return {ol.OverlayPositioning|undefined} Positioning.
|
* @return {ol.OverlayPositioning|undefined} Positioning.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.getPositioning = function() {
|
ol.Overlay.prototype.getPositioning = function() {
|
||||||
return /** @type {ol.OverlayPositioning|undefined} */ (
|
return /** @type {ol.OverlayPositioning|undefined} */ (
|
||||||
@@ -243,6 +249,7 @@ ol.Overlay.prototype.handlePositioningChanged = function() {
|
|||||||
/**
|
/**
|
||||||
* Set the DOM element to be associated with this overlay.
|
* Set the DOM element to be associated with this overlay.
|
||||||
* @param {Element|undefined} element Element.
|
* @param {Element|undefined} element Element.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.setElement = function(element) {
|
ol.Overlay.prototype.setElement = function(element) {
|
||||||
this.set(ol.OverlayProperty.ELEMENT, element);
|
this.set(ol.OverlayProperty.ELEMENT, element);
|
||||||
@@ -256,6 +263,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Set the map to be associated with this overlay.
|
* Set the map to be associated with this overlay.
|
||||||
* @param {ol.Map|undefined} map Map.
|
* @param {ol.Map|undefined} map Map.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.setMap = function(map) {
|
ol.Overlay.prototype.setMap = function(map) {
|
||||||
this.set(ol.OverlayProperty.MAP, map);
|
this.set(ol.OverlayProperty.MAP, map);
|
||||||
@@ -269,6 +277,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Set the position for this overlay.
|
* Set the position for this overlay.
|
||||||
* @param {ol.Coordinate|undefined} position Position.
|
* @param {ol.Coordinate|undefined} position Position.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.setPosition = function(position) {
|
ol.Overlay.prototype.setPosition = function(position) {
|
||||||
this.set(ol.OverlayProperty.POSITION, position);
|
this.set(ol.OverlayProperty.POSITION, position);
|
||||||
@@ -282,6 +291,7 @@ goog.exportProperty(
|
|||||||
/**
|
/**
|
||||||
* Set the positioning for this overlay.
|
* Set the positioning for this overlay.
|
||||||
* @param {ol.OverlayPositioning|undefined} positioning Positioning.
|
* @param {ol.OverlayPositioning|undefined} positioning Positioning.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Overlay.prototype.setPositioning = function(positioning) {
|
ol.Overlay.prototype.setPositioning = function(positioning) {
|
||||||
this.set(ol.OverlayProperty.POSITIONING, positioning);
|
this.set(ol.OverlayProperty.POSITIONING, positioning);
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ goog.require('ol.parser.StringFeatureParser');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @implements {ol.parser.StringFeatureParser}
|
* @implements {ol.parser.StringFeatureParser}
|
||||||
* @extends {ol.parser.Parser}
|
* @extends {ol.parser.Parser}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.GeoJSON = function() {};
|
ol.parser.GeoJSON = function() {};
|
||||||
goog.inherits(ol.parser.GeoJSON, ol.parser.Parser);
|
goog.inherits(ol.parser.GeoJSON, ol.parser.Parser);
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ goog.require('ol.parser.XML');
|
|||||||
* @implements {ol.parser.ObjectFeatureParser}
|
* @implements {ol.parser.ObjectFeatureParser}
|
||||||
* @param {ol.parser.GPXOptions=} opt_options Optional configuration object.
|
* @param {ol.parser.GPXOptions=} opt_options Optional configuration object.
|
||||||
* @extends {ol.parser.XML}
|
* @extends {ol.parser.XML}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.GPX = function(opt_options) {
|
ol.parser.GPX = function(opt_options) {
|
||||||
var options = /** @type {ol.parser.GPXOptions} */
|
var options = /** @type {ol.parser.GPXOptions} */
|
||||||
|
|||||||
@@ -42,6 +42,7 @@ goog.require('ol.style.Stroke');
|
|||||||
* @implements {ol.parser.AsyncStringFeatureParser}
|
* @implements {ol.parser.AsyncStringFeatureParser}
|
||||||
* @param {ol.parser.KMLOptions=} opt_options Optional configuration object.
|
* @param {ol.parser.KMLOptions=} opt_options Optional configuration object.
|
||||||
* @extends {ol.parser.XML}
|
* @extends {ol.parser.XML}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.KML = function(opt_options) {
|
ol.parser.KML = function(opt_options) {
|
||||||
var options = /** @type {ol.parser.KMLOptions} */
|
var options = /** @type {ol.parser.KMLOptions} */
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ goog.require('ol.parser.ogc.GML');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @param {ol.parser.GMLOptions=} opt_options Optional configuration object.
|
* @param {ol.parser.GMLOptions=} opt_options Optional configuration object.
|
||||||
* @extends {ol.parser.ogc.GML}
|
* @extends {ol.parser.ogc.GML}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.ogc.GML_v2 = function(opt_options) {
|
ol.parser.ogc.GML_v2 = function(opt_options) {
|
||||||
this.schemaLocation = 'http://www.opengis.net/gml ' +
|
this.schemaLocation = 'http://www.opengis.net/gml ' +
|
||||||
@@ -127,6 +128,7 @@ goog.inherits(ol.parser.ogc.GML_v2, ol.parser.ogc.GML);
|
|||||||
* GML.
|
* GML.
|
||||||
* @param {ol.parser.GMLWriteOptions=} opt_options Write options.
|
* @param {ol.parser.GMLWriteOptions=} opt_options Write options.
|
||||||
* @return {string} A string representing the GML document.
|
* @return {string} A string representing the GML document.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.ogc.GML_v2.prototype.write = function(obj, opt_options) {
|
ol.parser.ogc.GML_v2.prototype.write = function(obj, opt_options) {
|
||||||
this.applyWriteOptions(obj, opt_options);
|
this.applyWriteOptions(obj, opt_options);
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ goog.require('ol.parser.ogc.GML');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @param {ol.parser.GMLOptions=} opt_options Optional configuration object.
|
* @param {ol.parser.GMLOptions=} opt_options Optional configuration object.
|
||||||
* @extends {ol.parser.ogc.GML}
|
* @extends {ol.parser.ogc.GML}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.ogc.GML_v3 = function(opt_options) {
|
ol.parser.ogc.GML_v3 = function(opt_options) {
|
||||||
this.schemaLocation = 'http://www.opengis.net/gml ' +
|
this.schemaLocation = 'http://www.opengis.net/gml ' +
|
||||||
@@ -425,6 +426,7 @@ goog.inherits(ol.parser.ogc.GML_v3, ol.parser.ogc.GML);
|
|||||||
* XML.
|
* XML.
|
||||||
* @param {ol.parser.GMLWriteOptions=} opt_options Write options.
|
* @param {ol.parser.GMLWriteOptions=} opt_options Write options.
|
||||||
* @return {string} An string representing the XML document.
|
* @return {string} An string representing the XML document.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.ogc.GML_v3.prototype.write = function(obj, opt_options) {
|
ol.parser.ogc.GML_v3.prototype.write = function(obj, opt_options) {
|
||||||
this.applyWriteOptions(obj, opt_options);
|
this.applyWriteOptions(obj, opt_options);
|
||||||
|
|||||||
@@ -43,6 +43,7 @@ ol.ENABLE_WMSCAPS_1_1_1_WMSC = true;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @param {Object=} opt_options Options which will be set on this object.
|
* @param {Object=} opt_options Options which will be set on this object.
|
||||||
* @extends {ol.parser.ogc.Versioned}
|
* @extends {ol.parser.ogc.Versioned}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.ogc.WMSCapabilities = function(opt_options) {
|
ol.parser.ogc.WMSCapabilities = function(opt_options) {
|
||||||
opt_options = opt_options || {};
|
opt_options = opt_options || {};
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ goog.require('ol.parser.ogc.WMTSCapabilities_v1_0_0');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @param {Object=} opt_options Options which will be set on this object.
|
* @param {Object=} opt_options Options which will be set on this object.
|
||||||
* @extends {ol.parser.ogc.Versioned}
|
* @extends {ol.parser.ogc.Versioned}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.ogc.WMTSCapabilities = function(opt_options) {
|
ol.parser.ogc.WMTSCapabilities = function(opt_options) {
|
||||||
opt_options = opt_options || {};
|
opt_options = opt_options || {};
|
||||||
|
|||||||
@@ -4,5 +4,6 @@ goog.provide('ol.parser.Parser');
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @constructor
|
* @constructor
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.Parser = function() {};
|
ol.parser.Parser = function() {};
|
||||||
|
|||||||
@@ -20,6 +20,7 @@ goog.require('ol.parser.StringFeatureParser');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @implements {ol.parser.StringFeatureParser}
|
* @implements {ol.parser.StringFeatureParser}
|
||||||
* @extends {ol.parser.Parser}
|
* @extends {ol.parser.Parser}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.TopoJSON = function() {};
|
ol.parser.TopoJSON = function() {};
|
||||||
goog.inherits(ol.parser.TopoJSON, ol.parser.Parser);
|
goog.inherits(ol.parser.TopoJSON, ol.parser.Parser);
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ goog.require('ol.parser.Parser');
|
|||||||
/**
|
/**
|
||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.parser.Parser}
|
* @extends {ol.parser.Parser}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.WKT = function() {
|
ol.parser.WKT = function() {
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ goog.require('ol.parser.Parser');
|
|||||||
/**
|
/**
|
||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.parser.Parser}
|
* @extends {ol.parser.Parser}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.parser.XML = function() {
|
ol.parser.XML = function() {
|
||||||
if (goog.global.ActiveXObject) {
|
if (goog.global.ActiveXObject) {
|
||||||
|
|||||||
@@ -28,12 +28,14 @@ ol.HAVE_PROJ4JS = ol.ENABLE_PROJ4JS && typeof Proj4js == 'object';
|
|||||||
* A projection as {@link ol.proj.Projection}, SRS identifier string or
|
* A projection as {@link ol.proj.Projection}, SRS identifier string or
|
||||||
* undefined.
|
* undefined.
|
||||||
* @typedef {ol.proj.Projection|string|undefined} ol.proj.ProjectionLike
|
* @typedef {ol.proj.Projection|string|undefined} ol.proj.ProjectionLike
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.proj.ProjectionLike;
|
ol.proj.ProjectionLike;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @enum {string}
|
* @enum {string}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.proj.Units = {
|
ol.proj.Units = {
|
||||||
DEGREES: 'degrees',
|
DEGREES: 'degrees',
|
||||||
@@ -57,6 +59,7 @@ ol.METERS_PER_UNIT[ol.proj.Units.METERS] = 1;
|
|||||||
/**
|
/**
|
||||||
* @constructor
|
* @constructor
|
||||||
* @param {ol.ProjectionOptions} options Projection options.
|
* @param {ol.ProjectionOptions} options Projection options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.proj.Projection = function(options) {
|
ol.proj.Projection = function(options) {
|
||||||
|
|
||||||
@@ -363,6 +366,7 @@ ol.proj.addProj4jsProjection_ = function(proj4jsProjection) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {ol.proj.Projection} projection Projection.
|
* @param {ol.proj.Projection} projection Projection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.proj.addProjection = function(projection) {
|
ol.proj.addProjection = function(projection) {
|
||||||
var projections = ol.proj.projections_;
|
var projections = ol.proj.projections_;
|
||||||
@@ -460,6 +464,7 @@ ol.proj.removeTransform = function(source, destination) {
|
|||||||
* a combination of authority and identifier such as "EPSG:4326", or an
|
* a combination of authority and identifier such as "EPSG:4326", or an
|
||||||
* existing projection object, or undefined.
|
* existing projection object, or undefined.
|
||||||
* @return {ol.proj.Projection} Projection.
|
* @return {ol.proj.Projection} Projection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.proj.get = function(projectionLike) {
|
ol.proj.get = function(projectionLike) {
|
||||||
var projection;
|
var projection;
|
||||||
@@ -541,6 +546,7 @@ ol.proj.equivalent = function(projection1, projection2) {
|
|||||||
* @param {ol.proj.ProjectionLike} source Source.
|
* @param {ol.proj.ProjectionLike} source Source.
|
||||||
* @param {ol.proj.ProjectionLike} destination Destination.
|
* @param {ol.proj.ProjectionLike} destination Destination.
|
||||||
* @return {ol.TransformFunction} Transform.
|
* @return {ol.TransformFunction} Transform.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.proj.getTransform = function(source, destination) {
|
ol.proj.getTransform = function(source, destination) {
|
||||||
var sourceProjection = ol.proj.get(source);
|
var sourceProjection = ol.proj.get(source);
|
||||||
@@ -557,6 +563,7 @@ ol.proj.getTransform = function(source, destination) {
|
|||||||
* @param {ol.proj.Projection} sourceProjection Source projection.
|
* @param {ol.proj.Projection} sourceProjection Source projection.
|
||||||
* @param {ol.proj.Projection} destinationProjection Destination projection.
|
* @param {ol.proj.Projection} destinationProjection Destination projection.
|
||||||
* @return {ol.TransformFunction} Transform.
|
* @return {ol.TransformFunction} Transform.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.proj.getTransformFromProjections =
|
ol.proj.getTransformFromProjections =
|
||||||
function(sourceProjection, destinationProjection) {
|
function(sourceProjection, destinationProjection) {
|
||||||
@@ -676,6 +683,7 @@ ol.proj.cloneTransform = function(input, opt_output, opt_dimension) {
|
|||||||
* @param {ol.proj.ProjectionLike} source Source.
|
* @param {ol.proj.ProjectionLike} source Source.
|
||||||
* @param {ol.proj.ProjectionLike} destination Destination.
|
* @param {ol.proj.ProjectionLike} destination Destination.
|
||||||
* @return {ol.Coordinate} Point.
|
* @return {ol.Coordinate} Point.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.proj.transform = function(point, source, destination) {
|
ol.proj.transform = function(point, source, destination) {
|
||||||
var transformFn = ol.proj.getTransform(source, destination);
|
var transformFn = ol.proj.getTransform(source, destination);
|
||||||
@@ -690,6 +698,7 @@ ol.proj.transform = function(point, source, destination) {
|
|||||||
* @param {ol.proj.Projection} sourceProjection Source projection.
|
* @param {ol.proj.Projection} sourceProjection Source projection.
|
||||||
* @param {ol.proj.Projection} destinationProjection Destination projection.
|
* @param {ol.proj.Projection} destinationProjection Destination projection.
|
||||||
* @return {ol.Coordinate} Point.
|
* @return {ol.Coordinate} Point.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.proj.transformWithProjections =
|
ol.proj.transformWithProjections =
|
||||||
function(point, sourceProjection, destinationProjection) {
|
function(point, sourceProjection, destinationProjection) {
|
||||||
@@ -702,6 +711,7 @@ ol.proj.transformWithProjections =
|
|||||||
/**
|
/**
|
||||||
* @param {ol.Proj4jsProjectionOptions} options Proj4js projection options.
|
* @param {ol.Proj4jsProjectionOptions} options Proj4js projection options.
|
||||||
* @return {ol.proj.Projection} Proj4js projection.
|
* @return {ol.proj.Projection} Proj4js projection.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.proj.configureProj4jsProjection = function(options) {
|
ol.proj.configureProj4jsProjection = function(options) {
|
||||||
goog.asserts.assert(!goog.object.containsKey(
|
goog.asserts.assert(!goog.object.containsKey(
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ goog.provide('ol.size');
|
|||||||
/**
|
/**
|
||||||
* An array of numbers representing a size: `[width, height]`.
|
* An array of numbers representing a size: `[width, height]`.
|
||||||
* @typedef {Array.<number>} ol.Size
|
* @typedef {Array.<number>} ol.Size
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.Size;
|
ol.Size;
|
||||||
|
|
||||||
|
|||||||
@@ -19,6 +19,7 @@ goog.require('ol.tilegrid.XYZ');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.TileImage}
|
* @extends {ol.source.TileImage}
|
||||||
* @param {ol.source.BingMapsOptions} options Bing Maps options.
|
* @param {ol.source.BingMapsOptions} options Bing Maps options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.BingMaps = function(options) {
|
ol.source.BingMaps = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -85,6 +85,7 @@ ol.DebugTile_.prototype.getImage = function(opt_context) {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.Tile}
|
* @extends {ol.source.Tile}
|
||||||
* @param {ol.source.TileDebugOptions} options Debug tile options.
|
* @param {ol.source.TileDebugOptions} options Debug tile options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.TileDebug = function(options) {
|
ol.source.TileDebug = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ goog.provide('ol.source.FeatureInfoSource');
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @interface
|
* @interface
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.FeatureInfoSource = function() {};
|
ol.source.FeatureInfoSource = function() {};
|
||||||
|
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ goog.require('ol.source.Source');
|
|||||||
* resolutions: (Array.<number>|undefined),
|
* resolutions: (Array.<number>|undefined),
|
||||||
* imageUrlFunction: (ol.ImageUrlFunctionType|
|
* imageUrlFunction: (ol.ImageUrlFunctionType|
|
||||||
* undefined)}}
|
* undefined)}}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.ImageOptions;
|
ol.source.ImageOptions;
|
||||||
|
|
||||||
@@ -30,6 +31,7 @@ ol.source.ImageOptions;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.Source}
|
* @extends {ol.source.Source}
|
||||||
* @param {ol.source.ImageOptions} options Single image source options.
|
* @param {ol.source.ImageOptions} options Single image source options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.Image = function(options) {
|
ol.source.Image = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ goog.require('ol.source.Image');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.Image}
|
* @extends {ol.source.Image}
|
||||||
* @param {ol.source.ImageStaticOptions} options Options.
|
* @param {ol.source.ImageStaticOptions} options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.ImageStatic = function(options) {
|
ol.source.ImageStatic = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ goog.require('ol.source.wms');
|
|||||||
* @extends {ol.source.Image}
|
* @extends {ol.source.Image}
|
||||||
* @implements {ol.source.FeatureInfoSource}
|
* @implements {ol.source.FeatureInfoSource}
|
||||||
* @param {ol.source.ImageWMSOptions} options Options.
|
* @param {ol.source.ImageWMSOptions} options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.ImageWMS = function(options) {
|
ol.source.ImageWMS = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ goog.require('ol.source.XYZ');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.XYZ}
|
* @extends {ol.source.XYZ}
|
||||||
* @param {ol.source.MapQuestOptions=} opt_options MapQuest options.
|
* @param {ol.source.MapQuestOptions=} opt_options MapQuest options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.MapQuestOSM = function(opt_options) {
|
ol.source.MapQuestOSM = function(opt_options) {
|
||||||
|
|
||||||
@@ -43,6 +44,7 @@ goog.inherits(ol.source.MapQuestOSM, ol.source.XYZ);
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.XYZ}
|
* @extends {ol.source.XYZ}
|
||||||
* @param {ol.source.MapQuestOptions=} opt_options MapQuest options.
|
* @param {ol.source.MapQuestOptions=} opt_options MapQuest options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.MapQuestOpenAerial = function(opt_options) {
|
ol.source.MapQuestOpenAerial = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ goog.require('ol.source.XYZ');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.XYZ}
|
* @extends {ol.source.XYZ}
|
||||||
* @param {ol.source.OSMOptions=} opt_options Open Street Map options.
|
* @param {ol.source.OSMOptions=} opt_options Open Street Map options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.OSM = function(opt_options) {
|
ol.source.OSM = function(opt_options) {
|
||||||
|
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ ol.source.State = {
|
|||||||
* logo: (string|undefined),
|
* logo: (string|undefined),
|
||||||
* projection: ol.proj.ProjectionLike,
|
* projection: ol.proj.ProjectionLike,
|
||||||
* state: (ol.source.State|undefined)}}
|
* state: (ol.source.State|undefined)}}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.SourceOptions;
|
ol.source.SourceOptions;
|
||||||
|
|
||||||
@@ -33,6 +34,7 @@ ol.source.SourceOptions;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {goog.events.EventTarget}
|
* @extends {goog.events.EventTarget}
|
||||||
* @param {ol.source.SourceOptions} options Source options.
|
* @param {ol.source.SourceOptions} options Source options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.Source = function(options) {
|
ol.source.Source = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -81,6 +81,7 @@ ol.source.StamenProviderConfig = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.XYZ}
|
* @extends {ol.source.XYZ}
|
||||||
* @param {ol.source.StamenOptions} options Stamen options.
|
* @param {ol.source.StamenOptions} options Stamen options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.Stamen = function(options) {
|
ol.source.Stamen = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -25,6 +25,7 @@ goog.require('ol.tilegrid.TileGrid');
|
|||||||
* tileGrid: (ol.tilegrid.TileGrid|undefined),
|
* tileGrid: (ol.tilegrid.TileGrid|undefined),
|
||||||
* tileLoadFunction: (ol.TileLoadFunctionType|undefined),
|
* tileLoadFunction: (ol.TileLoadFunctionType|undefined),
|
||||||
* tileUrlFunction: (ol.TileUrlFunctionType|undefined)}}
|
* tileUrlFunction: (ol.TileUrlFunctionType|undefined)}}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.TileImageOptions;
|
ol.source.TileImageOptions;
|
||||||
|
|
||||||
@@ -34,6 +35,7 @@ ol.source.TileImageOptions;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.Tile}
|
* @extends {ol.source.Tile}
|
||||||
* @param {ol.source.TileImageOptions} options Image tile options.
|
* @param {ol.source.TileImageOptions} options Image tile options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.TileImage = function(options) {
|
ol.source.TileImage = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -41,6 +41,7 @@ goog.exportSymbol('grid', grid);
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.TileImage}
|
* @extends {ol.source.TileImage}
|
||||||
* @param {ol.source.TileJSONOptions} options TileJSON options.
|
* @param {ol.source.TileJSONOptions} options TileJSON options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.TileJSON = function(options) {
|
ol.source.TileJSON = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ goog.require('ol.tilegrid.TileGrid');
|
|||||||
* opaque: (boolean|undefined),
|
* opaque: (boolean|undefined),
|
||||||
* projection: ol.proj.ProjectionLike,
|
* projection: ol.proj.ProjectionLike,
|
||||||
* tileGrid: (ol.tilegrid.TileGrid|undefined)}}
|
* tileGrid: (ol.tilegrid.TileGrid|undefined)}}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.TileOptions;
|
ol.source.TileOptions;
|
||||||
|
|
||||||
@@ -27,6 +28,7 @@ ol.source.TileOptions;
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.Source}
|
* @extends {ol.source.Source}
|
||||||
* @param {ol.source.TileOptions} options Tile source options.
|
* @param {ol.source.TileOptions} options Tile source options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.Tile = function(options) {
|
ol.source.Tile = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -20,6 +20,7 @@ goog.require('ol.source.wms');
|
|||||||
* @extends {ol.source.TileImage}
|
* @extends {ol.source.TileImage}
|
||||||
* @implements {ol.source.FeatureInfoSource}
|
* @implements {ol.source.FeatureInfoSource}
|
||||||
* @param {ol.source.TileWMSOptions} options Tile WMS options.
|
* @param {ol.source.TileWMSOptions} options Tile WMS options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.TileWMS = function(options) {
|
ol.source.TileWMS = function(options) {
|
||||||
|
|
||||||
@@ -127,6 +128,7 @@ ol.source.TileWMS.prototype.getKeyZXY = function(z, x, y) {
|
|||||||
* Get the user-provided params, i.e. those passed to the constructor through
|
* Get the user-provided params, i.e. those passed to the constructor through
|
||||||
* the "params" option, and possibly updated using the updateParams method.
|
* the "params" option, and possibly updated using the updateParams method.
|
||||||
* @return {Object} Params.
|
* @return {Object} Params.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.TileWMS.prototype.getParams = function() {
|
ol.source.TileWMS.prototype.getParams = function() {
|
||||||
return this.params_;
|
return this.params_;
|
||||||
@@ -172,6 +174,7 @@ ol.source.TileWMS.prototype.resetCoordKeyPrefix_ = function() {
|
|||||||
/**
|
/**
|
||||||
* Update the user-provided params.
|
* Update the user-provided params.
|
||||||
* @param {Object} params Params.
|
* @param {Object} params Params.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.TileWMS.prototype.updateParams = function(params) {
|
ol.source.TileWMS.prototype.updateParams = function(params) {
|
||||||
goog.object.extend(this.params_, params);
|
goog.object.extend(this.params_, params);
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ ol.source.VectorLoadState = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.Source}
|
* @extends {ol.source.Source}
|
||||||
* @param {ol.source.VectorOptions} options Vector source options.
|
* @param {ol.source.VectorOptions} options Vector source options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.Vector = function(options) {
|
ol.source.Vector = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ goog.require('ol.source.Source');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.Source}
|
* @extends {ol.source.Source}
|
||||||
* @param {ol.source.Vector2Options} options Options.
|
* @param {ol.source.Vector2Options} options Options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.Vector2 = function(options) {
|
ol.source.Vector2 = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ goog.require('goog.uri.utils');
|
|||||||
/**
|
/**
|
||||||
* Method to use to get WMS feature info.
|
* Method to use to get WMS feature info.
|
||||||
* @enum {string}
|
* @enum {string}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.WMSGetFeatureInfoMethod = {
|
ol.source.WMSGetFeatureInfoMethod = {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -29,6 +29,7 @@ ol.source.WMTSRequestEncoding = {
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.TileImage}
|
* @extends {ol.source.TileImage}
|
||||||
* @param {ol.source.WMTSOptions} options WMTS options.
|
* @param {ol.source.WMTSOptions} options WMTS options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.WMTS = function(options) {
|
ol.source.WMTS = function(options) {
|
||||||
|
|
||||||
@@ -193,6 +194,7 @@ goog.inherits(ol.source.WMTS, ol.source.TileImage);
|
|||||||
* "dimensions" option, and possibly updated using the updateDimensions
|
* "dimensions" option, and possibly updated using the updateDimensions
|
||||||
* method.
|
* method.
|
||||||
* @return {Object} Dimensions.
|
* @return {Object} Dimensions.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.WMTS.prototype.getDimensions = function() {
|
ol.source.WMTS.prototype.getDimensions = function() {
|
||||||
return this.dimensions_;
|
return this.dimensions_;
|
||||||
@@ -223,6 +225,7 @@ ol.source.WMTS.prototype.resetCoordKeyPrefix_ = function() {
|
|||||||
/**
|
/**
|
||||||
* Update the dimensions.
|
* Update the dimensions.
|
||||||
* @param {Object} dimensions Dimensions.
|
* @param {Object} dimensions Dimensions.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
|
ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
|
||||||
goog.object.extend(this.dimensions_, dimensions);
|
goog.object.extend(this.dimensions_, dimensions);
|
||||||
@@ -235,6 +238,7 @@ ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
|
|||||||
* @param {Object} wmtsCap An object representing the capabilities document.
|
* @param {Object} wmtsCap An object representing the capabilities document.
|
||||||
* @param {string} layer The layer identifier.
|
* @param {string} layer The layer identifier.
|
||||||
* @return {ol.source.WMTSOptions} WMTS source options object.
|
* @return {ol.source.WMTSOptions} WMTS source options object.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.WMTS.optionsFromCapabilities = function(wmtsCap, layer) {
|
ol.source.WMTS.optionsFromCapabilities = function(wmtsCap, layer) {
|
||||||
|
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ goog.require('ol.tilegrid.XYZ');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.source.TileImage}
|
* @extends {ol.source.TileImage}
|
||||||
* @param {ol.source.XYZOptions} options XYZ options.
|
* @param {ol.source.XYZOptions} options XYZ options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.XYZ = function(options) {
|
ol.source.XYZ = function(options) {
|
||||||
|
|
||||||
@@ -67,6 +68,7 @@ ol.source.XYZ.prototype.setTileUrlFunction = function(tileUrlFunction) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {string} url URL.
|
* @param {string} url URL.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.source.XYZ.prototype.setUrl = function(url) {
|
ol.source.XYZ.prototype.setUrl = function(url) {
|
||||||
this.setTileUrlFunction(ol.TileUrlFunction.createFromTemplates(
|
this.setTileUrlFunction(ol.TileUrlFunction.createFromTemplates(
|
||||||
|
|||||||
@@ -28,6 +28,7 @@ ol.BUFFER_REPLACE_UNUSED_ENTRIES_WITH_NANS = goog.DEBUG;
|
|||||||
* @param {Array.<number>=} opt_arr Array.
|
* @param {Array.<number>=} opt_arr Array.
|
||||||
* @param {number=} opt_used Used.
|
* @param {number=} opt_used Used.
|
||||||
* @param {number=} opt_usage Usage.
|
* @param {number=} opt_usage Usage.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.structs.Buffer = function(opt_arr, opt_used, opt_usage) {
|
ol.structs.Buffer = function(opt_arr, opt_used, opt_usage) {
|
||||||
|
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ goog.require('ol.style.Symbolizer');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.style.Symbolizer}
|
* @extends {ol.style.Symbolizer}
|
||||||
* @param {ol.style.FillOptions=} opt_options Polygon options.
|
* @param {ol.style.FillOptions=} opt_options Polygon options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.style.Fill = function(opt_options) {
|
ol.style.Fill = function(opt_options) {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ goog.require('ol.style.Point');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.style.Point}
|
* @extends {ol.style.Point}
|
||||||
* @param {ol.style.IconOptions} options Icon options.
|
* @param {ol.style.IconOptions} options Icon options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.style.Icon = function(options) {
|
ol.style.Icon = function(options) {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ goog.require('ol.style.Symbolizer');
|
|||||||
/**
|
/**
|
||||||
* @constructor
|
* @constructor
|
||||||
* @param {ol.style.RuleOptions} options Rule options.
|
* @param {ol.style.RuleOptions} options Rule options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.style.Rule = function(options) {
|
ol.style.Rule = function(options) {
|
||||||
|
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ goog.require('ol.style.PointLiteral');
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @enum {string}
|
* @enum {string}
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.style.ShapeType = {
|
ol.style.ShapeType = {
|
||||||
CIRCLE: 'circle'
|
CIRCLE: 'circle'
|
||||||
|
|||||||
@@ -18,6 +18,7 @@ goog.require('ol.style.Stroke');
|
|||||||
* @constructor
|
* @constructor
|
||||||
* @extends {ol.style.Point}
|
* @extends {ol.style.Point}
|
||||||
* @param {ol.style.ShapeOptions} options Shape options.
|
* @param {ol.style.ShapeOptions} options Shape options.
|
||||||
|
* @todo stability experimental
|
||||||
*/
|
*/
|
||||||
ol.style.Shape = function(options) {
|
ol.style.Shape = function(options) {
|
||||||
goog.base(this);
|
goog.base(this);
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user