diff --git a/apidoc/plugins/typedefs.js b/apidoc/plugins/typedefs.js
index af6215e915..1b4543d1b5 100644
--- a/apidoc/plugins/typedefs.js
+++ b/apidoc/plugins/typedefs.js
@@ -28,6 +28,10 @@ exports.handlers = {
newDoclet: function(e) {
var doclet = e.doclet;
if (doclet.meta.filename == 'olx.js') {
+ // do nothing if not marked @api
+ if (!doclet.stability) {
+ return;
+ }
if (doclet.kind == 'typedef') {
lastOlxTypedef = doclet;
olxTypes[doclet.longname] = [];
diff --git a/externs/olx.js b/externs/olx.js
index 8bcd06b88d..9a1cad5491 100644
--- a/externs/olx.js
+++ b/externs/olx.js
@@ -18,6 +18,7 @@ olx.AttributionOptions;
/**
* HTML markup for this attribution.
* @type {string}
+ * @api stable
*/
olx.AttributionOptions.prototype.html;
@@ -34,6 +35,7 @@ olx.DeviceOptions;
* When set to false, no tiles will be loaded while animating, which improves
* responsiveness on devices with slow memory. Default is `true`.
* @type {boolean|undefined}
+ * @api
*/
olx.DeviceOptions.prototype.loadTilesWhileAnimating;
@@ -42,6 +44,7 @@ olx.DeviceOptions.prototype.loadTilesWhileAnimating;
* When set to false, no tiles will be loaded while interacting, which improves
* responsiveness on devices with slow memory. Default is `true`.
* @type {boolean|undefined}
+ * @api
*/
olx.DeviceOptions.prototype.loadTilesWhileInteracting;
@@ -56,6 +59,7 @@ olx.DeviceOrientationOptions;
/**
* Start tracking. Default is `false`.
* @type {boolean|undefined}
+ * @api
*/
olx.DeviceOrientationOptions.prototype.tracking;
@@ -72,6 +76,7 @@ olx.GeolocationOptions;
/**
* Start Tracking. Default is `false`.
* @type {boolean|undefined}
+ * @api
*/
olx.GeolocationOptions.prototype.tracking;
@@ -80,6 +85,7 @@ olx.GeolocationOptions.prototype.tracking;
* Tracking options. See
* {@link http://www.w3.org/TR/geolocation-API/#position_options_interface}.
* @type {GeolocationPositionOptions|undefined}
+ * @api
*/
olx.GeolocationOptions.prototype.trackingOptions;
@@ -87,6 +93,7 @@ olx.GeolocationOptions.prototype.trackingOptions;
/**
* Projection.
* @type {ol.proj.ProjectionLike}
+ * @api
*/
olx.GeolocationOptions.prototype.projection;
@@ -102,6 +109,7 @@ olx.LogoOptions;
/**
* Link url for the logo. Will be followed when the logo is clicked.
* @type {string}
+ * @api
*/
olx.LogoOptions.prototype.href;
@@ -109,6 +117,7 @@ olx.LogoOptions.prototype.href;
/**
* Image src for the logo
* @type {string}
+ * @api
*/
olx.LogoOptions.prototype.src;
@@ -118,6 +127,7 @@ olx.LogoOptions.prototype.src;
* maxLines: (number|undefined),
* strokeStyle: (ol.style.Stroke|undefined),
* targetSize: (number|undefined)}}
+ * @api
*/
olx.GraticuleOptions;
@@ -125,6 +135,7 @@ olx.GraticuleOptions;
/**
* Reference to an `ol.Map` object.
* @type {ol.Map|undefined}
+ * @api
*/
olx.GraticuleOptions.prototype.map;
@@ -137,6 +148,7 @@ olx.GraticuleOptions.prototype.map;
* the value more lines will be drawn and the drawing performance will
* decrease.
* @type {number|undefined}
+ * @api
*/
olx.GraticuleOptions.prototype.maxLines;
@@ -146,6 +158,7 @@ olx.GraticuleOptions.prototype.maxLines;
* lines will be drawn with `rgba(0,0,0,0.2)`, a not fully opaque black.
*
* @type {ol.style.Stroke|undefined}
+ * @api
*/
olx.GraticuleOptions.prototype.strokeStyle;
@@ -154,6 +167,7 @@ olx.GraticuleOptions.prototype.strokeStyle;
* The target size of the graticule cells, in pixels. Default
* value is 100 pixels.
* @type {number|undefined}
+ * @api
*/
olx.GraticuleOptions.prototype.targetSize;
@@ -180,6 +194,7 @@ olx.MapOptions;
* Controls initially added to the map. If not specified,
* {@link ol.control.defaults ol.control.defaults()} is used.
* @type {ol.Collection.
|Array.|undefined}
+ * @api
*/
olx.MapOptions.prototype.controls;
@@ -187,6 +202,7 @@ olx.MapOptions.prototype.controls;
/**
* Device options for the map.
* @type {olx.DeviceOptions|undefined}
+ * @api
*/
olx.MapOptions.prototype.deviceOptions;
@@ -195,6 +211,7 @@ olx.MapOptions.prototype.deviceOptions;
* The ratio between physical pixels and device-independent pixels (dips) on the
* device. If `undefined` then it gets set by using `window.devicePixelRatio`.
* @type {number|undefined}
+ * @api
*/
olx.MapOptions.prototype.pixelRatio;
@@ -203,6 +220,7 @@ olx.MapOptions.prototype.pixelRatio;
* Interactions that are initially added to the map. If not specified,
* {@link ol.interaction.defaults ol.interaction.defaults()} is used.
* @type {ol.Collection.|Array.|undefined}
+ * @api
*/
olx.MapOptions.prototype.interactions;
@@ -216,6 +234,7 @@ olx.MapOptions.prototype.interactions;
* is not `document` the target element needs to be focused for key events to be
* emitted, requiring that the target element has a `tabindex` attribute.
* @type {Element|Document|string|undefined}
+ * @api
*/
olx.MapOptions.prototype.keyboardEventTarget;
@@ -223,6 +242,7 @@ olx.MapOptions.prototype.keyboardEventTarget;
/**
* Layers. If this is not defined, a map with no layers will be rendered.
* @type {Array.|ol.Collection.|undefined}
+ * @api
*/
olx.MapOptions.prototype.layers;
@@ -234,6 +254,7 @@ olx.MapOptions.prototype.layers;
* property should be a URL for creating a link. To disable the map logo, set
* the option to `false`. By default, the OpenLayers 3 logo is shown.
* @type {boolean|string|olx.LogoOptions|undefined}
+ * @api
*/
olx.MapOptions.prototype.logo;
@@ -241,6 +262,7 @@ olx.MapOptions.prototype.logo;
/**
* Overlays initially added to the map. By default, no overlays are added.
* @type {ol.Collection.|Array.|undefined}
+ * @api
*/
olx.MapOptions.prototype.overlays;
@@ -251,6 +273,7 @@ olx.MapOptions.prototype.overlays;
* {@link ol.RendererType} here to use a specific renderer.
* Note that at present only the Canvas renderer supports vector data.
* @type {ol.RendererType|Array.|string|undefined}
+ * @api
*/
olx.MapOptions.prototype.renderer;
@@ -260,6 +283,7 @@ olx.MapOptions.prototype.renderer;
* element. If not specified at construction time, {@link ol.Map#setTarget}
* must be called for the map to be rendered.
* @type {Element|string|undefined}
+ * @api
*/
olx.MapOptions.prototype.target;
@@ -268,6 +292,7 @@ olx.MapOptions.prototype.target;
* The map's view. No layer sources will be fetched unless this is specified at
* construction time or through {@link ol.Map#setView}.
* @type {ol.View|undefined}
+ * @api
*/
olx.MapOptions.prototype.view;
@@ -288,6 +313,7 @@ olx.OverlayOptions;
/**
* The overlay element.
* @type {Element|undefined}
+ * @api stable
*/
olx.OverlayOptions.prototype.element;
@@ -298,6 +324,7 @@ olx.OverlayOptions.prototype.element;
* The second element in the array is the vertical offset. A positive value
* shifts the overlay down. Default is `[0, 0]`.
* @type {Array.|undefined}
+ * @api stable
*/
olx.OverlayOptions.prototype.offset;
@@ -305,6 +332,7 @@ olx.OverlayOptions.prototype.offset;
/**
* The overlay position in map projection.
* @type {ol.Coordinate|undefined}
+ * @api stable
*/
olx.OverlayOptions.prototype.position;
@@ -315,6 +343,7 @@ olx.OverlayOptions.prototype.position;
* `'bottom-right'`, `'center-left'`, `'center-center'`, `'center-right'`,
* `'top-left'`, `'top-center'`, and `'top-right'`. Default is `'top-left'`.
* @type {ol.OverlayPositioning|string|undefined}
+ * @api stable
*/
olx.OverlayOptions.prototype.positioning;
@@ -325,6 +354,7 @@ olx.OverlayOptions.prototype.positioning;
* controls (CSS class name `ol-overlaycontainer-stopevent`); if `false` it is
* placed in the container with CSS class name `ol-overlaycontainer`.
* @type {boolean|undefined}
+ * @api stable
*/
olx.OverlayOptions.prototype.stopEvent;
@@ -335,6 +365,7 @@ olx.OverlayOptions.prototype.stopEvent;
* the controls (see the `stopEvent` option) you will probably set `insertFirst`
* to `true` so the overlay is displayed below the controls.
* @type {boolean|undefined}
+ * @api stable
*/
olx.OverlayOptions.prototype.insertFirst;
@@ -355,6 +386,7 @@ olx.ProjectionOptions;
/**
* The SRS identifier code, e.g. `EPSG:4326`.
* @type {string}
+ * @api
*/
olx.ProjectionOptions.prototype.code;
@@ -362,6 +394,7 @@ olx.ProjectionOptions.prototype.code;
/**
* Units.
* @type {ol.proj.Units|string}
+ * @api
*/
olx.ProjectionOptions.prototype.units;
@@ -369,6 +402,7 @@ olx.ProjectionOptions.prototype.units;
/**
* The validity extent for the SRS.
* @type {ol.Extent|undefined}
+ * @api
*/
olx.ProjectionOptions.prototype.extent;
@@ -376,6 +410,7 @@ olx.ProjectionOptions.prototype.extent;
/**
* The axis orientation as specified in Proj4. The default is `enu`.
* @type {string|undefined}
+ * @api
*/
olx.ProjectionOptions.prototype.axisOrientation;
@@ -383,6 +418,7 @@ olx.ProjectionOptions.prototype.axisOrientation;
/**
* Whether the projection is valid for the whole globe. Default is `false`.
* @type {boolean|undefined}
+ * @api
*/
olx.ProjectionOptions.prototype.global;
@@ -390,6 +426,7 @@ olx.ProjectionOptions.prototype.global;
/**
* The world extent for the SRS.
* @type {ol.Extent|undefined}
+ * @api
*/
olx.ProjectionOptions.prototype.worldExtent;
@@ -420,6 +457,7 @@ olx.ViewOptions;
* specified with the `projection` option. Default is `undefined`, and layer
* sources will not be fetched if this is not set.
* @type {ol.Coordinate|undefined}
+ * @api
*/
olx.ViewOptions.prototype.center;
@@ -430,6 +468,7 @@ olx.ViewOptions.prototype.center;
* of values. For example, `4` will constrain the rotation to 0, 90, 180, and
* 270 degrees. The default is `true`.
* @type {boolean|number|undefined}
+ * @api
*/
olx.ViewOptions.prototype.constrainRotation;
@@ -437,6 +476,7 @@ olx.ViewOptions.prototype.constrainRotation;
/**
* Enable rotation. Default is `true`.
* @type {boolean|undefined}
+ * @api
*/
olx.ViewOptions.prototype.enableRotation;
@@ -445,6 +485,7 @@ olx.ViewOptions.prototype.enableRotation;
* The extent that constrains the center, in other words, center cannot be set
* outside this extent. Default is `undefined`.
* @type {ol.Extent|undefined}
+ * @api
*/
olx.ViewOptions.prototype.extent;
@@ -457,6 +498,7 @@ olx.ViewOptions.prototype.extent;
* (the default) then `maxResolution` defaults to `40075016.68557849 / 256 =
* 156543.03392804097`.
* @type {number|undefined}
+ * @api
*/
olx.ViewOptions.prototype.maxResolution;
@@ -469,6 +511,7 @@ olx.ViewOptions.prototype.maxResolution;
* defaults to `40075016.68557849 / 256 / Math.pow(2, 28) =
* 0.0005831682455839253`.
* @type {number|undefined}
+ * @api
*/
olx.ViewOptions.prototype.minResolution;
@@ -479,6 +522,7 @@ olx.ViewOptions.prototype.minResolution;
* is `28`. Note that if `minResolution` is also provided, it is given
* precedence over `maxZoom`.
* @type {number|undefined}
+ * @api
*/
olx.ViewOptions.prototype.maxZoom;
@@ -489,6 +533,7 @@ olx.ViewOptions.prototype.maxZoom;
* is `0`. Note that if `maxResolution` is also provided, it is given
* precedence over `minZoom`.
* @type {number|undefined}
+ * @api
*/
olx.ViewOptions.prototype.minZoom;
@@ -496,6 +541,7 @@ olx.ViewOptions.prototype.minZoom;
/**
* The projection. Default is `EPSG:3857` (Spherical Mercator).
* @type {ol.proj.ProjectionLike}
+ * @api
*/
olx.ViewOptions.prototype.projection;
@@ -506,6 +552,7 @@ olx.ViewOptions.prototype.projection;
* `zoom`. Default is `undefined`, and layer sources will not be fetched if
* neither this nor `zoom` are defined.
* @type {number|undefined}
+ * @api
*/
olx.ViewOptions.prototype.resolution;
@@ -515,6 +562,7 @@ olx.ViewOptions.prototype.resolution;
* `maxResolution`, `minResolution`, `minZoom`, `maxZoom`, and `zoomFactor`
* options are ignored.
* @type {Array.|undefined}
+ * @api
*/
olx.ViewOptions.prototype.resolutions;
@@ -523,6 +571,7 @@ olx.ViewOptions.prototype.resolutions;
* The initial rotation for the view in radians (positive rotation clockwise).
* Default is `0`.
* @type {number|undefined}
+ * @api
*/
olx.ViewOptions.prototype.rotation;
@@ -532,6 +581,7 @@ olx.ViewOptions.prototype.rotation;
* initial resolution for the view. The initial resolution is determined using
* the `ol.View#constrainResolution` method.
* @type {number|undefined}
+ * @api
*/
olx.ViewOptions.prototype.zoom;
@@ -539,6 +589,7 @@ olx.ViewOptions.prototype.zoom;
/**
* The zoom factor used to determine the resolution constraint. Default is `2`.
* @type {number|undefined}
+ * @api
*/
olx.ViewOptions.prototype.zoomFactor;
@@ -557,6 +608,7 @@ olx.animation.BounceOptions;
* The resolution to start the bounce from, typically
* `map.getView().getResolution()`.
* @type {number}
+ * @api
*/
olx.animation.BounceOptions.prototype.resolution;
@@ -564,6 +616,7 @@ olx.animation.BounceOptions.prototype.resolution;
/**
* The start time of the animation. Default is immediately.
* @type {number|undefined}
+ * @api
*/
olx.animation.BounceOptions.prototype.start;
@@ -571,6 +624,7 @@ olx.animation.BounceOptions.prototype.start;
/**
* The duration of the animation in milliseconds. Default is `1000`.
* @type {number|undefined}
+ * @api
*/
olx.animation.BounceOptions.prototype.duration;
@@ -579,6 +633,7 @@ olx.animation.BounceOptions.prototype.duration;
* The easing function to use. Can be an {@link ol.easing} or a custom function.
* Default is {@link ol.easing.upAndDown}.
* @type {function(number):number|undefined}
+ * @api
*/
olx.animation.BounceOptions.prototype.easing;
@@ -596,6 +651,7 @@ olx.animation.PanOptions;
/**
* The location to start panning from, typically `map.getView().getCenter()`.
* @type {ol.Coordinate}
+ * @api
*/
olx.animation.PanOptions.prototype.source;
@@ -603,6 +659,7 @@ olx.animation.PanOptions.prototype.source;
/**
* The start time of the animation. Default is immediately.
* @type {number|undefined}
+ * @api
*/
olx.animation.PanOptions.prototype.start;
@@ -610,6 +667,7 @@ olx.animation.PanOptions.prototype.start;
/**
* The duration of the animation in milliseconds. Default is `1000`.
* @type {number|undefined}
+ * @api
*/
olx.animation.PanOptions.prototype.duration;
@@ -618,6 +676,7 @@ olx.animation.PanOptions.prototype.duration;
* The easing function to use. Can be an {@link ol.easing} or a custom function.
* Default is {@link ol.easing.inAndOut}.
* @type {function(number):number|undefined}
+ * @api
*/
olx.animation.PanOptions.prototype.easing;
@@ -637,6 +696,7 @@ olx.animation.RotateOptions;
* The rotation value (in radians) to begin rotating from, typically
* `map.getView().getRotation()`. If `undefined` then `0` is assumed.
* @type {number|undefined}
+ * @api
*/
olx.animation.RotateOptions.prototype.rotation;
@@ -645,6 +705,7 @@ olx.animation.RotateOptions.prototype.rotation;
* The rotation center/anchor. The map rotates around the center of the view
* if unspecified.
* @type {ol.Coordinate|undefined}
+ * @api
*/
olx.animation.RotateOptions.prototype.anchor;
@@ -652,6 +713,7 @@ olx.animation.RotateOptions.prototype.anchor;
/**
* The start time of the animation. Default is immediately.
* @type {number|undefined}
+ * @api
*/
olx.animation.RotateOptions.prototype.start;
@@ -659,6 +721,7 @@ olx.animation.RotateOptions.prototype.start;
/**
* The duration of the animation in milliseconds. Default is `1000`.
* @type {number|undefined}
+ * @api
*/
olx.animation.RotateOptions.prototype.duration;
@@ -667,6 +730,7 @@ olx.animation.RotateOptions.prototype.duration;
* The easing function to use. Can be an {@link ol.easing} or a custom function.
* Default is {@link ol.easing.inAndOut}.
* @type {function(number):number|undefined}
+ * @api
*/
olx.animation.RotateOptions.prototype.easing;
@@ -685,6 +749,7 @@ olx.animation.ZoomOptions;
* number The resolution to begin zooming from, typically
* `map.getView().getResolution()`.
* @type {number}
+ * @api
*/
olx.animation.ZoomOptions.prototype.resolution;
@@ -692,6 +757,7 @@ olx.animation.ZoomOptions.prototype.resolution;
/**
* The start time of the animation. Default is immediately.
* @type {number|undefined}
+ * @api
*/
olx.animation.ZoomOptions.prototype.start;
@@ -699,6 +765,7 @@ olx.animation.ZoomOptions.prototype.start;
/**
* The duration of the animation in milliseconds. Default is `1000`.
* @type {number|undefined}
+ * @api
*/
olx.animation.ZoomOptions.prototype.duration;
@@ -707,6 +774,7 @@ olx.animation.ZoomOptions.prototype.duration;
* The easing function to use. Can be an {@link ol.easing} or a custom function.
* Default is {@link ol.easing.inAndOut}.
* @type {function(number):number|undefined}
+ * @api
*/
olx.animation.ZoomOptions.prototype.easing;
@@ -722,6 +790,7 @@ olx.control.AttributionOptions;
/**
* CSS class name. Default is `ol-attribution`.
* @type {string|undefined}
+ * @api
*/
olx.control.AttributionOptions.prototype.className;
@@ -729,6 +798,7 @@ olx.control.AttributionOptions.prototype.className;
/**
* Target.
* @type {Element|undefined}
+ * @api
*/
olx.control.AttributionOptions.prototype.target;
@@ -739,6 +809,7 @@ olx.control.AttributionOptions.prototype.target;
* {@link http://www.openstreetmap.org/copyright OSM Copyright} —
* Default is `true`.
* @type {boolean|undefined}
+ * @api
*/
olx.control.AttributionOptions.prototype.collapsible;
@@ -746,6 +817,7 @@ olx.control.AttributionOptions.prototype.collapsible;
/**
* Specify if attributions should be collapsed at startup. Default is `true`.
* @type {boolean|undefined}
+ * @api
*/
olx.control.AttributionOptions.prototype.collapsed;
@@ -753,6 +825,7 @@ olx.control.AttributionOptions.prototype.collapsed;
/**
* Text label to use for the button tip. Default is `Attributions`
* @type {string|undefined}
+ * @api
*/
olx.control.AttributionOptions.prototype.tipLabel;
@@ -760,12 +833,14 @@ olx.control.AttributionOptions.prototype.tipLabel;
/**
* Text label to use for the collapsed attributions button. Default is `i`
* @type {string|undefined}
+ * @api
*/
olx.control.AttributionOptions.prototype.label;
/**
* Text label to use for the expanded attributions button. Default is `»`
* @type {string|undefined}
+ * @api
*/
olx.control.AttributionOptions.prototype.collapseLabel;
@@ -781,6 +856,7 @@ olx.control.ControlOptions;
* The element is the control's container element. This only needs to be
* specified if you're developing a custom control.
* @type {Element|undefined}
+ * @api stable
*/
olx.control.ControlOptions.prototype.element;
@@ -789,6 +865,7 @@ olx.control.ControlOptions.prototype.element;
* Specify a target if you want the control to be rendered outside of the map's
* viewport.
* @type {Element|string|undefined}
+ * @api stable
*/
olx.control.ControlOptions.prototype.target;
@@ -807,6 +884,7 @@ olx.control.DefaultsOptions;
/**
* Attribution. Default is `true`.
* @type {boolean|undefined}
+ * @api
*/
olx.control.DefaultsOptions.prototype.attribution;
@@ -814,6 +892,7 @@ olx.control.DefaultsOptions.prototype.attribution;
/**
* Attribution options.
* @type {olx.control.AttributionOptions|undefined}
+ * @api
*/
olx.control.DefaultsOptions.prototype.attributionOptions;
@@ -821,6 +900,7 @@ olx.control.DefaultsOptions.prototype.attributionOptions;
/**
* Rotate. Default is `true`.
* @type {boolean|undefined}
+ * @api
*/
olx.control.DefaultsOptions.prototype.rotate;
@@ -828,6 +908,7 @@ olx.control.DefaultsOptions.prototype.rotate;
/**
* Rotate options.
* @type {olx.control.RotateOptions|undefined}
+ * @api
*/
olx.control.DefaultsOptions.prototype.rotateOptions;
@@ -835,6 +916,7 @@ olx.control.DefaultsOptions.prototype.rotateOptions;
/**
* Zoom. Default is `true`.
* @type {boolean|undefined}
+ * @api
*/
olx.control.DefaultsOptions.prototype.zoom;
@@ -842,6 +924,7 @@ olx.control.DefaultsOptions.prototype.zoom;
/**
* Zoom options.
* @type {olx.control.ZoomOptions|undefined}
+ * @api
*/
olx.control.DefaultsOptions.prototype.zoomOptions;
@@ -859,6 +942,7 @@ olx.control.FullScreenOptions;
/**
* CSS class name. Default is `ol-full-screen`.
* @type {string|undefined}
+ * @api
*/
olx.control.FullScreenOptions.prototype.className;
@@ -866,6 +950,7 @@ olx.control.FullScreenOptions.prototype.className;
/**
* Text label to use for the button tip. Default is `Toggle full-screen`
* @type {string|undefined}
+ * @api
*/
olx.control.FullScreenOptions.prototype.tipLabel;
@@ -873,6 +958,7 @@ olx.control.FullScreenOptions.prototype.tipLabel;
/**
* Full keyboard access.
* @type {boolean|undefined}
+ * @api
*/
olx.control.FullScreenOptions.prototype.keys;
@@ -880,6 +966,7 @@ olx.control.FullScreenOptions.prototype.keys;
/**
* Target.
* @type {Element|undefined}
+ * @api
*/
olx.control.FullScreenOptions.prototype.target;
@@ -898,6 +985,7 @@ olx.control.MousePositionOptions;
/**
* CSS class name. Default is `ol-mouse-position`.
* @type {string|undefined}
+ * @api stable
*/
olx.control.MousePositionOptions.prototype.className;
@@ -905,6 +993,7 @@ olx.control.MousePositionOptions.prototype.className;
/**
* Coordinate format.
* @type {ol.CoordinateFormatType|undefined}
+ * @api stable
*/
olx.control.MousePositionOptions.prototype.coordinateFormat;
@@ -912,6 +1001,7 @@ olx.control.MousePositionOptions.prototype.coordinateFormat;
/**
* Projection.
* @type {ol.proj.ProjectionLike}
+ * @api stable
*/
olx.control.MousePositionOptions.prototype.projection;
@@ -919,6 +1009,7 @@ olx.control.MousePositionOptions.prototype.projection;
/**
* Target.
* @type {Element|undefined}
+ * @api stable
*/
olx.control.MousePositionOptions.prototype.target;
@@ -926,6 +1017,7 @@ olx.control.MousePositionOptions.prototype.target;
/**
* Markup for undefined coordinates. Default is `` (empty string).
* @type {string|undefined}
+ * @api stable
*/
olx.control.MousePositionOptions.prototype.undefinedHTML;
@@ -943,6 +1035,7 @@ olx.control.ScaleLineOptions;
/**
* CSS Class name. Default is `ol-scale-line`.
* @type {string|undefined}
+ * @api stable
*/
olx.control.ScaleLineOptions.prototype.className;
@@ -950,6 +1043,7 @@ olx.control.ScaleLineOptions.prototype.className;
/**
* Minimum width in pixels. Default is `64`.
* @type {number|undefined}
+ * @api stable
*/
olx.control.ScaleLineOptions.prototype.minWidth;
@@ -957,6 +1051,7 @@ olx.control.ScaleLineOptions.prototype.minWidth;
/**
* Target.
* @type {Element|undefined}
+ * @api stable
*/
olx.control.ScaleLineOptions.prototype.target;
@@ -964,6 +1059,7 @@ olx.control.ScaleLineOptions.prototype.target;
/**
* Units. Default is `metric`.
* @type {ol.control.ScaleLineUnits|string|undefined}
+ * @api stable
*/
olx.control.ScaleLineOptions.prototype.units;
@@ -983,6 +1079,7 @@ olx.control.RotateOptions;
/**
* CSS class name. Default is `ol-rotate`.
* @type {string|undefined}
+ * @api stable
*/
olx.control.RotateOptions.prototype.className;
@@ -990,6 +1087,7 @@ olx.control.RotateOptions.prototype.className;
/**
* Text label to use for the rotate button. Default is `⇧`
* @type {string|undefined}
+ * @api stable
*/
olx.control.RotateOptions.prototype.label;
@@ -997,6 +1095,7 @@ olx.control.RotateOptions.prototype.label;
/**
* Text label to use for the rotate tip. Default is `Reset rotation`
* @type {string|undefined}
+ * @api stable
*/
olx.control.RotateOptions.prototype.tipLabel;
@@ -1004,6 +1103,7 @@ olx.control.RotateOptions.prototype.tipLabel;
/**
* Animation duration in milliseconds. Default is `250`.
* @type {number|undefined}
+ * @api stable
*/
olx.control.RotateOptions.prototype.duration;
@@ -1011,6 +1111,7 @@ olx.control.RotateOptions.prototype.duration;
/**
* Hide the control when rotation is 0. Default is `true`.
* @type {boolean|undefined}
+ * @api stable
*/
olx.control.RotateOptions.prototype.autoHide;
@@ -1018,6 +1119,7 @@ olx.control.RotateOptions.prototype.autoHide;
/**
* Target.
* @type {Element|undefined}
+ * @api stable
*/
olx.control.RotateOptions.prototype.target;
@@ -1039,6 +1141,7 @@ olx.control.ZoomOptions;
/**
* Animation duration in milliseconds. Default is `250`.
* @type {number|undefined}
+ * @api stable
*/
olx.control.ZoomOptions.prototype.duration;
@@ -1046,6 +1149,7 @@ olx.control.ZoomOptions.prototype.duration;
/**
* CSS class name. Default is `ol-zoom`.
* @type {string|undefined}
+ * @api stable
*/
olx.control.ZoomOptions.prototype.className;
@@ -1053,6 +1157,7 @@ olx.control.ZoomOptions.prototype.className;
/**
* Text label to use for the zoom-in button. Default is `+`
* @type {string|undefined}
+ * @api stable
*/
olx.control.ZoomOptions.prototype.zoomInLabel;
@@ -1060,6 +1165,7 @@ olx.control.ZoomOptions.prototype.zoomInLabel;
/**
* Text label to use for the zoom-out button. Default is `-`
* @type {string|undefined}
+ * @api stable
*/
olx.control.ZoomOptions.prototype.zoomOutLabel;
@@ -1067,6 +1173,7 @@ olx.control.ZoomOptions.prototype.zoomOutLabel;
/**
* Text label to use for the button tip. Default is `Zoom in`
* @type {string|undefined}
+ * @api stable
*/
olx.control.ZoomOptions.prototype.zoomInTipLabel;
@@ -1074,6 +1181,7 @@ olx.control.ZoomOptions.prototype.zoomInTipLabel;
/**
* Text label to use for the button tip. Default is `Zoom out`
* @type {string|undefined}
+ * @api stable
*/
olx.control.ZoomOptions.prototype.zoomOutTipLabel;
@@ -1081,6 +1189,7 @@ olx.control.ZoomOptions.prototype.zoomOutTipLabel;
/**
* The zoom delta applied on each click.
* @type {number|undefined}
+ * @api stable
*/
olx.control.ZoomOptions.prototype.delta;
@@ -1088,6 +1197,7 @@ olx.control.ZoomOptions.prototype.delta;
/**
* Target.
* @type {Element|undefined}
+ * @api stable
*/
olx.control.ZoomOptions.prototype.target;
@@ -1104,6 +1214,7 @@ olx.control.ZoomSliderOptions;
/**
* CSS class name.
* @type {string|undefined}
+ * @api stable
*/
olx.control.ZoomSliderOptions.prototype.className;
@@ -1111,6 +1222,7 @@ olx.control.ZoomSliderOptions.prototype.className;
/**
* Maximum resolution.
* @type {number|undefined}
+ * @api stable
*/
olx.control.ZoomSliderOptions.prototype.maxResolution;
@@ -1118,6 +1230,7 @@ olx.control.ZoomSliderOptions.prototype.maxResolution;
/**
* Minimum resolution.
* @type {number|undefined}
+ * @api stable
*/
olx.control.ZoomSliderOptions.prototype.minResolution;
@@ -1135,6 +1248,7 @@ olx.control.ZoomToExtentOptions;
/**
* Class name. Default is `ol-zoom-extent`.
* @type {string|undefined}
+ * @api stable
*/
olx.control.ZoomToExtentOptions.prototype.className;
@@ -1142,6 +1256,7 @@ olx.control.ZoomToExtentOptions.prototype.className;
/**
* Target.
* @type {Element|undefined}
+ * @api stable
*/
olx.control.ZoomToExtentOptions.prototype.target;
@@ -1149,6 +1264,7 @@ olx.control.ZoomToExtentOptions.prototype.target;
/**
* Text label to use for the button tip. Default is `Zoom to extent`
* @type {string|undefined}
+ * @api stable
*/
olx.control.ZoomToExtentOptions.prototype.tipLabel;
@@ -1157,6 +1273,7 @@ olx.control.ZoomToExtentOptions.prototype.tipLabel;
* The extent to zoom to. If undefined the validity extent of the view
* projection is used.
* @type {ol.Extent|undefined}
+ * @api stable
*/
olx.control.ZoomToExtentOptions.prototype.extent;
@@ -1164,6 +1281,7 @@ olx.control.ZoomToExtentOptions.prototype.extent;
/**
* @typedef {{dataProjection: (ol.proj.ProjectionLike|undefined),
* featureProjection: (ol.proj.ProjectionLike|undefined)}}
+ * @api
*/
olx.format.ReadOptions;
@@ -1175,6 +1293,7 @@ olx.format.ReadOptions;
* the data and if no `defaultDataProjection` is set for a format, the features
* will not be reprojected.
* @type {ol.proj.ProjectionLike|undefined}
+ * @api
*/
olx.format.ReadOptions.prototype.dataProjection;
@@ -1183,6 +1302,7 @@ olx.format.ReadOptions.prototype.dataProjection;
* Projection of the feature geometries created by the format reader. If not
* provided, features will be returned in the `dataProjection`.
* @type {ol.proj.ProjectionLike|undefined}
+ * @api
*/
olx.format.ReadOptions.prototype.featureProjection;
@@ -1190,6 +1310,7 @@ olx.format.ReadOptions.prototype.featureProjection;
/**
* @typedef {{dataProjection: (ol.proj.ProjectionLike|undefined),
* featureProjection: ol.proj.ProjectionLike}}
+ * @api
*/
olx.format.WriteOptions;
@@ -1200,6 +1321,7 @@ olx.format.WriteOptions;
* `defaultDataProjection` is set for a format, the features will be returned
* in the `featureProjection`.
* @type {ol.proj.ProjectionLike|undefined}
+ * @api
*/
olx.format.WriteOptions.prototype.dataProjection;
@@ -1208,6 +1330,7 @@ olx.format.WriteOptions.prototype.dataProjection;
* Projection of the feature geometries that will be serialized by the format
* writer.
* @type {ol.proj.ProjectionLike}
+ * @api
*/
olx.format.WriteOptions.prototype.featureProjection;
@@ -1223,6 +1346,7 @@ olx.format.GeoJSONOptions;
/**
* Default data projection.
* @type {ol.proj.ProjectionLike}
+ * @api
*/
olx.format.GeoJSONOptions.prototype.defaultDataProjection;
@@ -1230,6 +1354,7 @@ olx.format.GeoJSONOptions.prototype.defaultDataProjection;
/**
* Geometry name to use when creating features.
* @type {string|undefined}
+ * @api
*/
olx.format.GeoJSONOptions.prototype.geometryName;
@@ -1245,6 +1370,7 @@ olx.format.PolylineOptions;
* The factor by which the coordinates values will be scaled.
* Default is `1e5`.
* @type {number}
+ * @api
*/
olx.format.PolylineOptions.prototype.factor;
@@ -1259,6 +1385,7 @@ olx.format.TopoJSONOptions;
/**
* Default data projection.
* @type {ol.proj.ProjectionLike}
+ * @api
*/
olx.format.TopoJSONOptions.prototype.defaultDataProjection;
@@ -1274,6 +1401,7 @@ olx.format.IGCOptions;
* Altitude mode. Possible values are `barometric`, `gps`, and `none`. Default
* is `none`.
* @type {ol.format.IGCZ|undefined}
+ * @api
*/
olx.format.IGCOptions.prototype.altitudeMode;
@@ -1289,6 +1417,7 @@ olx.format.KMLOptions;
/**
* Extract styles from the KML. Default is `true`.
* @type {boolean|undefined}
+ * @api
*/
olx.format.KMLOptions.prototype.extractStyles;
@@ -1296,6 +1425,7 @@ olx.format.KMLOptions.prototype.extractStyles;
/**
* Default style. The default default style is the same as Google Earth.
* @type {Array.|undefined}
+ * @api
*/
olx.format.KMLOptions.prototype.defaultStyle;
@@ -1317,6 +1447,7 @@ olx.format.GMLOptions;
/**
* Feature namespace.
* @type {string}
+ * @api
*/
olx.format.GMLOptions.prototype.featureNS;
@@ -1324,6 +1455,7 @@ olx.format.GMLOptions.prototype.featureNS;
/**
* Feature type to parse.
* @type {string}
+ * @api
*/
olx.format.GMLOptions.prototype.featureType;
@@ -1331,6 +1463,7 @@ olx.format.GMLOptions.prototype.featureType;
/**
* srsName to use when writing geometries.
* @type {string}
+ * @api
*/
olx.format.GMLOptions.prototype.srsName;
@@ -1339,6 +1472,7 @@ olx.format.GMLOptions.prototype.srsName;
* Write gml:Surface instead of gml:Polygon elements. This also affects the
* elements in multi-part geometries. Default is `false`.
* @type {boolean|undefined}
+ * @api
*/
olx.format.GMLOptions.prototype.surface;
@@ -1347,6 +1481,7 @@ olx.format.GMLOptions.prototype.surface;
* Write gml:Curve instead of gml:LineString elements. This also affects the
* elements in multi-part geometries. Default is `false`.
* @type {boolean|undefined}
+ * @api
*/
olx.format.GMLOptions.prototype.curve;
@@ -1355,6 +1490,7 @@ olx.format.GMLOptions.prototype.curve;
* Write gml:MultiCurve instead of gml:MultiLineString. Since the latter is
* deprecated in GML 3, the default is `true`.
* @type {boolean|undefined}
+ * @api
*/
olx.format.GMLOptions.prototype.multiCurve;
@@ -1363,6 +1499,7 @@ olx.format.GMLOptions.prototype.multiCurve;
* Write gml:multiSurface instead of gml:MultiPolygon. Since the latter is
* deprecated in GML 3, the default is `true`.
* @type {boolean|undefined}
+ * @api
*/
olx.format.GMLOptions.prototype.multiSurface;
@@ -1371,6 +1508,7 @@ olx.format.GMLOptions.prototype.multiSurface;
* Optional schemaLocation to use when writing out the GML, this will override
* the default provided.
* @type {string|undefined}
+ * @api
*/
olx.format.GMLOptions.prototype.schemaLocation;
@@ -1390,6 +1528,7 @@ olx.format.GPXOptions;
* nodes from `wpt`, `rte` and `trk` can be processed, as those are
* directly mapped to a feature.
* @type {function(ol.Feature, Node)}
+ * @api
*/
olx.format.GPXOptions.prototype.readExtensions;
@@ -1406,6 +1545,7 @@ olx.format.WFSOptions;
/**
* The namespace URI used for features.
* @type {string}
+ * @api
*/
olx.format.WFSOptions.prototype.featureNS;
@@ -1413,6 +1553,7 @@ olx.format.WFSOptions.prototype.featureNS;
/**
* The feature type to parse. Only used for read operations.
* @type {string}
+ * @api
*/
olx.format.WFSOptions.prototype.featureType;
@@ -1421,6 +1562,7 @@ olx.format.WFSOptions.prototype.featureType;
* Optional schemaLocation to use for serialization, this will override the
* default.
* @type {string|undefined}
+ * @api
*/
olx.format.WFSOptions.prototype.schemaLocation;
@@ -1443,6 +1585,7 @@ olx.format.WFSWriteGetFeatureOptions;
/**
* The namespace URI used for features.
* @type {string}
+ * @api
*/
olx.format.WFSWriteGetFeatureOptions.prototype.featureNS;
@@ -1450,6 +1593,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.featureNS;
/**
* The prefix for the feature namespace.
* @type {string}
+ * @api
*/
olx.format.WFSWriteGetFeatureOptions.prototype.featurePrefix;
@@ -1457,6 +1601,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.featurePrefix;
/**
* The feature type names.
* @type {Array.}
+ * @api
*/
olx.format.WFSWriteGetFeatureOptions.prototype.featureTypes;
@@ -1465,6 +1610,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.featureTypes;
* SRS name. No srsName attribute will be set on geometries when this is not
* provided.
* @type {string|undefined}
+ * @api
*/
olx.format.WFSWriteGetFeatureOptions.prototype.srsName;
@@ -1472,6 +1618,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.srsName;
/**
* Handle.
* @type {string|undefined}
+ * @api
*/
olx.format.WFSWriteGetFeatureOptions.prototype.handle;
@@ -1479,6 +1626,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.handle;
/**
* Output format.
* @type {string|undefined}
+ * @api
*/
olx.format.WFSWriteGetFeatureOptions.prototype.outputFormat;
@@ -1486,6 +1634,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.outputFormat;
/**
* Maximum number of features to fetch.
* @type {number|undefined}
+ * @api
*/
olx.format.WFSWriteGetFeatureOptions.prototype.maxFeatures;
@@ -1493,6 +1642,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.maxFeatures;
/**
* Geometry name to use in a BBOX filter.
* @type {string|undefined}
+ * @api
*/
olx.format.WFSWriteGetFeatureOptions.prototype.geometryName;
@@ -1500,6 +1650,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.geometryName;
/**
* Extent to use for the BBOX filter.
* @type {ol.Extent|undefined}
+ * @api
*/
olx.format.WFSWriteGetFeatureOptions.prototype.bbox;
@@ -1520,6 +1671,7 @@ olx.format.WFSWriteTransactionOptions;
/**
* The namespace URI used for features.
* @type {string}
+ * @api
*/
olx.format.WFSWriteTransactionOptions.prototype.featureNS;
@@ -1527,6 +1679,7 @@ olx.format.WFSWriteTransactionOptions.prototype.featureNS;
/**
* The prefix for the feature namespace.
* @type {string}
+ * @api
*/
olx.format.WFSWriteTransactionOptions.prototype.featurePrefix;
@@ -1534,6 +1687,7 @@ olx.format.WFSWriteTransactionOptions.prototype.featurePrefix;
/**
* The feature type name.
* @type {string}
+ * @api
*/
olx.format.WFSWriteTransactionOptions.prototype.featureType;
@@ -1542,6 +1696,7 @@ olx.format.WFSWriteTransactionOptions.prototype.featureType;
* SRS name. No srsName attribute will be set on geometries when this is not
* provided.
* @type {string|undefined}
+ * @api
*/
olx.format.WFSWriteTransactionOptions.prototype.srsName;
@@ -1549,6 +1704,7 @@ olx.format.WFSWriteTransactionOptions.prototype.srsName;
/**
* Handle.
* @type {string|undefined}
+ * @api
*/
olx.format.WFSWriteTransactionOptions.prototype.handle;
@@ -1556,6 +1712,7 @@ olx.format.WFSWriteTransactionOptions.prototype.handle;
/**
* Native elements. Currently not supported.
* @type {Array.