From 525456e6cd8ec6933900bf2a56c36c08099a57f5 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Thu, 21 Aug 2014 21:49:06 -0600 Subject: [PATCH] Only document olx properties marked as part of the API And mark all olx properties with @api. The stability level will be used to determine what can change between minor releases. --- apidoc/plugins/typedefs.js | 4 + externs/olx.js | 579 ++++++++++++++++++++++++++++++++++++- 2 files changed, 577 insertions(+), 6 deletions(-) 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.} + * @api */ olx.format.WFSWriteTransactionOptions.prototype.nativeElements; @@ -1563,6 +1720,7 @@ olx.format.WFSWriteTransactionOptions.prototype.nativeElements; /** * GML options for the WFS transaction writer. * @type {olx.format.GMLOptions|undefined} + * @api */ olx.format.WFSWriteTransactionOptions.prototype.gmlOptions; @@ -1578,6 +1736,7 @@ olx.format.WKTOptions; * Whether to split GeometryCollections into * multiple features on reading. Default is `false`. * @type {boolean|undefined} + * @api */ olx.format.WKTOptions.prototype.splitCollection; @@ -1602,6 +1761,7 @@ olx.interaction.DefaultsOptions; /** * Whether Alt-Shift-drag rotate is desired. Default is `true`. * @type {boolean|undefined} + * @api */ olx.interaction.DefaultsOptions.prototype.altShiftDragRotate; @@ -1609,6 +1769,7 @@ olx.interaction.DefaultsOptions.prototype.altShiftDragRotate; /** * Whether double click zoom is desired. Default is `true`. * @type {boolean|undefined} + * @api */ olx.interaction.DefaultsOptions.prototype.doubleClickZoom; @@ -1616,6 +1777,7 @@ olx.interaction.DefaultsOptions.prototype.doubleClickZoom; /** * Whether keyboard interaction is desired. Default is `true`. * @type {boolean|undefined} + * @api */ olx.interaction.DefaultsOptions.prototype.keyboard; @@ -1623,6 +1785,7 @@ olx.interaction.DefaultsOptions.prototype.keyboard; /** * Whether mousewheel zoom is desired. Default is `true`. * @type {boolean|undefined} + * @api */ olx.interaction.DefaultsOptions.prototype.mouseWheelZoom; @@ -1630,6 +1793,7 @@ olx.interaction.DefaultsOptions.prototype.mouseWheelZoom; /** * Whether Shift-drag zoom is desired. Default is `true`. * @type {boolean|undefined} + * @api */ olx.interaction.DefaultsOptions.prototype.shiftDragZoom; @@ -1637,6 +1801,7 @@ olx.interaction.DefaultsOptions.prototype.shiftDragZoom; /** * Whether drag pan is desired. Default is `true`. * @type {boolean|undefined} + * @api */ olx.interaction.DefaultsOptions.prototype.dragPan; @@ -1644,6 +1809,7 @@ olx.interaction.DefaultsOptions.prototype.dragPan; /** * Whether pinch rotate is desired. Default is `true`. * @type {boolean|undefined} + * @api */ olx.interaction.DefaultsOptions.prototype.pinchRotate; @@ -1651,6 +1817,7 @@ olx.interaction.DefaultsOptions.prototype.pinchRotate; /** * Whether pinch zoom is desired. Default is `true`. * @type {boolean|undefined} + * @api */ olx.interaction.DefaultsOptions.prototype.pinchZoom; @@ -1658,6 +1825,7 @@ olx.interaction.DefaultsOptions.prototype.pinchZoom; /** * Zoom delta. * @type {number|undefined} + * @api */ olx.interaction.DefaultsOptions.prototype.zoomDelta; @@ -1665,6 +1833,7 @@ olx.interaction.DefaultsOptions.prototype.zoomDelta; /** * Zoom duration. * @type {number|undefined} + * @api */ olx.interaction.DefaultsOptions.prototype.zoomDuration; @@ -1680,6 +1849,7 @@ olx.interaction.DoubleClickZoomOptions; /** * Animation duration in milliseconds. Default is `250`. * @type {number|undefined} + * @api */ olx.interaction.DoubleClickZoomOptions.prototype.duration; @@ -1687,6 +1857,7 @@ olx.interaction.DoubleClickZoomOptions.prototype.duration; /** * The zoom delta applied on each double click, default is `1`. * @type {number|undefined} + * @api */ olx.interaction.DoubleClickZoomOptions.prototype.delta; @@ -1702,6 +1873,7 @@ olx.interaction.DragAndDropOptions; /** * Format constructors. * @type {Array.|undefined} + * @api */ olx.interaction.DragAndDropOptions.prototype.formatConstructors; @@ -1709,6 +1881,7 @@ olx.interaction.DragAndDropOptions.prototype.formatConstructors; /** * Target projection. By default, the map's view's projection is used. * @type {ol.proj.ProjectionLike} + * @api */ olx.interaction.DragAndDropOptions.prototype.reprojectTo; @@ -1726,6 +1899,7 @@ olx.interaction.DragBoxOptions; * to indicate whether that event should be handled. * Default is {@link ol.events.condition.always}. * @type {ol.events.ConditionType|undefined} + * @api */ olx.interaction.DragBoxOptions.prototype.condition; @@ -1733,6 +1907,7 @@ olx.interaction.DragBoxOptions.prototype.condition; /** * Style for the box. * @type {ol.style.Style} + * @api */ olx.interaction.DragBoxOptions.prototype.style; @@ -1747,6 +1922,7 @@ olx.interaction.DragPanOptions; /** * Kinetic inertia to apply to the pan. * @type {ol.Kinetic|undefined} + * @api */ olx.interaction.DragPanOptions.prototype.kinetic; @@ -1763,6 +1939,7 @@ olx.interaction.DragRotateAndZoomOptions; * to indicate whether that event should be handled. * Default is {@link ol.events.condition.shiftKeyOnly}. * @type {ol.events.ConditionType|undefined} + * @api */ olx.interaction.DragRotateAndZoomOptions.prototype.condition; @@ -1779,6 +1956,7 @@ olx.interaction.DragRotateOptions; * to indicate whether that event should be handled. * Default is {@link ol.events.condition.altShiftKeysOnly}. * @type {ol.events.ConditionType|undefined} + * @api */ olx.interaction.DragRotateOptions.prototype.condition; @@ -1796,6 +1974,7 @@ olx.interaction.DragZoomOptions; * to indicate whether that event should be handled. * Default is {@link ol.events.condition.shiftKeyOnly}. * @type {ol.events.ConditionType|undefined} + * @api */ olx.interaction.DragZoomOptions.prototype.condition; @@ -1803,6 +1982,7 @@ olx.interaction.DragZoomOptions.prototype.condition; /** * Style for the box. * @type {ol.style.Style} + * @api */ olx.interaction.DragZoomOptions.prototype.style; @@ -1824,6 +2004,7 @@ olx.interaction.DrawOptions; /** * Destination collection for the drawn features. * @type {ol.Collection.|undefined} + * @api */ olx.interaction.DrawOptions.prototype.features; @@ -1831,6 +2012,7 @@ olx.interaction.DrawOptions.prototype.features; /** * Destination source for the drawn features. * @type {ol.source.Vector|undefined} + * @api */ olx.interaction.DrawOptions.prototype.source; @@ -1838,6 +2020,7 @@ olx.interaction.DrawOptions.prototype.source; /** * Pixel distance for snapping to the drawing finish. Default is `12`. * @type {number|undefined} + * @api */ olx.interaction.DrawOptions.prototype.snapTolerance; @@ -1846,6 +2029,7 @@ olx.interaction.DrawOptions.prototype.snapTolerance; * Drawing type ('Point', 'LineString', 'Polygon', 'MultiPoint', * 'MultiLineString', or 'MultiPolygon'). * @type {ol.geom.GeometryType} + * @api */ olx.interaction.DrawOptions.prototype.type; @@ -1854,6 +2038,7 @@ olx.interaction.DrawOptions.prototype.type; * The number of points that must be drawn before a polygon ring can be finished. * Default is `3`. * @type {number|undefined} + * @api */ olx.interaction.DrawOptions.prototype.minPointsPerRing; @@ -1861,6 +2046,7 @@ olx.interaction.DrawOptions.prototype.minPointsPerRing; /** * Style for sketch features. * @type {ol.style.Style|Array.|ol.style.StyleFunction|undefined} + * @api */ olx.interaction.DrawOptions.prototype.style; @@ -1868,6 +2054,7 @@ olx.interaction.DrawOptions.prototype.style; /** * Geometry name to use for features created by the draw interaction. * @type {string|undefined} + * @api */ olx.interaction.DrawOptions.prototype.geometryName; @@ -1877,6 +2064,7 @@ olx.interaction.DrawOptions.prototype.geometryName; * to indicate whether that event should be handled. * By default {@link ol.events.condition.noModifierKeys} adds a vertex. * @type {ol.events.ConditionType|undefined} + * @api */ olx.interaction.DrawOptions.prototype.condition; @@ -1895,6 +2083,7 @@ olx.interaction.KeyboardPanOptions; * Default is {@link ol.events.condition.noModifierKeys} and * {@link ol.events.condition.targetNotEditable}. * @type {ol.events.ConditionType|undefined} + * @api */ olx.interaction.KeyboardPanOptions.prototype.condition; @@ -1902,6 +2091,7 @@ olx.interaction.KeyboardPanOptions.prototype.condition; /** * Pixel The amount to pan on each key press. Default is `128` pixels. * @type {number|undefined} + * @api */ olx.interaction.KeyboardPanOptions.prototype.pixelDelta; @@ -1918,6 +2108,7 @@ olx.interaction.KeyboardZoomOptions; /** * Animation duration in milliseconds. Default is `100`. * @type {number|undefined} + * @api */ olx.interaction.KeyboardZoomOptions.prototype.duration; @@ -1927,6 +2118,7 @@ olx.interaction.KeyboardZoomOptions.prototype.duration; * to indicate whether that event should be handled. * Default is {@link ol.events.condition.targetNotEditable}. * @type {ol.events.ConditionType|undefined} + * @api */ olx.interaction.KeyboardZoomOptions.prototype.condition; @@ -1934,6 +2126,7 @@ olx.interaction.KeyboardZoomOptions.prototype.condition; /** * The amount to zoom on each key press. Default is `1`. * @type {number|undefined} + * @api */ olx.interaction.KeyboardZoomOptions.prototype.delta; @@ -1954,6 +2147,7 @@ olx.interaction.ModifyOptions; * By default, {@link ol.events.condition.singleClick} with * {@link ol.events.condition.noModifierKeys} results in a vertex deletion. * @type {ol.events.ConditionType|undefined} + * @api */ olx.interaction.ModifyOptions.prototype.deleteCondition; @@ -1962,6 +2156,7 @@ olx.interaction.ModifyOptions.prototype.deleteCondition; * Pixel tolerance for considering the pointer close enough to a segment or * vertex for editing. Default is `10` pixels. * @type {number|undefined} + * @api */ olx.interaction.ModifyOptions.prototype.pixelTolerance; @@ -1969,6 +2164,7 @@ olx.interaction.ModifyOptions.prototype.pixelTolerance; /** * FeatureOverlay style. * @type {ol.style.Style|Array.|ol.style.StyleFunction|undefined} + * @api */ olx.interaction.ModifyOptions.prototype.style; @@ -1976,6 +2172,7 @@ olx.interaction.ModifyOptions.prototype.style; /** * The features the interaction works on. * @type {ol.Collection.} + * @api */ olx.interaction.ModifyOptions.prototype.features; @@ -1990,6 +2187,7 @@ olx.interaction.MouseWheelZoomOptions; /** * Animation duration in milliseconds. Default is `250`. * @type {number|undefined} + * @api */ olx.interaction.MouseWheelZoomOptions.prototype.duration; @@ -2004,6 +2202,7 @@ olx.interaction.PinchRotateOptions; /** * Minimal angle in radians to start a rotation. Default is `0.3`. * @type {number|undefined} + * @api */ olx.interaction.PinchRotateOptions.prototype.threshold; @@ -2018,6 +2217,7 @@ olx.interaction.PinchZoomOptions; /** * Animation duration in milliseconds. Default is `400`. * @type {number|undefined} + * @api */ olx.interaction.PinchZoomOptions.prototype.duration; @@ -2040,6 +2240,7 @@ olx.interaction.SelectOptions; * By default, this is {@link ol.events.condition.never}. Use this if you want * to use different events for add and remove instead of `toggle`. * @type {ol.events.ConditionType|undefined} + * @api */ olx.interaction.SelectOptions.prototype.addCondition; @@ -2054,6 +2255,7 @@ olx.interaction.SelectOptions.prototype.addCondition; * See `toggle`, `add`, `remove` options for adding/removing extra features to/ * from the selection. * @type {ol.events.ConditionType|undefined} + * @api */ olx.interaction.SelectOptions.prototype.condition; @@ -2065,6 +2267,7 @@ olx.interaction.SelectOptions.prototype.condition; * `true` for layers that you want to be selectable. If the option is * absent, all visible layers will be considered selectable. * @type {Array.|function(ol.layer.Layer): boolean|undefined} + * @api */ olx.interaction.SelectOptions.prototype.layers; @@ -2072,6 +2275,7 @@ olx.interaction.SelectOptions.prototype.layers; /** * Style for the selected features (those in the FeatureOverlay). * @type {ol.style.Style|Array.|ol.style.StyleFunction|undefined} + * @api */ olx.interaction.SelectOptions.prototype.style; @@ -2082,6 +2286,7 @@ olx.interaction.SelectOptions.prototype.style; * By default, this is {@link ol.events.condition.never}. Use this if you want * to use different events for add and remove instead of `toggle`. * @type {ol.events.ConditionType|undefined} + * @api */ olx.interaction.SelectOptions.prototype.removeCondition; @@ -2096,6 +2301,7 @@ olx.interaction.SelectOptions.prototype.removeCondition; * See `add` and `remove` if you want to use different events instead of a * toggle. * @type {ol.events.ConditionType|undefined} + * @api */ olx.interaction.SelectOptions.prototype.toggleCondition; @@ -2118,6 +2324,7 @@ olx.layer.BaseOptions; /** * Brightness. Default is `0`. * @type {number|undefined} + * @api */ olx.layer.BaseOptions.prototype.brightness; @@ -2125,6 +2332,7 @@ olx.layer.BaseOptions.prototype.brightness; /** * Contrast. Default is `1`. * @type {number|undefined} + * @api */ olx.layer.BaseOptions.prototype.contrast; @@ -2132,6 +2340,7 @@ olx.layer.BaseOptions.prototype.contrast; /** * Hue. Default is `0`. * @type {number|undefined} + * @api */ olx.layer.BaseOptions.prototype.hue; @@ -2139,6 +2348,7 @@ olx.layer.BaseOptions.prototype.hue; /** * Opacity (0, 1). Default is `1`. * @type {number|undefined} + * @api */ olx.layer.BaseOptions.prototype.opacity; @@ -2146,6 +2356,7 @@ olx.layer.BaseOptions.prototype.opacity; /** * Saturation. Default is `1`. * @type {number|undefined} + * @api */ olx.layer.BaseOptions.prototype.saturation; @@ -2153,6 +2364,7 @@ olx.layer.BaseOptions.prototype.saturation; /** * Visibility. Default is `true`. * @type {boolean|undefined} + * @api */ olx.layer.BaseOptions.prototype.visible; @@ -2161,6 +2373,7 @@ olx.layer.BaseOptions.prototype.visible; * The bounding extent for layer rendering. The layer will not be rendered * outside of this extent. * @type {ol.Extent|undefined} + * @api */ olx.layer.BaseOptions.prototype.extent; @@ -2168,6 +2381,7 @@ olx.layer.BaseOptions.prototype.extent; /** * The minimum resolution (inclusive) at which this layer will be visible. * @type {number|undefined} + * @api */ olx.layer.BaseOptions.prototype.minResolution; @@ -2198,6 +2412,7 @@ olx.layer.LayerOptions; /** * Brightness. Default is `0`. * @type {number|undefined} + * @api */ olx.layer.LayerOptions.prototype.brightness; @@ -2205,6 +2420,7 @@ olx.layer.LayerOptions.prototype.brightness; /** * Contrast. Default is `1`. * @type {number|undefined} + * @api */ olx.layer.LayerOptions.prototype.contrast; @@ -2212,6 +2428,7 @@ olx.layer.LayerOptions.prototype.contrast; /** * Hue. Default is `0`. * @type {number|undefined} + * @api */ olx.layer.LayerOptions.prototype.hue; @@ -2219,6 +2436,7 @@ olx.layer.LayerOptions.prototype.hue; /** * Opacity (0, 1). Default is `1`. * @type {number|undefined} + * @api */ olx.layer.LayerOptions.prototype.opacity; @@ -2226,6 +2444,7 @@ olx.layer.LayerOptions.prototype.opacity; /** * Saturation. Default is `1`. * @type {number|undefined} + * @api */ olx.layer.LayerOptions.prototype.saturation; @@ -2233,6 +2452,7 @@ olx.layer.LayerOptions.prototype.saturation; /** * Source for this layer. * @type {ol.source.Source} + * @api */ olx.layer.LayerOptions.prototype.source; @@ -2240,6 +2460,7 @@ olx.layer.LayerOptions.prototype.source; /** * Visibility. Default is `true` (visible). * @type {boolean|undefined} + * @api */ olx.layer.LayerOptions.prototype.visible; @@ -2248,6 +2469,7 @@ olx.layer.LayerOptions.prototype.visible; * The bounding extent for layer rendering. The layer will not be rendered * outside of this extent. * @type {ol.Extent|undefined} + * @api */ olx.layer.LayerOptions.prototype.extent; @@ -2255,6 +2477,7 @@ olx.layer.LayerOptions.prototype.extent; /** * The minimum resolution (inclusive) at which this layer will be visible. * @type {number|undefined} + * @api */ olx.layer.LayerOptions.prototype.minResolution; @@ -2262,6 +2485,7 @@ olx.layer.LayerOptions.prototype.minResolution; /** * The maximum resolution (exclusive) below which this layer will be visible. * @type {number|undefined} + * @api */ olx.layer.LayerOptions.prototype.maxResolution; @@ -2285,6 +2509,7 @@ olx.layer.GroupOptions; /** * Brightness. Default is `0`. * @type {number|undefined} + * @api */ olx.layer.GroupOptions.prototype.brightness; @@ -2292,6 +2517,7 @@ olx.layer.GroupOptions.prototype.brightness; /** * Contrast. Default is `1`. * @type {number|undefined} + * @api */ olx.layer.GroupOptions.prototype.contrast; @@ -2299,6 +2525,7 @@ olx.layer.GroupOptions.prototype.contrast; /** * Hue. Default is `0`. * @type {number|undefined} + * @api */ olx.layer.GroupOptions.prototype.hue; @@ -2320,6 +2547,7 @@ olx.layer.GroupOptions.prototype.saturation; /** * Visibility. Default is `true`. * @type {boolean|undefined} + * @api */ olx.layer.GroupOptions.prototype.visible; @@ -2328,6 +2556,7 @@ olx.layer.GroupOptions.prototype.visible; * The bounding extent for layer rendering. The layer will not be rendered * outside of this extent. * @type {ol.Extent|undefined} + * @api */ olx.layer.GroupOptions.prototype.extent; @@ -2335,6 +2564,7 @@ olx.layer.GroupOptions.prototype.extent; /** * The minimum resolution (inclusive) at which this layer will be visible. * @type {number|undefined} + * @api */ olx.layer.GroupOptions.prototype.minResolution; @@ -2342,6 +2572,7 @@ olx.layer.GroupOptions.prototype.minResolution; /** * The maximum resolution (exclusive) below which this layer will be visible. * @type {number|undefined} + * @api */ olx.layer.GroupOptions.prototype.maxResolution; @@ -2349,6 +2580,7 @@ olx.layer.GroupOptions.prototype.maxResolution; /** * Child layers. * @type {Array.|ol.Collection.|undefined} + * @api */ olx.layer.GroupOptions.prototype.layers; @@ -2377,6 +2609,7 @@ olx.layer.HeatmapOptions; /** * Brightness. * @type {number|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.brightness; @@ -2384,6 +2617,7 @@ olx.layer.HeatmapOptions.prototype.brightness; /** * Contrast. * @type {number|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.contrast; @@ -2391,6 +2625,7 @@ olx.layer.HeatmapOptions.prototype.contrast; /** * Hue. * @type {number|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.hue; @@ -2399,6 +2634,7 @@ olx.layer.HeatmapOptions.prototype.hue; * The color gradient of the heatmap, specified as an array of CSS color * strings. Default is `['#00f', '#0ff', '#0f0', '#ff0', '#f00']`. * @type {Array.|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.gradient; @@ -2406,6 +2642,7 @@ olx.layer.HeatmapOptions.prototype.gradient; /** * Radius size in pixels. Default is `8`. * @type {number|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.radius; @@ -2413,6 +2650,7 @@ olx.layer.HeatmapOptions.prototype.radius; /** * Blur size in pixels. Default is `15`. * @type {number|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.blur; @@ -2420,6 +2658,7 @@ olx.layer.HeatmapOptions.prototype.blur; /** * Shadow size in pixels. Default is `250`. * @type {number|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.shadow; @@ -2429,6 +2668,7 @@ olx.layer.HeatmapOptions.prototype.shadow; * weight from a feature. Weight values should range from 0 to 1 (and values * outside will be clamped to that range). Default is `weight`. * @type {string|function(ol.Feature):number|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.weight; @@ -2437,6 +2677,7 @@ olx.layer.HeatmapOptions.prototype.weight; * The bounding extent for layer rendering. The layer will not be rendered * outside of this extent. * @type {ol.Extent|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.extent; @@ -2444,6 +2685,7 @@ olx.layer.HeatmapOptions.prototype.extent; /** * The minimum resolution (inclusive) at which this layer will be visible. * @type {number|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.minResolution; @@ -2451,6 +2693,7 @@ olx.layer.HeatmapOptions.prototype.minResolution; /** * The maximum resolution (exclusive) below which this layer will be visible. * @type {number|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.maxResolution; @@ -2458,6 +2701,7 @@ olx.layer.HeatmapOptions.prototype.maxResolution; /** * Opacity. 0-1. Default is `1`. * @type {number|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.opacity; @@ -2465,6 +2709,7 @@ olx.layer.HeatmapOptions.prototype.opacity; /** * Saturation. * @type {number|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.saturation; @@ -2472,6 +2717,7 @@ olx.layer.HeatmapOptions.prototype.saturation; /** * Source. * @type {ol.source.Vector} + * @api */ olx.layer.HeatmapOptions.prototype.source; @@ -2479,6 +2725,7 @@ olx.layer.HeatmapOptions.prototype.source; /** * Visibility. Default is `true` (visible). * @type {boolean|undefined} + * @api */ olx.layer.HeatmapOptions.prototype.visible; @@ -2504,6 +2751,7 @@ olx.layer.TileOptions; /** * Brightness. Default is `0`. * @type {number|undefined} + * @api */ olx.layer.TileOptions.prototype.brightness; @@ -2511,6 +2759,7 @@ olx.layer.TileOptions.prototype.brightness; /** * Contrast. Default is `1`. * @type {number|undefined} + * @api */ olx.layer.TileOptions.prototype.contrast; @@ -2518,6 +2767,7 @@ olx.layer.TileOptions.prototype.contrast; /** * Hue. Default is `0`. * @type {number|undefined} + * @api */ olx.layer.TileOptions.prototype.hue; @@ -2525,6 +2775,7 @@ olx.layer.TileOptions.prototype.hue; /** * Opacity (0, 1). Default is `1`. * @type {number|undefined} + * @api */ olx.layer.TileOptions.prototype.opacity; @@ -2532,6 +2783,7 @@ olx.layer.TileOptions.prototype.opacity; /** * Preload. * @type {number|undefined} + * @api */ olx.layer.TileOptions.prototype.preload; @@ -2539,6 +2791,7 @@ olx.layer.TileOptions.prototype.preload; /** * Saturation. Default is `1`. * @type {number|undefined} + * @api */ olx.layer.TileOptions.prototype.saturation; @@ -2546,6 +2799,7 @@ olx.layer.TileOptions.prototype.saturation; /** * Source for this layer. * @type {ol.source.Source} + * @api */ olx.layer.TileOptions.prototype.source; @@ -2553,6 +2807,7 @@ olx.layer.TileOptions.prototype.source; /** * Visibility. Default is `true` (visible). * @type {boolean|undefined} + * @api */ olx.layer.TileOptions.prototype.visible; @@ -2561,6 +2816,7 @@ olx.layer.TileOptions.prototype.visible; * The bounding extent for layer rendering. The layer will not be rendered * outside of this extent. * @type {ol.Extent|undefined} + * @api */ olx.layer.TileOptions.prototype.extent; @@ -2568,6 +2824,7 @@ olx.layer.TileOptions.prototype.extent; /** * The minimum resolution (inclusive) at which this layer will be visible. * @type {number|undefined} + * @api */ olx.layer.TileOptions.prototype.minResolution; @@ -2575,6 +2832,7 @@ olx.layer.TileOptions.prototype.minResolution; /** * The maximum resolution (exclusive) below which this layer will be visible. * @type {number|undefined} + * @api */ olx.layer.TileOptions.prototype.maxResolution; @@ -2582,6 +2840,7 @@ olx.layer.TileOptions.prototype.maxResolution; /** * Use interim tiles on error. Default is `true`. * @type {boolean|undefined} + * @api */ olx.layer.TileOptions.prototype.useInterimTilesOnError; @@ -2606,6 +2865,7 @@ olx.layer.VectorOptions; /** * Brightness. * @type {number|undefined} + * @api */ olx.layer.VectorOptions.prototype.brightness; @@ -2613,6 +2873,7 @@ olx.layer.VectorOptions.prototype.brightness; /** * Contrast. * @type {number|undefined} + * @api */ olx.layer.VectorOptions.prototype.contrast; @@ -2622,6 +2883,7 @@ olx.layer.VectorOptions.prototype.contrast; * default features are drawn in the order that they are created. Use `null` to * avoid the sort, but get an undefined draw order. * @type {function(ol.Feature, ol.Feature):number|null|undefined} + * @api */ olx.layer.VectorOptions.prototype.renderOrder; @@ -2629,6 +2891,7 @@ olx.layer.VectorOptions.prototype.renderOrder; /** * Hue. * @type {number|undefined} + * @api */ olx.layer.VectorOptions.prototype.hue; @@ -2637,6 +2900,7 @@ olx.layer.VectorOptions.prototype.hue; * The bounding extent for layer rendering. The layer will not be rendered * outside of this extent. * @type {ol.Extent|undefined} + * @api */ olx.layer.VectorOptions.prototype.extent; @@ -2644,6 +2908,7 @@ olx.layer.VectorOptions.prototype.extent; /** * The minimum resolution (inclusive) at which this layer will be visible. * @type {number|undefined} + * @api */ olx.layer.VectorOptions.prototype.minResolution; @@ -2651,6 +2916,7 @@ olx.layer.VectorOptions.prototype.minResolution; /** * The maximum resolution (exclusive) below which this layer will be visible. * @type {number|undefined} + * @api */ olx.layer.VectorOptions.prototype.maxResolution; @@ -2658,6 +2924,7 @@ olx.layer.VectorOptions.prototype.maxResolution; /** * Opacity. 0-1. Default is `1`. * @type {number|undefined} + * @api */ olx.layer.VectorOptions.prototype.opacity; @@ -2665,6 +2932,7 @@ olx.layer.VectorOptions.prototype.opacity; /** * Saturation. * @type {number|undefined} + * @api */ olx.layer.VectorOptions.prototype.saturation; @@ -2672,6 +2940,7 @@ olx.layer.VectorOptions.prototype.saturation; /** * Source. * @type {ol.source.Vector} + * @api */ olx.layer.VectorOptions.prototype.source; @@ -2680,6 +2949,7 @@ olx.layer.VectorOptions.prototype.source; * Layer style. See {@link ol.style} for default style which will be used if * this is not defined. * @type {ol.style.Style|Array.|ol.style.StyleFunction|undefined} + * @api */ olx.layer.VectorOptions.prototype.style; @@ -2687,6 +2957,7 @@ olx.layer.VectorOptions.prototype.style; /** * Visibility. Default is `true` (visible). * @type {boolean|undefined} + * @api */ olx.layer.VectorOptions.prototype.visible; @@ -2703,6 +2974,7 @@ olx.FeatureOverlayOptions; /** * Features. * @type {Array.|ol.Collection.|undefined} + * @api */ olx.FeatureOverlayOptions.prototype.features; @@ -2710,6 +2982,7 @@ olx.FeatureOverlayOptions.prototype.features; /** * Map. * @type {ol.Map|undefined} + * @api */ olx.FeatureOverlayOptions.prototype.map; @@ -2717,6 +2990,7 @@ olx.FeatureOverlayOptions.prototype.map; /** * Feature style. * @type {ol.style.Style|Array.|ol.style.StyleFunction|undefined} + * @api */ olx.FeatureOverlayOptions.prototype.style; @@ -2734,6 +3008,7 @@ olx.source.BingMapsOptions; /** * Culture code. Default is `en-us`. * @type {string|undefined} + * @api */ olx.source.BingMapsOptions.prototype.culture; @@ -2741,6 +3016,7 @@ olx.source.BingMapsOptions.prototype.culture; /** * Bing Maps API key. Get yours at http://bingmapsportal.com/. * @type {string} + * @api */ olx.source.BingMapsOptions.prototype.key; @@ -2748,6 +3024,7 @@ olx.source.BingMapsOptions.prototype.key; /** * Type of imagery. * @type {string} + * @api */ olx.source.BingMapsOptions.prototype.imagerySet; @@ -2755,6 +3032,7 @@ olx.source.BingMapsOptions.prototype.imagerySet; /** * Optional function to load a tile given a URL. * @type {ol.TileLoadFunctionType|undefined} + * @api */ olx.source.BingMapsOptions.prototype.tileLoadFunction; @@ -2774,6 +3052,7 @@ olx.source.ClusterOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.ClusterOptions.prototype.attributions; @@ -2781,6 +3060,7 @@ olx.source.ClusterOptions.prototype.attributions; /** * Minimum distance in pixels between clusters. Default is `20`. * @type {number|undefined} + * @api */ olx.source.ClusterOptions.prototype.distance; @@ -2788,6 +3068,7 @@ olx.source.ClusterOptions.prototype.distance; /** * Extent. * @type {ol.Extent|undefined} + * @api */ olx.source.ClusterOptions.prototype.extent; @@ -2795,6 +3076,7 @@ olx.source.ClusterOptions.prototype.extent; /** * Format. * @type {ol.format.Feature|undefined} + * @api */ olx.source.ClusterOptions.prototype.format; @@ -2802,6 +3084,7 @@ olx.source.ClusterOptions.prototype.format; /** * Logo. * @type {string|undefined} + * @api */ olx.source.ClusterOptions.prototype.logo; @@ -2809,6 +3092,7 @@ olx.source.ClusterOptions.prototype.logo; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.ClusterOptions.prototype.projection; @@ -2816,6 +3100,7 @@ olx.source.ClusterOptions.prototype.projection; /** * Source. * @type {ol.source.Vector} + * @api */ olx.source.ClusterOptions.prototype.source; @@ -2833,6 +3118,7 @@ olx.source.FormatVectorOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.FormatVectorOptions.prototype.attributions; @@ -2840,6 +3126,7 @@ olx.source.FormatVectorOptions.prototype.attributions; /** * Format. * @type {ol.format.Feature} + * @api */ olx.source.FormatVectorOptions.prototype.format; @@ -2847,6 +3134,7 @@ olx.source.FormatVectorOptions.prototype.format; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.FormatVectorOptions.prototype.logo; @@ -2854,6 +3142,7 @@ olx.source.FormatVectorOptions.prototype.logo; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.FormatVectorOptions.prototype.projection; @@ -2875,6 +3164,7 @@ olx.source.GeoJSONOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.GeoJSONOptions.prototype.attributions; @@ -2882,6 +3172,7 @@ olx.source.GeoJSONOptions.prototype.attributions; /** * Default projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.GeoJSONOptions.prototype.defaultProjection; @@ -2889,6 +3180,7 @@ olx.source.GeoJSONOptions.prototype.defaultProjection; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.GeoJSONOptions.prototype.logo; @@ -2896,6 +3188,7 @@ olx.source.GeoJSONOptions.prototype.logo; /** * Object. * @type {GeoJSONObject|undefined} + * @api */ olx.source.GeoJSONOptions.prototype.object; @@ -2904,6 +3197,7 @@ olx.source.GeoJSONOptions.prototype.object; * Destination projection. If provided, features will be transformed to this * projection. If not provided, features will not be transformed. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.GeoJSONOptions.prototype.projection; @@ -2911,6 +3205,7 @@ olx.source.GeoJSONOptions.prototype.projection; /** * Text. * @type {string|undefined} + * @api */ olx.source.GeoJSONOptions.prototype.text; @@ -2918,6 +3213,7 @@ olx.source.GeoJSONOptions.prototype.text; /** * URL. * @type {string|undefined} + * @api */ olx.source.GeoJSONOptions.prototype.url; @@ -2925,6 +3221,7 @@ olx.source.GeoJSONOptions.prototype.url; /** * URLs. * @type {Array.|undefined} + * @api */ olx.source.GeoJSONOptions.prototype.urls; @@ -2946,6 +3243,7 @@ olx.source.GPXOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.GPXOptions.prototype.attributions; @@ -2953,6 +3251,7 @@ olx.source.GPXOptions.prototype.attributions; /** * Document. * @type {Document|undefined} + * @api */ olx.source.GPXOptions.prototype.doc; @@ -2960,6 +3259,7 @@ olx.source.GPXOptions.prototype.doc; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.GPXOptions.prototype.logo; @@ -2967,6 +3267,7 @@ olx.source.GPXOptions.prototype.logo; /** * Node. * @type {Node|undefined} + * @api */ olx.source.GPXOptions.prototype.node; @@ -2975,6 +3276,7 @@ olx.source.GPXOptions.prototype.node; * Destination projection. If provided, features will be transformed to this * projection. If not provided, features will not be transformed. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.GPXOptions.prototype.projection; @@ -2982,6 +3284,7 @@ olx.source.GPXOptions.prototype.projection; /** * Text. * @type {string|undefined} + * @api */ olx.source.GPXOptions.prototype.text; @@ -2989,6 +3292,7 @@ olx.source.GPXOptions.prototype.text; /** * URL. * @type {string|undefined} + * @api */ olx.source.GPXOptions.prototype.url; @@ -2996,6 +3300,7 @@ olx.source.GPXOptions.prototype.url; /** * URLs. * @type {Array.|undefined} + * @api */ olx.source.GPXOptions.prototype.urls; @@ -3022,6 +3327,7 @@ olx.source.TileImageOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.TileImageOptions.prototype.attributions; @@ -3029,6 +3335,7 @@ olx.source.TileImageOptions.prototype.attributions; /** * crossOrigin setting for image requests. Default is `null`. * @type {null|string|undefined} + * @api */ olx.source.TileImageOptions.prototype.crossOrigin; @@ -3036,6 +3343,7 @@ olx.source.TileImageOptions.prototype.crossOrigin; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.TileImageOptions.prototype.logo; @@ -3043,6 +3351,7 @@ olx.source.TileImageOptions.prototype.logo; /** * Whether the layer is opaque. * @type {boolean|undefined} + * @api */ olx.source.TileImageOptions.prototype.opaque; @@ -3050,6 +3359,7 @@ olx.source.TileImageOptions.prototype.opaque; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.TileImageOptions.prototype.projection; @@ -3057,6 +3367,7 @@ olx.source.TileImageOptions.prototype.projection; /** * Source state. * @type {ol.source.State|string|undefined} + * @api */ olx.source.TileImageOptions.prototype.state; @@ -3066,6 +3377,7 @@ olx.source.TileImageOptions.prototype.state; * @type {function(new: ol.ImageTile, ol.TileCoord, * ol.TileState, string, ?string, * ol.TileLoadFunctionType)|undefined} + * @api */ olx.source.TileImageOptions.prototype.tileClass; @@ -3073,6 +3385,7 @@ olx.source.TileImageOptions.prototype.tileClass; /** * Tile grid. * @type {ol.tilegrid.TileGrid|undefined} + * @api */ olx.source.TileImageOptions.prototype.tileGrid; @@ -3080,6 +3393,7 @@ olx.source.TileImageOptions.prototype.tileGrid; /** * Optional function to load a tile given a URL. * @type {ol.TileLoadFunctionType|undefined} + * @api */ olx.source.TileImageOptions.prototype.tileLoadFunction; @@ -3090,6 +3404,7 @@ olx.source.TileImageOptions.prototype.tileLoadFunction; * by 512px images (for retina/hidpi devices) then `tilePixelRatio` * should be set to `2`. Default is `1`. * @type {number|undefined} + * @api */ olx.source.TileImageOptions.prototype.tilePixelRatio; @@ -3097,6 +3412,7 @@ olx.source.TileImageOptions.prototype.tilePixelRatio; /** * Optional function to get tile URL given a tile coordinate and the projection. * @type {ol.TileUrlFunctionType|undefined} + * @api */ olx.source.TileImageOptions.prototype.tileUrlFunction; @@ -3120,6 +3436,7 @@ olx.source.TileVectorOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.TileVectorOptions.prototype.attributions; @@ -3127,6 +3444,7 @@ olx.source.TileVectorOptions.prototype.attributions; /** * Default projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.TileVectorOptions.prototype.defaultProjection; @@ -3134,6 +3452,7 @@ olx.source.TileVectorOptions.prototype.defaultProjection; /** * Format. * @type {ol.format.Feature} + * @api */ olx.source.TileVectorOptions.prototype.format; @@ -3141,6 +3460,7 @@ olx.source.TileVectorOptions.prototype.format; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.TileVectorOptions.prototype.logo; @@ -3148,6 +3468,7 @@ olx.source.TileVectorOptions.prototype.logo; /** * Object. * @type {GeoJSONObject|undefined} + * @api */ olx.source.TileVectorOptions.prototype.object; @@ -3156,6 +3477,7 @@ olx.source.TileVectorOptions.prototype.object; * Destination projection. If provided, features will be transformed to this * projection. If not provided, features will not be transformed. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.TileVectorOptions.prototype.projection; @@ -3163,6 +3485,7 @@ olx.source.TileVectorOptions.prototype.projection; /** * Tile grid. * @type {ol.tilegrid.TileGrid} + * @api */ olx.source.TileVectorOptions.prototype.tileGrid; @@ -3171,6 +3494,7 @@ olx.source.TileVectorOptions.prototype.tileGrid; * Optional function to get tile URL given a tile coordinate and the projection. * Required if url or urls are not provided. * @type {ol.TileUrlFunctionType|undefined} + * @api */ olx.source.TileVectorOptions.prototype.tileUrlFunction; @@ -3178,6 +3502,7 @@ olx.source.TileVectorOptions.prototype.tileUrlFunction; /** * URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders. * @type {string|undefined} + * @api */ olx.source.TileVectorOptions.prototype.url; @@ -3185,6 +3510,7 @@ olx.source.TileVectorOptions.prototype.url; /** * An array of URL templates. * @type {Array.|undefined} + * @api */ olx.source.TileVectorOptions.prototype.urls; @@ -3205,6 +3531,7 @@ olx.source.TopoJSONOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.TopoJSONOptions.prototype.attributions; @@ -3212,6 +3539,7 @@ olx.source.TopoJSONOptions.prototype.attributions; /** * Default projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.TopoJSONOptions.prototype.defaultProjection; @@ -3219,6 +3547,7 @@ olx.source.TopoJSONOptions.prototype.defaultProjection; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.TopoJSONOptions.prototype.logo; @@ -3226,6 +3555,7 @@ olx.source.TopoJSONOptions.prototype.logo; /** * Object. * @type {GeoJSONObject|undefined} + * @api */ olx.source.TopoJSONOptions.prototype.object; @@ -3234,6 +3564,7 @@ olx.source.TopoJSONOptions.prototype.object; * Destination projection. If provided, features will be transformed to this * projection. If not provided, features will not be transformed. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.TopoJSONOptions.prototype.projection; @@ -3241,6 +3572,7 @@ olx.source.TopoJSONOptions.prototype.projection; /** * Text. * @type {string|undefined} + * @api */ olx.source.TopoJSONOptions.prototype.text; @@ -3248,6 +3580,7 @@ olx.source.TopoJSONOptions.prototype.text; /** * URL. * @type {string|undefined} + * @api */ olx.source.TopoJSONOptions.prototype.url; @@ -3267,6 +3600,7 @@ olx.source.IGCOptions; * Altitude mode. Possible values are `barometric`, `gps`, and `none`. Default * is `none`. * @type {ol.format.IGCZ|undefined} + * @api */ olx.source.IGCOptions.prototype.altitudeMode; @@ -3275,6 +3609,7 @@ olx.source.IGCOptions.prototype.altitudeMode; * Destination projection. If provided, features will be transformed to this * projection. If not provided, features will not be transformed. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.IGCOptions.prototype.projection; @@ -3282,6 +3617,7 @@ olx.source.IGCOptions.prototype.projection; /** * Text. * @type {string|undefined} + * @api */ olx.source.IGCOptions.prototype.text; @@ -3289,6 +3625,7 @@ olx.source.IGCOptions.prototype.text; /** * URL. * @type {string|undefined} + * @api */ olx.source.IGCOptions.prototype.url; @@ -3296,6 +3633,7 @@ olx.source.IGCOptions.prototype.url; /** * URLs. * @type {Array.|undefined} + * @api */ olx.source.IGCOptions.prototype.urls; @@ -3318,6 +3656,7 @@ olx.source.ImageMapGuideOptions; /** * The mapagent url. * @type {string|undefined} + * @api */ olx.source.ImageMapGuideOptions.prototype.url; @@ -3325,6 +3664,7 @@ olx.source.ImageMapGuideOptions.prototype.url; /** * The display resolution. Default is `96`. * @type {number|undefined} + * @api */ olx.source.ImageMapGuideOptions.prototype.displayDpi; @@ -3332,6 +3672,7 @@ olx.source.ImageMapGuideOptions.prototype.displayDpi; /** * The meters-per-unit value. Default is `1`. * @type {number|undefined} + * @api */ olx.source.ImageMapGuideOptions.prototype.metersPerUnit; @@ -3340,6 +3681,7 @@ olx.source.ImageMapGuideOptions.prototype.metersPerUnit; * Use the `ol.Map#pixelRatio` value when requesting the image from the remote * server. Default is `true`. * @type {boolean|undefined} + * @api */ olx.source.ImageMapGuideOptions.prototype.hidpi; @@ -3347,6 +3689,7 @@ olx.source.ImageMapGuideOptions.prototype.hidpi; /** * If `true`, will use `GETDYNAMICMAPOVERLAYIMAGE`. * @type {boolean|undefined} + * @api */ olx.source.ImageMapGuideOptions.prototype.useOverlay; @@ -3354,6 +3697,7 @@ olx.source.ImageMapGuideOptions.prototype.useOverlay; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.ImageMapGuideOptions.prototype.projection; @@ -3362,6 +3706,7 @@ olx.source.ImageMapGuideOptions.prototype.projection; * Ratio. `1` means image requests are the size of the map viewport, `2` means * twice the size of the map viewport, and so on. Default is `1`. * @type {number|undefined} + * @api */ olx.source.ImageMapGuideOptions.prototype.ratio; @@ -3369,6 +3714,7 @@ olx.source.ImageMapGuideOptions.prototype.ratio; /** * Resolutions. If specified, requests will be made for these resolutions only. * @type {Array.|undefined} + * @api */ olx.source.ImageMapGuideOptions.prototype.resolutions; @@ -3376,6 +3722,7 @@ olx.source.ImageMapGuideOptions.prototype.resolutions; /** * Additional parameters. * @type {Object|undefined} + * @api */ olx.source.ImageMapGuideOptions.prototype.params; @@ -3399,6 +3746,7 @@ olx.source.KMLOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.KMLOptions.prototype.attributions; @@ -3406,6 +3754,7 @@ olx.source.KMLOptions.prototype.attributions; /** * Default style. * @type {Array.|undefined} + * @api */ olx.source.KMLOptions.prototype.defaultStyle; @@ -3413,6 +3762,7 @@ olx.source.KMLOptions.prototype.defaultStyle; /** * Document. * @type {Document|undefined} + * @api */ olx.source.KMLOptions.prototype.doc; @@ -3420,6 +3770,7 @@ olx.source.KMLOptions.prototype.doc; /** * Extract styles from the KML document. Default is `true`. * @type {boolean|undefined} + * @api */ olx.source.KMLOptions.prototype.extractStyles; @@ -3427,6 +3778,7 @@ olx.source.KMLOptions.prototype.extractStyles; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.KMLOptions.prototype.logo; @@ -3434,6 +3786,7 @@ olx.source.KMLOptions.prototype.logo; /** * Node. * @type {Node|undefined} + * @api */ olx.source.KMLOptions.prototype.node; @@ -3442,6 +3795,7 @@ olx.source.KMLOptions.prototype.node; * Destination projection. If provided, features will be transformed to this * projection. If not provided, features will not be transformed. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.KMLOptions.prototype.projection; @@ -3449,6 +3803,7 @@ olx.source.KMLOptions.prototype.projection; /** * Text. * @type {string|undefined} + * @api */ olx.source.KMLOptions.prototype.text; @@ -3456,6 +3811,7 @@ olx.source.KMLOptions.prototype.text; /** * URL. * @type {string|undefined} + * @api */ olx.source.KMLOptions.prototype.url; @@ -3463,6 +3819,7 @@ olx.source.KMLOptions.prototype.url; /** * URLs. * @type {Array.|undefined} + * @api */ olx.source.KMLOptions.prototype.urls; @@ -3478,6 +3835,7 @@ olx.source.MapQuestOptions; /** * Layer. Possible values are `osm`, `sat`, and `hyb`. * @type {string} + * @api */ olx.source.MapQuestOptions.prototype.layer; @@ -3485,6 +3843,7 @@ olx.source.MapQuestOptions.prototype.layer; /** * Optional function to load a tile given a URL. * @type {ol.TileLoadFunctionType|undefined} + * @api */ olx.source.MapQuestOptions.prototype.tileLoadFunction; @@ -3500,6 +3859,7 @@ olx.source.TileDebugOptions; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.TileDebugOptions.prototype.projection; @@ -3507,6 +3867,7 @@ olx.source.TileDebugOptions.prototype.projection; /** * Tile grid. * @type {ol.tilegrid.TileGrid|undefined} + * @api */ olx.source.TileDebugOptions.prototype.tileGrid; @@ -3525,6 +3886,7 @@ olx.source.OSMOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.OSMOptions.prototype.attributions; @@ -3532,6 +3894,7 @@ olx.source.OSMOptions.prototype.attributions; /** * crossOrigin setting for image requests. Default is `anonymous`. * @type {null|string|undefined} + * @api */ olx.source.OSMOptions.prototype.crossOrigin; @@ -3539,6 +3902,7 @@ olx.source.OSMOptions.prototype.crossOrigin; /** * Max zoom. * @type {number|undefined} + * @api */ olx.source.OSMOptions.prototype.maxZoom; @@ -3546,6 +3910,7 @@ olx.source.OSMOptions.prototype.maxZoom; /** * Optional function to load a tile given a URL. * @type {ol.TileLoadFunctionType|undefined} + * @api */ olx.source.OSMOptions.prototype.tileLoadFunction; @@ -3554,6 +3919,7 @@ olx.source.OSMOptions.prototype.tileLoadFunction; * URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders. * Default is `//{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png`. * @type {string|undefined} + * @api */ olx.source.OSMOptions.prototype.url; @@ -3577,6 +3943,7 @@ olx.source.OSMXMLOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.OSMXMLOptions.prototype.attributions; @@ -3584,6 +3951,7 @@ olx.source.OSMXMLOptions.prototype.attributions; /** * Default style. * @type {Array.|undefined} + * @api */ olx.source.OSMXMLOptions.prototype.defaultStyle; @@ -3591,6 +3959,7 @@ olx.source.OSMXMLOptions.prototype.defaultStyle; /** * Document. * @type {Document|undefined} + * @api */ olx.source.OSMXMLOptions.prototype.doc; @@ -3598,6 +3967,7 @@ olx.source.OSMXMLOptions.prototype.doc; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.OSMXMLOptions.prototype.logo; @@ -3605,6 +3975,7 @@ olx.source.OSMXMLOptions.prototype.logo; /** * Node. * @type {Node|undefined} + * @api */ olx.source.OSMXMLOptions.prototype.node; @@ -3612,6 +3983,7 @@ olx.source.OSMXMLOptions.prototype.node; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.OSMXMLOptions.prototype.projection; @@ -3619,6 +3991,7 @@ olx.source.OSMXMLOptions.prototype.projection; /** * Re-project to. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.OSMXMLOptions.prototype.reprojectTo; @@ -3626,6 +3999,7 @@ olx.source.OSMXMLOptions.prototype.reprojectTo; /** * Text. * @type {string|undefined} + * @api */ olx.source.OSMXMLOptions.prototype.text; @@ -3633,6 +4007,7 @@ olx.source.OSMXMLOptions.prototype.text; /** * URL. * @type {string|undefined} + * @api */ olx.source.OSMXMLOptions.prototype.url; @@ -3640,6 +4015,7 @@ olx.source.OSMXMLOptions.prototype.url; /** * URLs. * @type {Array.|undefined} + * @api */ olx.source.OSMXMLOptions.prototype.urls; @@ -3660,6 +4036,7 @@ olx.source.ImageCanvasOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.ImageCanvasOptions.prototype.attributions; @@ -3674,6 +4051,7 @@ olx.source.ImageCanvasOptions.prototype.attributions; * `dispatchChangeEvent` should be called on the source for the source to * invalidate the current cached image. * @type {ol.CanvasFunctionType} + * @api */ olx.source.ImageCanvasOptions.prototype.canvasFunction; @@ -3681,6 +4059,7 @@ olx.source.ImageCanvasOptions.prototype.canvasFunction; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.ImageCanvasOptions.prototype.logo; @@ -3688,6 +4067,7 @@ olx.source.ImageCanvasOptions.prototype.logo; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.ImageCanvasOptions.prototype.projection; @@ -3696,6 +4076,7 @@ olx.source.ImageCanvasOptions.prototype.projection; * Ratio. 1 means canvases are the size of the map viewport, 2 means twice the * size of the map viewport, and so on. Default is `1.5`. * @type {number|undefined} + * @api */ olx.source.ImageCanvasOptions.prototype.ratio; @@ -3704,6 +4085,7 @@ olx.source.ImageCanvasOptions.prototype.ratio; * Resolutions. If specified, new canvases will be created for these resolutions * only. * @type {Array.|undefined} + * @api */ olx.source.ImageCanvasOptions.prototype.resolutions; @@ -3711,6 +4093,7 @@ olx.source.ImageCanvasOptions.prototype.resolutions; /** * Source state. * @type {ol.source.State|string|undefined} + * @api */ olx.source.ImageCanvasOptions.prototype.state; @@ -3731,6 +4114,7 @@ olx.source.ImageVectorOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.ImageVectorOptions.prototype.attributions; @@ -3738,6 +4122,7 @@ olx.source.ImageVectorOptions.prototype.attributions; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.ImageVectorOptions.prototype.logo; @@ -3745,6 +4130,7 @@ olx.source.ImageVectorOptions.prototype.logo; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.ImageVectorOptions.prototype.projection; @@ -3753,6 +4139,7 @@ olx.source.ImageVectorOptions.prototype.projection; * Ratio. 1 means canvases are the size of the map viewport, 2 means twice the * size of the map viewport, and so on. Default is `1.5`. * @type {number|undefined} + * @api */ olx.source.ImageVectorOptions.prototype.ratio; @@ -3761,6 +4148,7 @@ olx.source.ImageVectorOptions.prototype.ratio; * Resolutions. If specified, new canvases will be created for these resolutions * only. * @type {Array.|undefined} + * @api */ olx.source.ImageVectorOptions.prototype.resolutions; @@ -3769,6 +4157,7 @@ olx.source.ImageVectorOptions.prototype.resolutions; * The vector source from which the vector features drawn in canvas elements are * read. * @type {ol.source.Vector} + * @api */ olx.source.ImageVectorOptions.prototype.source; @@ -3776,6 +4165,7 @@ olx.source.ImageVectorOptions.prototype.source; /** * Style to use when rendering features to the canvas. * @type {ol.style.Style|Array.|ol.style.StyleFunction|undefined} + * @api */ olx.source.ImageVectorOptions.prototype.style; @@ -3799,6 +4189,7 @@ olx.source.ImageWMSOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.ImageWMSOptions.prototype.attributions; @@ -3806,6 +4197,7 @@ olx.source.ImageWMSOptions.prototype.attributions; /** * crossOrigin setting for image requests. * @type {null|string|undefined} + * @api */ olx.source.ImageWMSOptions.prototype.crossOrigin; @@ -3814,6 +4206,7 @@ olx.source.ImageWMSOptions.prototype.crossOrigin; * Use the `ol.Map#pixelRatio` value when requesting the image from the remote * server. Default is `true`. * @type {boolean|undefined} + * @api */ olx.source.ImageWMSOptions.prototype.hidpi; @@ -3822,6 +4215,7 @@ olx.source.ImageWMSOptions.prototype.hidpi; * The type of the remote WMS server: `mapserver`, `geoserver` or `qgis`. Only * needed if `hidpi` is `true`. Default is `undefined`. * @type {ol.source.wms.ServerType|string|undefined} + * @api */ olx.source.ImageWMSOptions.prototype.serverType; @@ -3829,6 +4223,7 @@ olx.source.ImageWMSOptions.prototype.serverType; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.ImageWMSOptions.prototype.logo; @@ -3838,6 +4233,7 @@ olx.source.ImageWMSOptions.prototype.logo; * `''` by default. `VERSION` is `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX` * and `CRS` (`SRS` for WMS version < 1.3.0) will be set dynamically. * @type {Object.} + * @api */ olx.source.ImageWMSOptions.prototype.params; @@ -3845,6 +4241,7 @@ olx.source.ImageWMSOptions.prototype.params; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.ImageWMSOptions.prototype.projection; @@ -3853,6 +4250,7 @@ olx.source.ImageWMSOptions.prototype.projection; * Ratio. `1` means image requests are the size of the map viewport, `2` means * twice the size of the map viewport, and so on. Default is `1.5`. * @type {number|undefined} + * @api */ olx.source.ImageWMSOptions.prototype.ratio; @@ -3860,6 +4258,7 @@ olx.source.ImageWMSOptions.prototype.ratio; /** * Resolutions. If specified, requests will be made for these resolutions only. * @type {Array.|undefined} + * @api */ olx.source.ImageWMSOptions.prototype.resolutions; @@ -3867,6 +4266,7 @@ olx.source.ImageWMSOptions.prototype.resolutions; /** * WMS service URL. * @type {string|undefined} + * @api */ olx.source.ImageWMSOptions.prototype.url; @@ -3886,6 +4286,7 @@ olx.source.StamenOptions; /** * Layer. * @type {string} + * @api */ olx.source.StamenOptions.prototype.layer; @@ -3893,6 +4294,7 @@ olx.source.StamenOptions.prototype.layer; /** * Minimum zoom. * @type {number|undefined} + * @api */ olx.source.StamenOptions.prototype.minZoom; @@ -3900,6 +4302,7 @@ olx.source.StamenOptions.prototype.minZoom; /** * Maximum zoom. * @type {number|undefined} + * @api */ olx.source.StamenOptions.prototype.maxZoom; @@ -3907,6 +4310,7 @@ olx.source.StamenOptions.prototype.maxZoom; /** * Whether the layer is opaque. * @type {boolean|undefined} + * @api */ olx.source.StamenOptions.prototype.opaque; @@ -3914,6 +4318,7 @@ olx.source.StamenOptions.prototype.opaque; /** * Optional function to load a tile given a URL. * @type {ol.TileLoadFunctionType|undefined} + * @api */ olx.source.StamenOptions.prototype.tileLoadFunction; @@ -3921,6 +4326,7 @@ olx.source.StamenOptions.prototype.tileLoadFunction; /** * URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders. * @type {string|undefined} + * @api */ olx.source.StamenOptions.prototype.url; @@ -3941,6 +4347,7 @@ olx.source.ImageStaticOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.ImageStaticOptions.prototype.attributions; @@ -3948,6 +4355,7 @@ olx.source.ImageStaticOptions.prototype.attributions; /** * crossOrigin setting for image requests. * @type {null|string|undefined} + * @api */ olx.source.ImageStaticOptions.prototype.crossOrigin; @@ -3955,6 +4363,7 @@ olx.source.ImageStaticOptions.prototype.crossOrigin; /** * Extent of the image. * @type {ol.Extent|undefined} + * @api */ olx.source.ImageStaticOptions.prototype.imageExtent; @@ -3962,6 +4371,7 @@ olx.source.ImageStaticOptions.prototype.imageExtent; /** * Size of the image. * @type {ol.Size|undefined} + * @api */ olx.source.ImageStaticOptions.prototype.imageSize; @@ -3969,6 +4379,7 @@ olx.source.ImageStaticOptions.prototype.imageSize; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.ImageStaticOptions.prototype.logo; @@ -3976,6 +4387,7 @@ olx.source.ImageStaticOptions.prototype.logo; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.ImageStaticOptions.prototype.projection; @@ -3983,6 +4395,7 @@ olx.source.ImageStaticOptions.prototype.projection; /** * Url. * @type {string} + * @api */ olx.source.ImageStaticOptions.prototype.url; @@ -4002,6 +4415,7 @@ olx.source.ServerVectorOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.ServerVectorOptions.prototype.attributions; @@ -4009,6 +4423,7 @@ olx.source.ServerVectorOptions.prototype.attributions; /** * Format. * @type {ol.format.Feature} + * @api */ olx.source.ServerVectorOptions.prototype.format; @@ -4016,6 +4431,7 @@ olx.source.ServerVectorOptions.prototype.format; /** * Loading function. * @type {function(this: ol.source.ServerVector, ol.Extent, number, ol.proj.Projection)} + * @api */ olx.source.ServerVectorOptions.prototype.loader; @@ -4024,6 +4440,7 @@ olx.source.ServerVectorOptions.prototype.loader; * Loading strategy. An {@link ol.loadingstrategy} or a custom function. * Default is {@link ol.loadingstrategy.bbox}. * @type {function(ol.Extent, number): Array.|undefined} + * @api */ olx.source.ServerVectorOptions.prototype.strategy; @@ -4031,6 +4448,7 @@ olx.source.ServerVectorOptions.prototype.strategy; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.ServerVectorOptions.prototype.logo; @@ -4038,6 +4456,7 @@ olx.source.ServerVectorOptions.prototype.logo; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.ServerVectorOptions.prototype.projection; @@ -4054,6 +4473,7 @@ olx.source.TileJSONOptions; /** * crossOrigin setting for image requests. * @type {null|string|undefined} + * @api */ olx.source.TileJSONOptions.prototype.crossOrigin; @@ -4061,6 +4481,7 @@ olx.source.TileJSONOptions.prototype.crossOrigin; /** * Optional function to load a tile given a URL. * @type {ol.TileLoadFunctionType|undefined} + * @api */ olx.source.TileJSONOptions.prototype.tileLoadFunction; @@ -4068,6 +4489,7 @@ olx.source.TileJSONOptions.prototype.tileLoadFunction; /** * URL to the TileJSON file. * @type {string} + * @api */ olx.source.TileJSONOptions.prototype.url; @@ -4094,6 +4516,7 @@ olx.source.TileWMSOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.TileWMSOptions.prototype.attributions; @@ -4103,6 +4526,7 @@ olx.source.TileWMSOptions.prototype.attributions; * `''` by default. `VERSION` is `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX` * and `CRS` (`SRS` for WMS version < 1.3.0) will be set dynamically. * @type {Object.} + * @api */ olx.source.TileWMSOptions.prototype.params; @@ -4110,6 +4534,7 @@ olx.source.TileWMSOptions.prototype.params; /** * crossOrigin setting for image requests. * @type {null|string|undefined} + * @api */ olx.source.TileWMSOptions.prototype.crossOrigin; @@ -4124,6 +4549,7 @@ olx.source.TileWMSOptions.prototype.crossOrigin; * example, MapServer has a `tile_map_edge_buffer` configuration parameter for * this. See http://mapserver.org/output/tile_mode.html. * @type {number|undefined} + * @api */ olx.source.TileWMSOptions.prototype.gutter; @@ -4132,6 +4558,7 @@ olx.source.TileWMSOptions.prototype.gutter; * Use the `ol.Map#pixelRatio` value when requesting the image from the remote * server. Default is `true`. * @type {boolean|undefined} + * @api */ olx.source.TileWMSOptions.prototype.hidpi; @@ -4139,6 +4566,7 @@ olx.source.TileWMSOptions.prototype.hidpi; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.TileWMSOptions.prototype.logo; @@ -4150,6 +4578,7 @@ olx.source.TileWMSOptions.prototype.logo; * extent, the grid will be based on that; if not, a grid based on a global * extent with origin at 0,0 will be used. * @type {ol.tilegrid.TileGrid|undefined} + * @api */ olx.source.TileWMSOptions.prototype.tileGrid; @@ -4157,6 +4586,7 @@ olx.source.TileWMSOptions.prototype.tileGrid; /** * Maximum zoom. * @type {number|undefined} + * @api */ olx.source.TileWMSOptions.prototype.maxZoom; @@ -4164,6 +4594,7 @@ olx.source.TileWMSOptions.prototype.maxZoom; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.TileWMSOptions.prototype.projection; @@ -4172,6 +4603,7 @@ olx.source.TileWMSOptions.prototype.projection; * The type of the remote WMS server. Currently only used when `hidpi` is * `true`. Default is `undefined`. * @type {ol.source.wms.ServerType|string|undefined} + * @api */ olx.source.TileWMSOptions.prototype.serverType; @@ -4179,6 +4611,7 @@ olx.source.TileWMSOptions.prototype.serverType; /** * Optional function to load a tile given a URL. * @type {ol.TileLoadFunctionType|undefined} + * @api */ olx.source.TileWMSOptions.prototype.tileLoadFunction; @@ -4186,6 +4619,7 @@ olx.source.TileWMSOptions.prototype.tileLoadFunction; /** * WMS service URL. * @type {string|undefined} + * @api */ olx.source.TileWMSOptions.prototype.url; @@ -4194,6 +4628,7 @@ olx.source.TileWMSOptions.prototype.url; * WMS service urls. Use this instead of `url` when the WMS supports multiple * urls for GetMap requests. * @type {Array.|undefined} + * @api */ olx.source.TileWMSOptions.prototype.urls; @@ -4212,6 +4647,7 @@ olx.source.VectorOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.VectorOptions.prototype.attributions; @@ -4219,6 +4655,7 @@ olx.source.VectorOptions.prototype.attributions; /** * Features. * @type {Array.|undefined} + * @api */ olx.source.VectorOptions.prototype.features; @@ -4226,6 +4663,7 @@ olx.source.VectorOptions.prototype.features; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.VectorOptions.prototype.logo; @@ -4233,6 +4671,7 @@ olx.source.VectorOptions.prototype.logo; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.VectorOptions.prototype.projection; @@ -4240,6 +4679,7 @@ olx.source.VectorOptions.prototype.projection; /** * State. * @type {ol.source.State|string|undefined} + * @api */ olx.source.VectorOptions.prototype.state; @@ -4264,6 +4704,7 @@ olx.source.StaticVectorOptions; /** * Array buffer. * @type {ArrayBuffer|undefined} + * @api */ olx.source.StaticVectorOptions.prototype.arrayBuffer; @@ -4271,6 +4712,7 @@ olx.source.StaticVectorOptions.prototype.arrayBuffer; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.StaticVectorOptions.prototype.attributions; @@ -4278,6 +4720,7 @@ olx.source.StaticVectorOptions.prototype.attributions; /** * Document. * @type {Document|undefined} + * @api */ olx.source.StaticVectorOptions.prototype.doc; @@ -4285,6 +4728,7 @@ olx.source.StaticVectorOptions.prototype.doc; /** * Format. * @type {ol.format.Feature} + * @api */ olx.source.StaticVectorOptions.prototype.format; @@ -4292,6 +4736,7 @@ olx.source.StaticVectorOptions.prototype.format; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.StaticVectorOptions.prototype.logo; @@ -4299,6 +4744,7 @@ olx.source.StaticVectorOptions.prototype.logo; /** * Node. * @type {Node|undefined} + * @api */ olx.source.StaticVectorOptions.prototype.node; @@ -4306,6 +4752,7 @@ olx.source.StaticVectorOptions.prototype.node; /** * Object. * @type {Object|undefined} + * @api */ olx.source.StaticVectorOptions.prototype.object; @@ -4313,6 +4760,7 @@ olx.source.StaticVectorOptions.prototype.object; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.StaticVectorOptions.prototype.projection; @@ -4320,6 +4768,7 @@ olx.source.StaticVectorOptions.prototype.projection; /** * Text. * @type {string|undefined} + * @api */ olx.source.StaticVectorOptions.prototype.text; @@ -4327,6 +4776,7 @@ olx.source.StaticVectorOptions.prototype.text; /** * URL. * @type {string|undefined} + * @api */ olx.source.StaticVectorOptions.prototype.url; @@ -4334,6 +4784,7 @@ olx.source.StaticVectorOptions.prototype.url; /** * URLs. * @type {Array.|undefined} + * @api */ olx.source.StaticVectorOptions.prototype.urls; @@ -4364,6 +4815,7 @@ olx.source.WMTSOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.WMTSOptions.prototype.attributions; @@ -4371,6 +4823,7 @@ olx.source.WMTSOptions.prototype.attributions; /** * crossOrigin setting for image requests. * @type {string|null|undefined} + * @api */ olx.source.WMTSOptions.prototype.crossOrigin; @@ -4378,6 +4831,7 @@ olx.source.WMTSOptions.prototype.crossOrigin; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.WMTSOptions.prototype.logo; @@ -4385,6 +4839,7 @@ olx.source.WMTSOptions.prototype.logo; /** * Tile grid. * @type {ol.tilegrid.WMTS} + * @api */ olx.source.WMTSOptions.prototype.tileGrid; @@ -4392,6 +4847,7 @@ olx.source.WMTSOptions.prototype.tileGrid; /** * Projection. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.WMTSOptions.prototype.projection; @@ -4399,6 +4855,7 @@ olx.source.WMTSOptions.prototype.projection; /** * Request encoding. * @type {ol.source.WMTSRequestEncoding|undefined} + * @api */ olx.source.WMTSOptions.prototype.requestEncoding; @@ -4406,6 +4863,7 @@ olx.source.WMTSOptions.prototype.requestEncoding; /** * Layer. * @type {string} + * @api */ olx.source.WMTSOptions.prototype.layer; @@ -4413,6 +4871,7 @@ olx.source.WMTSOptions.prototype.layer; /** * Style. * @type {string} + * @api */ olx.source.WMTSOptions.prototype.style; @@ -4423,6 +4882,7 @@ olx.source.WMTSOptions.prototype.style; * by 512px images (for retina/hidpi devices) then `tilePixelRatio` * should be set to `2`. Default is `1`. * @type {number|undefined} + * @api */ olx.source.WMTSOptions.prototype.tilePixelRatio; @@ -4430,6 +4890,7 @@ olx.source.WMTSOptions.prototype.tilePixelRatio; /** * WMTS version. Default is `1.0.0`. * @type {string|undefined} + * @api */ olx.source.WMTSOptions.prototype.version; @@ -4437,6 +4898,7 @@ olx.source.WMTSOptions.prototype.version; /** * Image format. Default is `image/jpeg`. * @type {string|undefined} + * @api */ olx.source.WMTSOptions.prototype.format; @@ -4444,6 +4906,7 @@ olx.source.WMTSOptions.prototype.format; /** * Matrix set. * @type {string} + * @api */ olx.source.WMTSOptions.prototype.matrixSet; @@ -4451,6 +4914,7 @@ olx.source.WMTSOptions.prototype.matrixSet; /** * Dimensions. * @type {Object|undefined} + * @api */ olx.source.WMTSOptions.prototype.dimensions; @@ -4458,6 +4922,7 @@ olx.source.WMTSOptions.prototype.dimensions; /** * URL. * @type {string|undefined} + * @api */ olx.source.WMTSOptions.prototype.url; @@ -4465,6 +4930,7 @@ olx.source.WMTSOptions.prototype.url; /** * Maximum zoom. * @type {number|undefined} + * @api */ olx.source.WMTSOptions.prototype.maxZoom; @@ -4472,6 +4938,7 @@ olx.source.WMTSOptions.prototype.maxZoom; /** * Optional function to load a tile given a URL. * @type {ol.TileLoadFunctionType|undefined} + * @api */ olx.source.WMTSOptions.prototype.tileLoadFunction; @@ -4479,6 +4946,7 @@ olx.source.WMTSOptions.prototype.tileLoadFunction; /** * Urls. * @type {Array.|undefined} + * @api */ olx.source.WMTSOptions.prototype.urls; @@ -4504,6 +4972,7 @@ olx.source.XYZOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.XYZOptions.prototype.attributions; @@ -4511,6 +4980,7 @@ olx.source.XYZOptions.prototype.attributions; /** * Cross origin setting for image requests. * @type {null|string|undefined} + * @api */ olx.source.XYZOptions.prototype.crossOrigin; @@ -4518,6 +4988,7 @@ olx.source.XYZOptions.prototype.crossOrigin; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.XYZOptions.prototype.logo; @@ -4525,6 +4996,7 @@ olx.source.XYZOptions.prototype.logo; /** * Projection. Default is `EPSG:3857`. * @type {ol.proj.ProjectionLike} + * @api */ olx.source.XYZOptions.prototype.projection; @@ -4532,6 +5004,7 @@ olx.source.XYZOptions.prototype.projection; /** * Optional max zoom level. Default is `18`. * @type {number|undefined} + * @api */ olx.source.XYZOptions.prototype.maxZoom; @@ -4539,6 +5012,7 @@ olx.source.XYZOptions.prototype.maxZoom; /** * Unsupported (TODO: remove this). * @type {number|undefined} + * @api */ olx.source.XYZOptions.prototype.minZoom; @@ -4546,6 +5020,7 @@ olx.source.XYZOptions.prototype.minZoom; /** * Optional function to load a tile given a URL. * @type {ol.TileLoadFunctionType|undefined} + * @api */ olx.source.XYZOptions.prototype.tileLoadFunction; @@ -4556,6 +5031,7 @@ olx.source.XYZOptions.prototype.tileLoadFunction; * by 512px images (for retina/hidpi devices) then `tilePixelRatio` * should be set to `2`. Default is `1`. * @type {number|undefined} + * @api */ olx.source.XYZOptions.prototype.tilePixelRatio; @@ -4564,6 +5040,7 @@ olx.source.XYZOptions.prototype.tilePixelRatio; * Optional function to get tile URL given a tile coordinate and the projection. * Required if url or urls are not provided. * @type {ol.TileUrlFunctionType|undefined} + * @api */ olx.source.XYZOptions.prototype.tileUrlFunction; @@ -4571,6 +5048,7 @@ olx.source.XYZOptions.prototype.tileUrlFunction; /** * URL template. Must include `{x}`, `{y}` or `{-y}`, and `{z}` placeholders. * @type {string|undefined} + * @api */ olx.source.XYZOptions.prototype.url; @@ -4578,6 +5056,7 @@ olx.source.XYZOptions.prototype.url; /** * An array of URL templates. * @type {Array.|undefined} + * @api */ olx.source.XYZOptions.prototype.urls; @@ -4585,6 +5064,7 @@ olx.source.XYZOptions.prototype.urls; /** * Whether to wrap the world horizontally. Default is `true`. * @type {boolean|undefined} + * @api */ olx.source.XYZOptions.prototype.wrapX; @@ -4604,6 +5084,7 @@ olx.source.ZoomifyOptions; /** * Attributions. * @type {Array.|undefined} + * @api */ olx.source.ZoomifyOptions.prototype.attributions; @@ -4611,6 +5092,7 @@ olx.source.ZoomifyOptions.prototype.attributions; /** * Cross origin setting for image requests. * @type {null|string|undefined} + * @api */ olx.source.ZoomifyOptions.prototype.crossOrigin; @@ -4618,6 +5100,7 @@ olx.source.ZoomifyOptions.prototype.crossOrigin; /** * Logo. * @type {string|olx.LogoOptions|undefined} + * @api */ olx.source.ZoomifyOptions.prototype.logo; @@ -4625,6 +5108,7 @@ olx.source.ZoomifyOptions.prototype.logo; /** * Prefix of URL template. * @type {!string} + * @api */ olx.source.ZoomifyOptions.prototype.url; @@ -4632,6 +5116,7 @@ olx.source.ZoomifyOptions.prototype.url; /** * Tier size calculation method: `default` or `truncated`. * @type {string|undefined} + * @api */ olx.source.ZoomifyOptions.prototype.tierSizeCalculation; @@ -4639,6 +5124,7 @@ olx.source.ZoomifyOptions.prototype.tierSizeCalculation; /** * Size of the image. * @type {ol.Size} + * @api */ olx.source.ZoomifyOptions.prototype.size; @@ -4656,6 +5142,7 @@ olx.style.CircleOptions; /** * Fill style. * @type {ol.style.Fill|undefined} + * @api */ olx.style.CircleOptions.prototype.fill; @@ -4663,6 +5150,7 @@ olx.style.CircleOptions.prototype.fill; /** * Circle radius. * @type {number} + * @api */ olx.style.CircleOptions.prototype.radius; @@ -4676,6 +5164,7 @@ olx.style.CircleOptions.prototype.radius; * position is animated. Without it, the circle may jitter noticeably. * Default value is `true`. * @type {boolean|undefined} + * @api */ olx.style.CircleOptions.prototype.snapToPixel; @@ -4683,6 +5172,7 @@ olx.style.CircleOptions.prototype.snapToPixel; /** * Stroke style. * @type {ol.style.Stroke|undefined} + * @api */ olx.style.CircleOptions.prototype.stroke; @@ -4698,6 +5188,7 @@ olx.style.FillOptions; * Color. See {@link ol.color} for possible formats. Default null; if null, * the Canvas/renderer default black will be used. * @type {ol.Color|string|undefined} + * @api */ olx.style.FillOptions.prototype.color; @@ -4725,6 +5216,7 @@ olx.style.IconOptions; /** * Anchor. Default value is `[0.5, 0.5]` (icon center). * @type {Array.|undefined} + * @api */ olx.style.IconOptions.prototype.anchor; @@ -4733,6 +5225,7 @@ olx.style.IconOptions.prototype.anchor; * Origin of the anchor: `bottom-left`, `bottom-right`, `top-left` or * `top-right`. Default is `top-left`. * @type {ol.style.IconOrigin|undefined} + * @api */ olx.style.IconOptions.prototype.anchorOrigin; @@ -4742,6 +5235,7 @@ olx.style.IconOptions.prototype.anchorOrigin; * indicates the x value is a fraction of the icon. A value of `'pixels'` * indicates the x value in pixels. Default is `'fraction'`. * @type {ol.style.IconAnchorUnits|undefined} + * @api */ olx.style.IconOptions.prototype.anchorXUnits; @@ -4751,6 +5245,7 @@ olx.style.IconOptions.prototype.anchorXUnits; * indicates the y value is a fraction of the icon. A value of `'pixels'` * indicates the y value in pixels. Default is `'fraction'`. * @type {ol.style.IconAnchorUnits|undefined} + * @api */ olx.style.IconOptions.prototype.anchorYUnits; @@ -4758,6 +5253,7 @@ olx.style.IconOptions.prototype.anchorYUnits; /** * crossOrigin setting for image. * @type {null|string|undefined} + * @api */ olx.style.IconOptions.prototype.crossOrigin; @@ -4766,6 +5262,7 @@ olx.style.IconOptions.prototype.crossOrigin; * Image object for the icon. If the `src` option is not provided then the * provided image must already be loaded. * @type {Image|undefined} + * @api */ olx.style.IconOptions.prototype.img; @@ -4775,6 +5272,7 @@ olx.style.IconOptions.prototype.img; * define the sub-rectangle to use from the original icon image. Default value * is `[0, 0]`. * @type {Array.|undefined} + * @api */ olx.style.IconOptions.prototype.offset; @@ -4783,6 +5281,7 @@ olx.style.IconOptions.prototype.offset; * Origin of the offset: `bottom-left`, `bottom-right`, `top-left` or * `top-right`. Default is `top-left`. * @type {ol.style.IconOrigin|undefined} + * @api */ olx.style.IconOptions.prototype.offsetOrigin; @@ -4790,6 +5289,7 @@ olx.style.IconOptions.prototype.offsetOrigin; /** * Scale. * @type {number|undefined} + * @api */ olx.style.IconOptions.prototype.scale; @@ -4803,6 +5303,7 @@ olx.style.IconOptions.prototype.scale; * is animated. Without it, the icon may jitter noticeably. Default * value is `true`. * @type {boolean|undefined} + * @api */ olx.style.IconOptions.prototype.snapToPixel; @@ -4810,6 +5311,7 @@ olx.style.IconOptions.prototype.snapToPixel; /** * Whether to rotate the icon with the view. Default is `false`. * @type {boolean|undefined} + * @api */ olx.style.IconOptions.prototype.rotateWithView; @@ -4817,6 +5319,7 @@ olx.style.IconOptions.prototype.rotateWithView; /** * Rotation. * @type {number|undefined} + * @api */ olx.style.IconOptions.prototype.rotation; @@ -4824,6 +5327,7 @@ olx.style.IconOptions.prototype.rotation; /** * Icon size in pixel. * @type {ol.Size|undefined} + * @api */ olx.style.IconOptions.prototype.size; @@ -4831,6 +5335,7 @@ olx.style.IconOptions.prototype.size; /** * Image source URI. * @type {string} + * @api */ olx.style.IconOptions.prototype.src; @@ -4851,6 +5356,7 @@ olx.style.StrokeOptions; * Color. See {@link ol.color} for possible formats. Default null; if null, * the Canvas/renderer default black will be used. * @type {ol.Color|string|undefined} + * @api */ olx.style.StrokeOptions.prototype.color; @@ -4858,6 +5364,7 @@ olx.style.StrokeOptions.prototype.color; /** * Line cap style: `butt`, `round`, or `square`. Default is `round`. * @type {string|undefined} + * @api */ olx.style.StrokeOptions.prototype.lineCap; @@ -4865,6 +5372,7 @@ olx.style.StrokeOptions.prototype.lineCap; /** * Line join style: `bevel`, `round`, or `miter`. Default is `round`. * @type {string|undefined} + * @api */ olx.style.StrokeOptions.prototype.lineJoin; @@ -4872,6 +5380,7 @@ olx.style.StrokeOptions.prototype.lineJoin; /** * Line dash pattern. Default is `undefined` (no dash). * @type {Array.|undefined} + * @api */ olx.style.StrokeOptions.prototype.lineDash; @@ -4879,6 +5388,7 @@ olx.style.StrokeOptions.prototype.lineDash; /** * Miter limit. Default is `10`. * @type {number|undefined} + * @api */ olx.style.StrokeOptions.prototype.miterLimit; @@ -4886,6 +5396,7 @@ olx.style.StrokeOptions.prototype.miterLimit; /** * Width. * @type {number|undefined} + * @api */ olx.style.StrokeOptions.prototype.width; @@ -4909,6 +5420,7 @@ olx.style.TextOptions; /** * Font. * @type {string|undefined} + * @api */ olx.style.TextOptions.prototype.font; @@ -4917,6 +5429,7 @@ olx.style.TextOptions.prototype.font; * Horizontal text offset in pixels. A positive will shift the text right. * Default is `0`. * @type {number|undefined} + * @api */ olx.style.TextOptions.prototype.offsetX; @@ -4925,6 +5438,7 @@ olx.style.TextOptions.prototype.offsetX; * Vertical text offset in pixels. A positive will shift the text down. Default * is `0`. * @type {number|undefined} + * @api */ olx.style.TextOptions.prototype.offsetY; @@ -4932,6 +5446,7 @@ olx.style.TextOptions.prototype.offsetY; /** * Scale. * @type {number|undefined} + * @api */ olx.style.TextOptions.prototype.scale; @@ -4939,6 +5454,7 @@ olx.style.TextOptions.prototype.scale; /** * Rotation. * @type {number|undefined} + * @api */ olx.style.TextOptions.prototype.rotation; @@ -4946,6 +5462,7 @@ olx.style.TextOptions.prototype.rotation; /** * Text. * @type {string|undefined} + * @api */ olx.style.TextOptions.prototype.text; @@ -4953,6 +5470,7 @@ olx.style.TextOptions.prototype.text; /** * Text alignment. * @type {string|undefined} + * @api */ olx.style.TextOptions.prototype.textAlign; @@ -4960,6 +5478,7 @@ olx.style.TextOptions.prototype.textAlign; /** * Text base line. * @type {string|undefined} + * @api */ olx.style.TextOptions.prototype.textBaseline; @@ -4967,6 +5486,7 @@ olx.style.TextOptions.prototype.textBaseline; /** * Fill style. * @type {ol.style.Fill|undefined} + * @api */ olx.style.TextOptions.prototype.fill; @@ -4974,6 +5494,7 @@ olx.style.TextOptions.prototype.fill; /** * Stroke style. * @type {ol.style.Stroke|undefined} + * @api */ olx.style.TextOptions.prototype.stroke; @@ -4992,6 +5513,7 @@ olx.style.StyleOptions; /** * Fill style. * @type {ol.style.Fill|undefined} + * @api */ olx.style.StyleOptions.prototype.fill; @@ -4999,6 +5521,7 @@ olx.style.StyleOptions.prototype.fill; /** * Image style. * @type {ol.style.Image|undefined} + * @api */ olx.style.StyleOptions.prototype.image; @@ -5006,6 +5529,7 @@ olx.style.StyleOptions.prototype.image; /** * Stroke style. * @type {ol.style.Stroke|undefined} + * @api */ olx.style.StyleOptions.prototype.stroke; @@ -5013,6 +5537,7 @@ olx.style.StyleOptions.prototype.stroke; /** * Text style. * @type {ol.style.Text|undefined} + * @api */ olx.style.StyleOptions.prototype.text; @@ -5020,6 +5545,7 @@ olx.style.StyleOptions.prototype.text; /** * Z index. * @type {number|undefined} + * @api */ olx.style.StyleOptions.prototype.zIndex; @@ -5039,6 +5565,7 @@ olx.tilegrid.TileGridOptions; /** * Minimum zoom. Default is 0. * @type {number|undefined} + * @api */ olx.tilegrid.TileGridOptions.prototype.minZoom; @@ -5046,6 +5573,7 @@ olx.tilegrid.TileGridOptions.prototype.minZoom; /** * Origin. Default is null. * @type {ol.Coordinate|undefined} + * @api */ olx.tilegrid.TileGridOptions.prototype.origin; @@ -5054,6 +5582,7 @@ olx.tilegrid.TileGridOptions.prototype.origin; * Origins. If given, the array should match the `resolutions` array, i.e. * each resolution can have a different origin. * @type {Array.|undefined} + * @api */ olx.tilegrid.TileGridOptions.prototype.origins; @@ -5061,6 +5590,7 @@ olx.tilegrid.TileGridOptions.prototype.origins; /** * Resolutions. * @type {!Array.} + * @api */ olx.tilegrid.TileGridOptions.prototype.resolutions; @@ -5068,6 +5598,7 @@ olx.tilegrid.TileGridOptions.prototype.resolutions; /** * Tile size. Default is 256. (Only square tiles are supported.) * @type {number|undefined} + * @api */ olx.tilegrid.TileGridOptions.prototype.tileSize; @@ -5076,6 +5607,7 @@ olx.tilegrid.TileGridOptions.prototype.tileSize; * Tile sizes. If given, the array should match the `resolutions` array, i.e. * each resolution can have a different tile size. * @type {Array.|undefined} + * @api */ olx.tilegrid.TileGridOptions.prototype.tileSizes; @@ -5095,6 +5627,7 @@ olx.tilegrid.WMTSOptions; /** * Origin. * @type {ol.Coordinate|undefined} + * @api */ olx.tilegrid.WMTSOptions.prototype.origin; @@ -5102,6 +5635,7 @@ olx.tilegrid.WMTSOptions.prototype.origin; /** * Origins. * @type {Array.|undefined} + * @api */ olx.tilegrid.WMTSOptions.prototype.origins; @@ -5109,6 +5643,7 @@ olx.tilegrid.WMTSOptions.prototype.origins; /** * Resolutions. * @type {!Array.} + * @api */ olx.tilegrid.WMTSOptions.prototype.resolutions; @@ -5116,6 +5651,7 @@ olx.tilegrid.WMTSOptions.prototype.resolutions; /** * matrix IDs. * @type {!Array.} + * @api */ olx.tilegrid.WMTSOptions.prototype.matrixIds; @@ -5123,6 +5659,7 @@ olx.tilegrid.WMTSOptions.prototype.matrixIds; /** * Tile size. * @type {number|undefined} + * @api */ olx.tilegrid.WMTSOptions.prototype.tileSize; @@ -5130,6 +5667,7 @@ olx.tilegrid.WMTSOptions.prototype.tileSize; /** * Tile sizes. * @type {Array.|undefined} + * @api */ olx.tilegrid.WMTSOptions.prototype.tileSizes; @@ -5150,6 +5688,7 @@ olx.tilegrid.XYZOptions; * resolution at which one tile fits in the provided extent. If not provided, * the extent of the EPSG:3857 projection is used. * @type {ol.Extent|undefined} + * @api */ olx.tilegrid.XYZOptions.prototype.extent; @@ -5159,6 +5698,7 @@ olx.tilegrid.XYZOptions.prototype.extent; * number of levels in the grid set. For example, a `maxZoom` of 21 means there * are 22 levels in the grid set. * @type {number|undefined} + * @api */ olx.tilegrid.XYZOptions.prototype.maxZoom; @@ -5166,6 +5706,7 @@ olx.tilegrid.XYZOptions.prototype.maxZoom; /** * Minimum zoom. Default is 0. * @type {number|undefined} + * @api */ olx.tilegrid.XYZOptions.prototype.minZoom; @@ -5173,6 +5714,7 @@ olx.tilegrid.XYZOptions.prototype.minZoom; /** * Tile size in pixels. Default is 256. (Only square tiles are supported.) * @type {number|undefined} + * @api */ olx.tilegrid.XYZOptions.prototype.tileSize; @@ -5180,6 +5722,7 @@ olx.tilegrid.XYZOptions.prototype.tileSize; /** * @typedef {{resolutions: !Array.}} * @api + * @api */ olx.tilegrid.ZoomifyOptions; @@ -5187,6 +5730,7 @@ olx.tilegrid.ZoomifyOptions; /** * Resolutions. * @type {!Array.} + * @api */ olx.tilegrid.ZoomifyOptions.prototype.resolutions; @@ -5205,6 +5749,7 @@ olx.View.fitGeometryOptions; * Padding (in pixels) to be cleared inside the view. Values in the array are * top, right, bottom and left padding. Default is `[0, 0, 0, 0]`. * @type {!Array.} + * @api */ olx.View.fitGeometryOptions.prototype.padding; @@ -5212,6 +5757,7 @@ olx.View.fitGeometryOptions.prototype.padding; /** * Constrain the resolution. Default is `true`. * @type {boolean|undefined} + * @api */ olx.View.fitGeometryOptions.prototype.constrainResolution; @@ -5219,6 +5765,7 @@ olx.View.fitGeometryOptions.prototype.constrainResolution; /** * Get the nearest extent. Default is `false`. * @type {boolean|undefined} + * @api */ olx.View.fitGeometryOptions.prototype.nearest; @@ -5226,6 +5773,7 @@ olx.View.fitGeometryOptions.prototype.nearest; /** * Minimum resolution that we zoom to. Default is `0`. * @type {number|undefined} + * @api */ olx.View.fitGeometryOptions.prototype.minResolution; @@ -5234,6 +5782,7 @@ olx.View.fitGeometryOptions.prototype.minResolution; * Maximum zoom level that we zoom to. If `minResolution` is given, * this property is ignored. * @type {number|undefined} + * @api */ olx.View.fitGeometryOptions.prototype.maxZoom; @@ -5267,15 +5816,24 @@ olx.View.fitGeometryOptions.prototype.maxZoom; olx.FrameState; -/** @type {number} */ +/** + * @type {number} + * @api + */ olx.FrameState.prototype.pixelRatio; -/** @type {number} */ +/** + * @type {number} + * @api + */ olx.FrameState.prototype.time; -/** @type {olx.ViewState} */ +/** + * @type {olx.ViewState} + * @api + */ olx.FrameState.prototype.viewState; @@ -5289,13 +5847,22 @@ olx.FrameState.prototype.viewState; olx.ViewState; -/** @type {ol.Coordinate} */ +/** + * @type {ol.Coordinate} + * @api + */ olx.ViewState.prototype.center; -/** @type {number} */ +/** + * @type {number} + * @api + */ olx.ViewState.prototype.resolution; -/** @type {number} */ +/** + * @type {number} + * @api + */ olx.ViewState.prototype.rotation;