Use olx namespace in src/objectliterals.jsdoc

sed comment used: sed -ri 's/ol(\.\S*Options)/olx\1/' src/objectliterals.jsdoc
This commit is contained in:
Éric Lemoine
2013-12-12 14:12:02 +01:00
parent 875b5e1c0e
commit ef703c7147
+84 -84
View File
@@ -1,5 +1,5 @@
/** /**
* @typedef {Object} ol.AttributionOptions * @typedef {Object} olx.AttributionOptions
* @property {string} html HTML markup for this attribution. * @property {string} html HTML markup for this attribution.
* @property {Object.<string, Array.<ol.TileRange>>|undefined} tileRanges * @property {Object.<string, Array.<ol.TileRange>>|undefined} tileRanges
* Tile ranges (FOR INTERNAL USE ONLY). * Tile ranges (FOR INTERNAL USE ONLY).
@@ -7,13 +7,13 @@
*/ */
/** /**
* @typedef {Object} ol.DeviceOrientationOptions * @typedef {Object} olx.DeviceOrientationOptions
* @property {boolean|undefined} tracking Start tracking. Default is `false`. * @property {boolean|undefined} tracking Start tracking. Default is `false`.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.GeolocationOptions * @typedef {Object} olx.GeolocationOptions
* @property {boolean|undefined} tracking Start Tracking. Default is `false`. * @property {boolean|undefined} tracking Start Tracking. Default is `false`.
* @property {GeolocationPositionOptions|undefined} trackingOptions Tracking options. * @property {GeolocationPositionOptions|undefined} trackingOptions Tracking options.
* @property {ol.proj.ProjectionLike} projection Projection. * @property {ol.proj.ProjectionLike} projection Projection.
@@ -21,7 +21,7 @@
*/ */
/** /**
* @typedef {Object} ol.GetFeatureInfoOptions * @typedef {Object} olx.GetFeatureInfoOptions
* @property {ol.Pixel} pixel Pixel coordinate relative to the map viewport. * @property {ol.Pixel} pixel Pixel coordinate relative to the map viewport.
* @property {Array.<ol.layer.Layer>|undefined} layers Layers to restrict the * @property {Array.<ol.layer.Layer>|undefined} layers Layers to restrict the
* query to. All map layers will be queried if not provided. * query to. All map layers will be queried if not provided.
@@ -37,7 +37,7 @@
*/ */
/** /**
* @typedef {Object} ol.GetFeaturesOptions * @typedef {Object} olx.GetFeaturesOptions
* @property {ol.Pixel} pixel Pixel coordinate relative to the map viewport. * @property {ol.Pixel} pixel Pixel coordinate relative to the map viewport.
* @property {Array.<ol.layer.Layer>|undefined} layers Layers to restrict the * @property {Array.<ol.layer.Layer>|undefined} layers Layers to restrict the
* query to. All layers will be queried if not provided. * query to. All layers will be queried if not provided.
@@ -54,7 +54,7 @@
/** /**
* Object literal with config options for the map. * Object literal with config options for the map.
* @typedef {Object} ol.MapOptions * @typedef {Object} olx.MapOptions
* @property {ol.Collection|Array.<ol.control.Control>|undefined} controls * @property {ol.Collection|Array.<ol.control.Control>|undefined} controls
* Controls initially added to the map. * Controls initially added to the map.
* @property {ol.Collection|Array.<ol.interaction.Interaction>|undefined} interactions * @property {ol.Collection|Array.<ol.interaction.Interaction>|undefined} interactions
@@ -72,7 +72,7 @@
/** /**
* Object literal with config options for the overlay. * Object literal with config options for the overlay.
* @typedef {Object} ol.OverlayOptions * @typedef {Object} olx.OverlayOptions
* @property {Element|undefined} element The overlay element. * @property {Element|undefined} element The overlay element.
* @property {ol.Coordinate|undefined} position The overlay position in map * @property {ol.Coordinate|undefined} position The overlay position in map
* projection. * projection.
@@ -91,7 +91,7 @@
/** /**
* Object literal with config options for the Proj4js projection. * Object literal with config options for the Proj4js projection.
* @typedef {Object} ol.Proj4jsProjectionOptions * @typedef {Object} olx.Proj4jsProjectionOptions
* @property {string} code The SRS identifier code, e.g. `EPSG:31256`. * @property {string} code The SRS identifier code, e.g. `EPSG:31256`.
* @property {ol.Extent|undefined} extent The validity extent for the SRS. * @property {ol.Extent|undefined} extent The validity extent for the SRS.
* @property {boolean|undefined} global Whether the projection is valid for the * @property {boolean|undefined} global Whether the projection is valid for the
@@ -101,7 +101,7 @@
/** /**
* Object literal with config options for the projection. * Object literal with config options for the projection.
* @typedef {Object} ol.ProjectionOptions * @typedef {Object} olx.ProjectionOptions
* @property {string} code The SRS identifier code, e.g. `EPSG:4326`. * @property {string} code The SRS identifier code, e.g. `EPSG:4326`.
* @property {ol.proj.Units} units Units. * @property {ol.proj.Units} units Units.
* @property {ol.Extent|undefined} extent The validity extent for the SRS. * @property {ol.Extent|undefined} extent The validity extent for the SRS.
@@ -114,7 +114,7 @@
/** /**
* Object literal with config options for the view. * Object literal with config options for the view.
* @typedef {Object} ol.View2DOptions * @typedef {Object} olx.View2DOptions
* @property {ol.Coordinate|undefined} center The initial center for the view. * @property {ol.Coordinate|undefined} center The initial center for the view.
* The coordinate system for the center is specified with the `projection` * The coordinate system for the center is specified with the `projection`
* option. Default is `undefined`, and layer sources will not be fetched if * option. Default is `undefined`, and layer sources will not be fetched if
@@ -154,7 +154,7 @@
*/ */
/** /**
* @typedef {Object} ol.animation.BounceOptions * @typedef {Object} olx.animation.BounceOptions
* @property {number} resolution The resolution to start the bounce from, typically `map.getView().getResolution()`. * @property {number} resolution The resolution to start the bounce from, typically `map.getView().getResolution()`.
* @property {number|undefined} start The start time of the animation. Default is immediately. * @property {number|undefined} start The start time of the animation. Default is immediately.
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is `1000`. * @property {number|undefined} duration The duration of the animation in milliseconds. Default is `1000`.
@@ -163,7 +163,7 @@
*/ */
/** /**
* @typedef {Object} ol.animation.PanOptions * @typedef {Object} olx.animation.PanOptions
* @property {ol.Coordinate} source The location to start panning from, typically `map.getView().getCenter()`. * @property {ol.Coordinate} source The location to start panning from, typically `map.getView().getCenter()`.
* @property {number|undefined} start The start time of the animation. Default is immediately. * @property {number|undefined} start The start time of the animation. Default is immediately.
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is `1000`. * @property {number|undefined} duration The duration of the animation in milliseconds. Default is `1000`.
@@ -172,7 +172,7 @@
*/ */
/** /**
* @typedef {Object} ol.animation.RotateOptions * @typedef {Object} olx.animation.RotateOptions
* @property {number} rotation The rotation to apply, in radians. * @property {number} rotation The rotation to apply, in radians.
* @property {number|undefined} start The start time of the animation. Default is immediately. * @property {number|undefined} start The start time of the animation. Default is immediately.
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is `1000`. * @property {number|undefined} duration The duration of the animation in milliseconds. Default is `1000`.
@@ -181,7 +181,7 @@
*/ */
/** /**
* @typedef {Object} ol.animation.ZoomOptions * @typedef {Object} olx.animation.ZoomOptions
* @property {number} resolution number The resolution to begin zooming from, typically `map.getView().getResolution()`. * @property {number} resolution number The resolution to begin zooming from, typically `map.getView().getResolution()`.
* @property {number|undefined} start The start time of the animation. Default is immediately. * @property {number|undefined} start The start time of the animation. Default is immediately.
* @property {number|undefined} duration The duration of the animation in milliseconds. Default is `1000`. * @property {number|undefined} duration The duration of the animation in milliseconds. Default is `1000`.
@@ -190,33 +190,33 @@
*/ */
/** /**
* @typedef {Object} ol.control.AttributionOptions * @typedef {Object} olx.control.AttributionOptions
* @property {string|undefined} className CSS class name. Default is `ol-attribution`. * @property {string|undefined} className CSS class name. Default is `ol-attribution`.
* @property {Element|undefined} target Target. * @property {Element|undefined} target Target.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.control.ControlOptions * @typedef {Object} olx.control.ControlOptions
* @property {Element|undefined} element Element. * @property {Element|undefined} element Element.
* @property {Element|undefined} target Target. * @property {Element|undefined} target Target.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.control.DefaultsOptions * @typedef {Object} olx.control.DefaultsOptions
* @property {boolean|undefined} attribution Attribution. * @property {boolean|undefined} attribution Attribution.
* @property {ol.control.AttributionOptions|undefined} attributionOptions * @property {olx.control.AttributionOptions|undefined} attributionOptions
* Attribution options. * Attribution options.
* @property {boolean|undefined} logo Logo. * @property {boolean|undefined} logo Logo.
* @property {ol.control.LogoOptions|undefined} logoOptions Logo options. * @property {olx.control.LogoOptions|undefined} logoOptions Logo options.
* @property {boolean|undefined} zoom Zoom. * @property {boolean|undefined} zoom Zoom.
* @property {ol.control.ZoomOptions|undefined} zoomOptions Zoom options. * @property {olx.control.ZoomOptions|undefined} zoomOptions Zoom options.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.control.FullScreenOptions * @typedef {Object} olx.control.FullScreenOptions
* @property {string|undefined} className CSS class name. Default is `ol-full-screen`. * @property {string|undefined} className CSS class name. Default is `ol-full-screen`.
* @property {boolean|undefined} keys Full keyboard access. * @property {boolean|undefined} keys Full keyboard access.
* @property {Element|undefined} target Target. * @property {Element|undefined} target Target.
@@ -224,14 +224,14 @@
*/ */
/** /**
* @typedef {Object} ol.control.LogoOptions * @typedef {Object} olx.control.LogoOptions
* @property {string|undefined} className CSS class name. Default is `ol-logo`. * @property {string|undefined} className CSS class name. Default is `ol-logo`.
* @property {Element|undefined} target Target. * @property {Element|undefined} target Target.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.control.MousePositionOptions * @typedef {Object} olx.control.MousePositionOptions
* @property {string|undefined} className CSS class name. Default is `ol-mouse-position`. * @property {string|undefined} className CSS class name. Default is `ol-mouse-position`.
* @property {ol.CoordinateFormatType|undefined} coordinateFormat Coordinate * @property {ol.CoordinateFormatType|undefined} coordinateFormat Coordinate
* format. * format.
@@ -243,7 +243,7 @@
*/ */
/** /**
* @typedef {Object} ol.control.ScaleLineOptions * @typedef {Object} olx.control.ScaleLineOptions
* @property {string|undefined} className CSS Class name. Default is `ol-scale-line`. * @property {string|undefined} className CSS Class name. Default is `ol-scale-line`.
* @property {number|undefined} minWidth Minimum width in pixels. * @property {number|undefined} minWidth Minimum width in pixels.
* @property {Element|undefined} target Target. * @property {Element|undefined} target Target.
@@ -252,7 +252,7 @@
*/ */
/** /**
* @typedef {Object} ol.control.ZoomOptions * @typedef {Object} olx.control.ZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `250`. * @property {number|undefined} duration Animation duration in milliseconds. Default is `250`.
* @property {string|undefined} className CSS class name. Default is `ol-zoom`. * @property {string|undefined} className CSS class name. Default is `ol-zoom`.
* @property {number|undefined} delta The zoom delta applied on each click. * @property {number|undefined} delta The zoom delta applied on each click.
@@ -261,7 +261,7 @@
*/ */
/** /**
* @typedef {Object} ol.control.ZoomSliderOptions * @typedef {Object} olx.control.ZoomSliderOptions
* @property {string|undefined} className CSS class name. * @property {string|undefined} className CSS class name.
* @property {number|undefined} maxResolution Maximum resolution. * @property {number|undefined} maxResolution Maximum resolution.
* @property {number|undefined} minResolution Minimum resolution. * @property {number|undefined} minResolution Minimum resolution.
@@ -269,7 +269,7 @@
*/ */
/** /**
* @typedef {Object} ol.control.ZoomToExtentOptions * @typedef {Object} olx.control.ZoomToExtentOptions
* @property {string|undefined} className Class name. Default is `ol-zoom-extent`. * @property {string|undefined} className Class name. Default is `ol-zoom-extent`.
* @property {Element|undefined} target Target. * @property {Element|undefined} target Target.
* @property {ol.Extent|undefined} extent The extent to zoom to. If * @property {ol.Extent|undefined} extent The extent to zoom to. If
@@ -278,7 +278,7 @@
*/ */
/** /**
* @typedef {Object} ol.interaction.DoubleClickZoomOptions * @typedef {Object} olx.interaction.DoubleClickZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `250`. * @property {number|undefined} duration Animation duration in milliseconds. Default is `250`.
* @property {number|undefined} delta The zoom delta applied on each double * @property {number|undefined} delta The zoom delta applied on each double
* click, default is `1`. * click, default is `1`.
@@ -286,7 +286,7 @@
*/ */
/** /**
* @typedef {Object} ol.interaction.DragPanOptions * @typedef {Object} olx.interaction.DragPanOptions
* @property {ol.Kinetic|undefined} kinetic Kinetic inertia to apply to the pan. * @property {ol.Kinetic|undefined} kinetic Kinetic inertia to apply to the pan.
* @property {ol.events.ConditionType|undefined} condition A conditional * @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active * modifier (i.e. Shift key) that determines if the interaction is active
@@ -295,7 +295,7 @@
*/ */
/** /**
* @typedef {Object} ol.interaction.DragRotateOptions * @typedef {Object} olx.interaction.DragRotateOptions
* @property {ol.events.ConditionType|undefined} condition A conditional * @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active * modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is both shift and alt keys. * or not, default is both shift and alt keys.
@@ -303,7 +303,7 @@
*/ */
/** /**
* @typedef {Object} ol.interaction.DragRotateAndZoomOptions * @typedef {Object} olx.interaction.DragRotateAndZoomOptions
* @property {ol.events.ConditionType|undefined} condition A conditional * @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active * modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is shify key. * or not, default is shify key.
@@ -311,7 +311,7 @@
*/ */
/** /**
* @typedef {Object} ol.interaction.DragZoomOptions * @typedef {Object} olx.interaction.DragZoomOptions
* @property {ol.events.ConditionType|undefined} condition A conditional * @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active * modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is shift key. * or not, default is shift key.
@@ -320,7 +320,7 @@
/** /**
* Interactions for the map. Default is `true` for all options. * Interactions for the map. Default is `true` for all options.
* @typedef {Object} ol.interaction.DefaultsOptions * @typedef {Object} olx.interaction.DefaultsOptions
* @property {boolean|undefined} altShiftDragRotate Whether Alt-Shift-drag * @property {boolean|undefined} altShiftDragRotate Whether Alt-Shift-drag
* rotate is desired. * rotate is desired.
* @property {boolean|undefined} doubleClickZoom Whether double click zoom is * @property {boolean|undefined} doubleClickZoom Whether double click zoom is
@@ -342,7 +342,7 @@
*/ */
/** /**
* @typedef {Object} ol.interaction.DrawOptions * @typedef {Object} olx.interaction.DrawOptions
* @property {ol.layer.Vector} layer Destination layer for the features. * @property {ol.layer.Vector} layer Destination layer for the features.
* @property {number|undefined} snapTolerance Pixel distance for snapping to the * @property {number|undefined} snapTolerance Pixel distance for snapping to the
* drawing finish (default is 12). * drawing finish (default is 12).
@@ -352,7 +352,7 @@
*/ */
/** /**
* @typedef {Object} ol.interaction.KeyboardPanOptions * @typedef {Object} olx.interaction.KeyboardPanOptions
* @property {ol.events.ConditionType|undefined} condition A conditional * @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active * modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is no modifiers. * or not, default is no modifiers.
@@ -362,7 +362,7 @@
*/ */
/** /**
* @typedef {Object} ol.interaction.KeyboardZoomOptions * @typedef {Object} olx.interaction.KeyboardZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `100`. * @property {number|undefined} duration Animation duration in milliseconds. Default is `100`.
* @property {ol.events.ConditionType|undefined} condition A conditional * @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active * modifier (i.e. Shift key) that determines if the interaction is active
@@ -372,13 +372,13 @@
*/ */
/** /**
* @typedef {Object} ol.interaction.MouseWheelZoomOptions * @typedef {Object} olx.interaction.MouseWheelZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `250`. * @property {number|undefined} duration Animation duration in milliseconds. Default is `250`.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.interaction.ModifyOptions * @typedef {Object} olx.interaction.ModifyOptions
* @property {undefined|Array.<ol.layer.Layer>|function(ol.layer.Layer):boolean} layers * @property {undefined|Array.<ol.layer.Layer>|function(ol.layer.Layer):boolean} layers
* Layers or filter function to restrict modification to a subset of layers. * Layers or filter function to restrict modification to a subset of layers.
* @property {number|undefined} pixelTolerance Pixel tolerance for considering * @property {number|undefined} pixelTolerance Pixel tolerance for considering
@@ -386,7 +386,7 @@
*/ */
/** /**
* @typedef {Object} ol.interaction.SelectOptions * @typedef {Object} olx.interaction.SelectOptions
* @property {ol.events.ConditionType|undefined} addCondition A conditional * @property {ol.events.ConditionType|undefined} addCondition A conditional
* modifier (e.g. shift key) that determines if the selection is added to * modifier (e.g. shift key) that determines if the selection is added to
* the current selection. By default, a shift-click adds to the current * the current selection. By default, a shift-click adds to the current
@@ -401,27 +401,27 @@
*/ */
/** /**
* @typedef {Object} ol.interaction.TouchPanOptions * @typedef {Object} olx.interaction.TouchPanOptions
* @property {ol.Kinetic|undefined} kinetic Kinetic inertia to apply to the * @property {ol.Kinetic|undefined} kinetic Kinetic inertia to apply to the
* pan. * pan.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.interaction.TouchRotateOptions * @typedef {Object} olx.interaction.TouchRotateOptions
* @property {number|undefined} threshold Minimal angle in radians to start a rotation. * @property {number|undefined} threshold Minimal angle in radians to start a rotation.
* Default is `0.3`. * Default is `0.3`.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.interaction.TouchZoomOptions * @typedef {Object} olx.interaction.TouchZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `400`. * @property {number|undefined} duration Animation duration in milliseconds. Default is `400`.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.layer.BaseOptions * @typedef {Object} olx.layer.BaseOptions
* @property {number|undefined} brightness Brightness. Default is `0`. * @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. Default is `1`. * @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. Default is `0`. * @property {number|undefined} hue Hue. Default is `0`.
@@ -436,7 +436,7 @@
*/ */
/** /**
* @typedef {Object} ol.layer.LayerOptions * @typedef {Object} olx.layer.LayerOptions
* @property {number|undefined} brightness Brightness. Default is `0`. * @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. Default is `1`. * @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. Default is `0`. * @property {number|undefined} hue Hue. Default is `0`.
@@ -452,7 +452,7 @@
*/ */
/** /**
* @typedef {Object} ol.layer.GroupOptions * @typedef {Object} olx.layer.GroupOptions
* @property {number|undefined} brightness Brightness. Default is `0`. * @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. Default is `1`. * @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. Default is `0`. * @property {number|undefined} hue Hue. Default is `0`.
@@ -468,7 +468,7 @@
*/ */
/** /**
* @typedef {Object} ol.layer.TileOptions * @typedef {Object} olx.layer.TileOptions
* @property {number|undefined} brightness Brightness. Default is `0`. * @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. Default is `1`. * @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. Default is `0`. * @property {number|undefined} hue Hue. Default is `0`.
@@ -485,7 +485,7 @@
*/ */
/** /**
* @typedef {Object} ol.layer.VectorLayerOptions * @typedef {Object} olx.layer.VectorLayerOptions
* @property {function(Array.<ol.Feature>):string|undefined} transformFeatureInfo * @property {function(Array.<ol.Feature>):string|undefined} transformFeatureInfo
* Function to render an array of * Function to render an array of
* features into feature info markup. If not provided, a comma separated * features into feature info markup. If not provided, a comma separated
@@ -502,7 +502,7 @@
*/ */
/** /**
* @typedef {Object} ol.parser.KMLOptions * @typedef {Object} olx.parser.KMLOptions
* @property {boolean|undefined} extractAttributes Should we extract attributes * @property {boolean|undefined} extractAttributes Should we extract attributes
* from the KML? Default is `true`. * from the KML? Default is `true`.
* @property {boolean|undefined} extractStyles Should we extract styles from the * @property {boolean|undefined} extractStyles Should we extract styles from the
@@ -515,20 +515,20 @@
*/ */
/** /**
* @typedef {Object} ol.parser.GMLReadOptions * @typedef {Object} olx.parser.GMLReadOptions
* @property {string|undefined} axisOrientation The axis orientation. * @property {string|undefined} axisOrientation The axis orientation.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.parser.GMLWriteOptions * @typedef {Object} olx.parser.GMLWriteOptions
* @property {ol.proj.ProjectionLike} srsName The srsName to use when writing. * @property {ol.proj.ProjectionLike} srsName The srsName to use when writing.
* @property {string|undefined} axisOrientation The axis orientation. * @property {string|undefined} axisOrientation The axis orientation.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.parser.GMLOptions * @typedef {Object} olx.parser.GMLOptions
* @property {boolean|undefined} curve Write gml:Curve instead of * @property {boolean|undefined} curve Write gml:Curve instead of
* gml:LineString elements. This also affects the elements in multi-part * gml:LineString elements. This also affects the elements in multi-part
* geometries. Default is `false`. This only applies to GML version 3. * geometries. Default is `false`. This only applies to GML version 3.
@@ -549,15 +549,15 @@
* @property {boolean|undefined} surface Write gml:Surface instead of * @property {boolean|undefined} surface Write gml:Surface instead of
* gml:Polygon elements. This also affects the elements in multi-part * gml:Polygon elements. This also affects the elements in multi-part
* geometries. Default is `false`. This only applies to GML version 3. * geometries. Default is `false`. This only applies to GML version 3.
* @property {ol.parser.GMLReadOptions|undefined} readOptions readOptions to * @property {olx.parser.GMLReadOptions|undefined} readOptions readOptions to
* use for this instance. * use for this instance.
* @property {ol.parser.GMLWriteOptions|undefined} writeOptions writeOptions * @property {olx.parser.GMLWriteOptions|undefined} writeOptions writeOptions
* to use for this instance. * to use for this instance.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.parser.GPXOptions * @typedef {Object} olx.parser.GPXOptions
* @property {string|undefined} creator The creator attribute to be added to * @property {string|undefined} creator The creator attribute to be added to
* the written GPX files. Defaults to `OpenLayers`. * the written GPX files. Defaults to `OpenLayers`.
* @property {string|undefined} defaultDesc Default description for the * @property {string|undefined} defaultDesc Default description for the
@@ -575,7 +575,7 @@
*/ */
/** /**
* @typedef {Object} ol.parser.GPXWriteOptions * @typedef {Object} olx.parser.GPXWriteOptions
* @property {Array.<ol.Feature>|ol.Feature} features The features to write * @property {Array.<ol.Feature>|ol.Feature} features The features to write
* out. * out.
* @property {Object|undefined} metadata Metadata key/value pair with keys: * @property {Object|undefined} metadata Metadata key/value pair with keys:
@@ -584,19 +584,19 @@
*/ */
/** /**
* @typedef {Object} ol.parser.SLDReadOptions * @typedef {Object} olx.parser.SLDReadOptions
* @property {ol.proj.Units} units The units to use in scale to resolution * @property {ol.proj.Units} units The units to use in scale to resolution
* calculations. * calculations.
*/ */
/** /**
* @typedef {Object} ol.parser.SLDWriteOptions * @typedef {Object} olx.parser.SLDWriteOptions
* @property {ol.proj.Units} units The units to use in resolution to scale * @property {ol.proj.Units} units The units to use in resolution to scale
* calculations. * calculations.
*/ */
/** /**
* @typedef {Object} ol.parser.WFSWriteGetFeatureOptions * @typedef {Object} olx.parser.WFSWriteGetFeatureOptions
* @property {string} featureNS The namespace URI used for features. * @property {string} featureNS The namespace URI used for features.
* @property {string} featurePrefix The prefix for the feature namespace. * @property {string} featurePrefix The prefix for the feature namespace.
* @property {Array.<string>} featureTypes The feature type names. * @property {Array.<string>} featureTypes The feature type names.
@@ -609,7 +609,7 @@
*/ */
/** /**
* @typedef {Object} ol.parser.WFSWriteTransactionOptions * @typedef {Object} olx.parser.WFSWriteTransactionOptions
* @property {string} featureNS The namespace URI used for features. * @property {string} featureNS The namespace URI used for features.
* @property {string} featurePrefix The prefix for the feature namespace. * @property {string} featurePrefix The prefix for the feature namespace.
* @property {string} featureType The feature type name. * @property {string} featureType The feature type name.
@@ -621,7 +621,7 @@
*/ */
/** /**
* @typedef {Object} ol.source.BingMapsOptions * @typedef {Object} olx.source.BingMapsOptions
* @property {string|undefined} culture Culture code. Default is `en-us`. * @property {string|undefined} culture Culture code. Default is `en-us`.
* @property {string} key Bing Maps API key. Get yours at * @property {string} key Bing Maps API key. Get yours at
* http://bingmapsportal.com/. * http://bingmapsportal.com/.
@@ -632,7 +632,7 @@
*/ */
/** /**
* @typedef {Object} ol.source.MapGuideOptions * @typedef {Object} olx.source.MapGuideOptions
* @property {string|undefined} url The mapagent url. * @property {string|undefined} url The mapagent url.
* @property {number|undefined} metersPerUnit The meters-per-unit value. * @property {number|undefined} metersPerUnit The meters-per-unit value.
* @property {ol.Extent|undefined} extent Extent.. * @property {ol.Extent|undefined} extent Extent..
@@ -648,14 +648,14 @@
*/ */
/** /**
* @typedef {Object} ol.source.MapQuestOptions * @typedef {Object} olx.source.MapQuestOptions
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
* function to load a tile given a URL. * function to load a tile given a URL.
* @todo stability experimental * @todo stability experimental
*/ */
/** /**
* @typedef {Object} ol.source.TileDebugOptions * @typedef {Object} olx.source.TileDebugOptions
* @property {ol.Extent|undefined} extent Extent. * @property {ol.Extent|undefined} extent Extent.
* @property {ol.proj.ProjectionLike} projection Projection. * @property {ol.proj.ProjectionLike} projection Projection.
* @property {ol.tilegrid.TileGrid|undefined} tileGrid Tile grid. * @property {ol.tilegrid.TileGrid|undefined} tileGrid Tile grid.
@@ -663,7 +663,7 @@
*/ */
/** /**
* @typedef {Object} ol.source.OSMOptions * @typedef {Object} olx.source.OSMOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions. * @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {number|undefined} maxZoom Max zoom. * @property {number|undefined} maxZoom Max zoom.
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
@@ -675,12 +675,12 @@
*/ */
/** /**
* @typedef {Object} ol.source.ImageWMSOptions * @typedef {Object} olx.source.ImageWMSOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions. * @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {null|string|undefined} crossOrigin crossOrigin setting for image * @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests. * requests.
* @property {ol.Extent|undefined} extent Extent. * @property {ol.Extent|undefined} extent Extent.
* @property {ol.source.WMSGetFeatureInfoOptions|undefined} getFeatureInfoOptions * @property {olx.source.WMSGetFeatureInfoOptions|undefined} getFeatureInfoOptions
* Options for GetFeatureInfo. * Options for GetFeatureInfo.
* @property {Object.<string,*>} params WMS request parameters. At least a * @property {Object.<string,*>} params WMS request parameters. At least a
* `LAYERS` param is required. `STYLES` is `` by default. `VERSION` is * `LAYERS` param is required. `STYLES` is `` by default. `VERSION` is
@@ -697,7 +697,7 @@
*/ */
/** /**
* @typedef {Object} ol.source.StamenOptions * @typedef {Object} olx.source.StamenOptions
* @property {string} layer Layer. * @property {string} layer Layer.
* @property {number|undefined} minZoom Minimum zoom. * @property {number|undefined} minZoom Minimum zoom.
* @property {number|undefined} maxZoom Maximum zoom. * @property {number|undefined} maxZoom Maximum zoom.
@@ -710,7 +710,7 @@
*/ */
/** /**
* @typedef {Object} ol.source.ImageStaticOptions * @typedef {Object} olx.source.ImageStaticOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions. * @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {null|string|undefined} crossOrigin crossOrigin setting for image * @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests. * requests.
@@ -723,7 +723,7 @@
*/ */
/** /**
* @typedef {Object} ol.source.TileJSONOptions * @typedef {Object} olx.source.TileJSONOptions
* @property {null|string|undefined} crossOrigin crossOrigin setting for image * @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests. * requests.
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
@@ -733,7 +733,7 @@
*/ */
/** /**
* @typedef {Object} ol.source.TileWMSOptions * @typedef {Object} olx.source.TileWMSOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions. * @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {Object.<string,*>} params WMS request parameters. At least a * @property {Object.<string,*>} params WMS request parameters. At least a
* `LAYERS` param is required. `STYLES` is `` by default. `VERSION` is * `LAYERS` param is required. `STYLES` is `` by default. `VERSION` is
@@ -742,7 +742,7 @@
* @property {null|string|undefined} crossOrigin crossOrigin setting for image * @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests. * requests.
* @property {ol.Extent|undefined} extent Extent. * @property {ol.Extent|undefined} extent Extent.
* @property {ol.source.WMSGetFeatureInfoOptions|undefined} getFeatureInfoOptions * @property {olx.source.WMSGetFeatureInfoOptions|undefined} getFeatureInfoOptions
* Options for GetFeatureInfo. * Options for GetFeatureInfo.
* @property {string|undefined} logo Logo. * @property {string|undefined} logo Logo.
* @property {ol.tilegrid.TileGrid|undefined} tileGrid Tile grid. * @property {ol.tilegrid.TileGrid|undefined} tileGrid Tile grid.
@@ -757,7 +757,7 @@
*/ */
/** /**
* @typedef {Object} ol.source.VectorOptions * @typedef {Object} olx.source.VectorOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions. * @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {Array.<ol.Feature>|undefined} features Any features to be added * @property {Array.<ol.Feature>|undefined} features Any features to be added
* to the source. Providing features is an alternative to providing * to the source. Providing features is an alternative to providing
@@ -776,7 +776,7 @@
*/ */
/** /**
* @typedef {Object} ol.source.WMTSOptions * @typedef {Object} olx.source.WMTSOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions. * @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {string|null|undefined} crossOrigin crossOrigin setting for image * @property {string|null|undefined} crossOrigin crossOrigin setting for image
* requests. * requests.
@@ -801,7 +801,7 @@
*/ */
/** /**
* @typedef {Object} ol.source.XYZOptions * @typedef {Object} olx.source.XYZOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions. * @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {null|string|undefined} crossOrigin Cross origin setting for image * @property {null|string|undefined} crossOrigin Cross origin setting for image
* requests. * requests.
@@ -822,7 +822,7 @@
*/ */
/** /**
* @typedef {Object} ol.style.IconOptions * @typedef {Object} olx.style.IconOptions
* @property {string|ol.expr.Expression} url Icon image URL. * @property {string|ol.expr.Expression} url Icon image URL.
* @property {number|ol.expr.Expression|undefined} width Width of the icon * @property {number|ol.expr.Expression|undefined} width Width of the icon
* in pixels. Default is the width of the icon image. * in pixels. Default is the width of the icon image.
@@ -841,7 +841,7 @@
*/ */
/** /**
* @typedef {Object} ol.style.FillOptions * @typedef {Object} olx.style.FillOptions
* @property {string|ol.expr.Expression|undefined} color Fill color as hex color * @property {string|ol.expr.Expression|undefined} color Fill color as hex color
* code. * code.
* @property {number|ol.expr.Expression|undefined} opacity Opacity (0, 1). Default is `1`. * @property {number|ol.expr.Expression|undefined} opacity Opacity (0, 1). Default is `1`.
@@ -850,7 +850,7 @@
*/ */
/** /**
* @typedef {Object} ol.style.RuleOptions * @typedef {Object} olx.style.RuleOptions
* @property {ol.expr.Expression|string|undefined} filter Filter. * @property {ol.expr.Expression|string|undefined} filter Filter.
* @property {number|undefined} maxResolution Optional maximum resolution. If * @property {number|undefined} maxResolution Optional maximum resolution. If
* a value is provided, the rule will apply at resolutions less than * a value is provided, the rule will apply at resolutions less than
@@ -865,7 +865,7 @@
*/ */
/** /**
* @typedef {Object} ol.style.ShapeOptions * @typedef {Object} olx.style.ShapeOptions
* @property {ol.style.ShapeType|undefined} type Type. * @property {ol.style.ShapeType|undefined} type Type.
* @property {number|ol.expr.Expression|undefined} size Size in pixels. * @property {number|ol.expr.Expression|undefined} size Size in pixels.
* @property {ol.style.Fill|undefined} fill Fill symbolizer for shape. * @property {ol.style.Fill|undefined} fill Fill symbolizer for shape.
@@ -875,7 +875,7 @@
*/ */
/** /**
* @typedef {Object} ol.style.StrokeOptions * @typedef {Object} olx.style.StrokeOptions
* @property {string|ol.expr.Expression|undefined} color Stroke color as hex * @property {string|ol.expr.Expression|undefined} color Stroke color as hex
* color code. * color code.
* @property {number|ol.expr.Expression|undefined} opacity Stroke opacity (0, 1). Default is `1`. * @property {number|ol.expr.Expression|undefined} opacity Stroke opacity (0, 1). Default is `1`.
@@ -885,7 +885,7 @@
*/ */
/** /**
* @typedef {Object} ol.style.StyleOptions * @typedef {Object} olx.style.StyleOptions
* @property {Array.<ol.style.Rule>|undefined} rules Rules. * @property {Array.<ol.style.Rule>|undefined} rules Rules.
* @property {Array.<ol.style.Symbolizer>|undefined} symbolizers Symbolizers * @property {Array.<ol.style.Symbolizer>|undefined} symbolizers Symbolizers
* (that apply if no rules are provided or where none of the provided rules * (that apply if no rules are provided or where none of the provided rules
@@ -896,7 +896,7 @@
*/ */
/** /**
* @typedef {Object} ol.style.TextOptions * @typedef {Object} olx.style.TextOptions
* @property {string|ol.expr.Expression|undefined} color Color. * @property {string|ol.expr.Expression|undefined} color Color.
* @property {string|ol.expr.Expression|undefined} fontFamily Font family. * @property {string|ol.expr.Expression|undefined} fontFamily Font family.
* @property {number|ol.expr.Expression|undefined} fontSize Font size in pixels. * @property {number|ol.expr.Expression|undefined} fontSize Font size in pixels.
@@ -909,7 +909,7 @@
*/ */
/** /**
* @typedef {Object} ol.tilegrid.TileGridOptions * @typedef {Object} olx.tilegrid.TileGridOptions
* @property {number|undefined} minZoom Minimum zoom. * @property {number|undefined} minZoom Minimum zoom.
* @property {ol.Coordinate|undefined} origin Origin. * @property {ol.Coordinate|undefined} origin Origin.
* @property {Array.<ol.Coordinate>|undefined} origins Origins. * @property {Array.<ol.Coordinate>|undefined} origins Origins.
@@ -920,7 +920,7 @@
*/ */
/** /**
* @typedef {Object} ol.tilegrid.WMTSOptions * @typedef {Object} olx.tilegrid.WMTSOptions
* @property {ol.Coordinate|undefined} origin Origin. * @property {ol.Coordinate|undefined} origin Origin.
* @property {Array.<ol.Coordinate>|undefined} origins Origins. * @property {Array.<ol.Coordinate>|undefined} origins Origins.
* @property {!Array.<number>} resolutions Resolutions. * @property {!Array.<number>} resolutions Resolutions.
@@ -931,7 +931,7 @@
*/ */
/** /**
* @typedef {Object} ol.tilegrid.XYZOptions * @typedef {Object} olx.tilegrid.XYZOptions
* @property {number} maxZoom Maximum zoom. * @property {number} maxZoom Maximum zoom.
* @todo stability experimental * @todo stability experimental
*/ */