ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge remote-tracking branch 'upstream/master' into vector-api

Browse Source 
Conflicts:
	src/objectliterals.jsdoc
	src/ol/attribution.js
	src/ol/geom/geometry.js
	src/ol/geom/geometrycollection.js
	src/ol/geom/linestring.js
	src/ol/layer/vectorlayer.exports
	src/ol/layer/vectorlayer.js
	src/ol/map.js
	src/ol/proj/proj.js
	src/ol/renderer/canvas/canvasvectorlayerrenderer.js
	src/ol/source/imagewmssource.js
	src/ol/source/tilewmssource.js
	src/ol/source/vectorsource.exports
	src/ol/source/vectorsource.js
	src/ol/source/wmssource.js
	src/ol/style/style.js
	src/ol/tilegrid/tilegrid.js
	src/ol/tilegrid/wmtstilegrid.js
	src/ol/tilegrid/xyztilegrid.js
This commit is contained in:
Éric Lemoine
2013-12-13 12:46:55 +01:00
parent cbc71686df 93e605b119
commit 35d5158454
167 changed files with 678 additions and 505 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
src/objectliterals.jsdoc
View File

@@ -1,5 +1,5 @@
/**
* @typedef {Object} ol.AttributionOptions
* @typedef {Object} olx.AttributionOptions
* @property {string} html HTML markup for this attribution.
* @property {Object.<string, Array.<ol.TileRange>>|undefined} tileRanges
* 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`.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.GeolocationOptions
* @typedef {Object} olx.GeolocationOptions
* @property {boolean|undefined} tracking Start Tracking. Default is `false`.
* @property {GeolocationPositionOptions|undefined} trackingOptions Tracking options.
* @property {ol.proj.ProjectionLike} projection Projection.
@@ -22,7 +22,7 @@
/**
* 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
* Controls initially added to the map.
* @property {ol.Collection|Array.<ol.interaction.Interaction>|undefined} interactions
@@ -40,7 +40,7 @@
/**
* Object literal with config options for the overlay.
* @typedef {Object} ol.OverlayOptions
* @typedef {Object} olx.OverlayOptions
* @property {Element|undefined} element The overlay element.
* @property {ol.Coordinate|undefined} position The overlay position in map
* projection.
@@ -59,7 +59,7 @@
/**
* 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 {ol.Extent|undefined} extent The validity extent for the SRS.
* @property {boolean|undefined} global Whether the projection is valid for the
@@ -69,7 +69,7 @@
/**
* 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 {ol.proj.Units} units Units.
* @property {ol.Extent|undefined} extent The validity extent for the SRS.
@@ -82,7 +82,7 @@
/**
* 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.
* The coordinate system for the center is specified with the `projection`
* option. Default is `undefined`, and layer sources will not be fetched if
@@ -122,7 +122,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|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`.
@@ -131,7 +131,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 {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`.
@@ -140,7 +140,7 @@
*/
/**
* @typedef {Object} ol.animation.RotateOptions
* @typedef {Object} olx.animation.RotateOptions
* @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} duration The duration of the animation in milliseconds. Default is `1000`.
@@ -149,7 +149,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|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`.
@@ -158,33 +158,33 @@
*/
/**
* @typedef {Object} ol.control.AttributionOptions
* @typedef {Object} olx.control.AttributionOptions
* @property {string|undefined} className CSS class name. Default is `ol-attribution`.
* @property {Element|undefined} target Target.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.control.ControlOptions
* @typedef {Object} olx.control.ControlOptions
* @property {Element|undefined} element Element.
* @property {Element|undefined} target Target.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.control.DefaultsOptions
* @typedef {Object} olx.control.DefaultsOptions
* @property {boolean|undefined} attribution Attribution.
* @property {ol.control.AttributionOptions|undefined} attributionOptions
* @property {olx.control.AttributionOptions|undefined} attributionOptions
* Attribution options.
* @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 {ol.control.ZoomOptions|undefined} zoomOptions Zoom options.
* @property {olx.control.ZoomOptions|undefined} zoomOptions Zoom options.
* @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 {boolean|undefined} keys Full keyboard access.
* @property {Element|undefined} target Target.
@@ -192,14 +192,14 @@
*/
/**
* @typedef {Object} ol.control.LogoOptions
* @typedef {Object} olx.control.LogoOptions
* @property {string|undefined} className CSS class name. Default is `ol-logo`.
* @property {Element|undefined} target Target.
* @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 {ol.CoordinateFormatType|undefined} coordinateFormat Coordinate
* format.
@@ -211,7 +211,7 @@
*/
/**
* @typedef {Object} ol.control.ScaleLineOptions
* @typedef {Object} olx.control.ScaleLineOptions
* @property {string|undefined} className CSS Class name. Default is `ol-scale-line`.
* @property {number|undefined} minWidth Minimum width in pixels.
* @property {Element|undefined} target Target.
@@ -220,7 +220,7 @@
*/
/**
* @typedef {Object} ol.control.ZoomOptions
* @typedef {Object} olx.control.ZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `250`.
* @property {string|undefined} className CSS class name. Default is `ol-zoom`.
* @property {number|undefined} delta The zoom delta applied on each click.
@@ -229,7 +229,7 @@
*/
/**
* @typedef {Object} ol.control.ZoomSliderOptions
* @typedef {Object} olx.control.ZoomSliderOptions
* @property {string|undefined} className CSS class name.
* @property {number|undefined} maxResolution Maximum resolution.
* @property {number|undefined} minResolution Minimum resolution.
@@ -237,7 +237,7 @@
*/
/**
* @typedef {Object} ol.control.ZoomToExtentOptions
* @typedef {Object} olx.control.ZoomToExtentOptions
* @property {string|undefined} className Class name. Default is `ol-zoom-extent`.
* @property {Element|undefined} target Target.
* @property {ol.Extent|undefined} extent The extent to zoom to. If
@@ -246,12 +246,12 @@
*/
/**
* @typedef {Object} ol.format.GeoJSONOptions
* @typedef {Object} olx.format.GeoJSONOptions
* @property {ol.proj.ProjectionLike} defaultProjection Default projection.
*/
/**
* @typedef {Object} ol.interaction.DoubleClickZoomOptions
* @typedef {Object} olx.interaction.DoubleClickZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `250`.
* @property {number|undefined} delta The zoom delta applied on each double
* click, default is `1`.
@@ -259,7 +259,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.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active
@@ -268,7 +268,7 @@
*/
/**
* @typedef {Object} ol.interaction.DragRotateOptions
* @typedef {Object} olx.interaction.DragRotateOptions
* @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is both shift and alt keys.
@@ -276,7 +276,7 @@
*/
/**
* @typedef {Object} ol.interaction.DragRotateAndZoomOptions
* @typedef {Object} olx.interaction.DragRotateAndZoomOptions
* @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is shify key.
@@ -284,7 +284,7 @@
*/
/**
* @typedef {Object} ol.interaction.DragZoomOptions
* @typedef {Object} olx.interaction.DragZoomOptions
* @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is shift key.
@@ -293,7 +293,7 @@
/**
* 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
* rotate is desired.
* @property {boolean|undefined} doubleClickZoom Whether double click zoom is
@@ -315,7 +315,7 @@
*/
/**
* @typedef {Object} ol.interaction.KeyboardPanOptions
* @typedef {Object} olx.interaction.KeyboardPanOptions
* @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active
* or not, default is no modifiers.
@@ -325,7 +325,7 @@
*/
/**
* @typedef {Object} ol.interaction.KeyboardZoomOptions
* @typedef {Object} olx.interaction.KeyboardZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `100`.
* @property {ol.events.ConditionType|undefined} condition A conditional
* modifier (i.e. Shift key) that determines if the interaction is active
@@ -335,33 +335,33 @@
*/
/**
* @typedef {Object} ol.interaction.MouseWheelZoomOptions
* @typedef {Object} olx.interaction.MouseWheelZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `250`.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.interaction.TouchPanOptions
* @typedef {Object} olx.interaction.TouchPanOptions
* @property {ol.Kinetic|undefined} kinetic Kinetic inertia to apply to the
* pan.
* @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.
* Default is `0.3`.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.interaction.TouchZoomOptions
* @typedef {Object} olx.interaction.TouchZoomOptions
* @property {number|undefined} duration Animation duration in milliseconds. Default is `400`.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.layer.BaseOptions
* @typedef {Object} olx.layer.BaseOptions
* @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. Default is `0`.
@@ -376,7 +376,7 @@
*/
/**
* @typedef {Object} ol.layer.LayerOptions
* @typedef {Object} olx.layer.LayerOptions
* @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. Default is `0`.
@@ -392,7 +392,7 @@
*/
/**
* @typedef {Object} ol.layer.GroupOptions
* @typedef {Object} olx.layer.GroupOptions
* @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. Default is `0`.
@@ -408,7 +408,7 @@
*/
/**
* @typedef {Object} ol.layer.TileOptions
* @typedef {Object} olx.layer.TileOptions
* @property {number|undefined} brightness Brightness. Default is `0`.
* @property {number|undefined} contrast Contrast. Default is `1`.
* @property {number|undefined} hue Hue. Default is `0`.
@@ -425,7 +425,7 @@
*/
/**
* @typedef {Object} ol.layer.VectorOptions
* @typedef {Object} olx.layer.VectorOptions
* @property {number|undefined} brightness Brightness.
* @property {number|undefined} contrast Contrast.
* @property {number|undefined} hue Hue.
@@ -438,10 +438,11 @@
* @property {ol.source.Vector} source Source.
* @property {ol.style.StyleFunction|undefined} styleFunction Style function.
* @property {boolean|undefined} visible Visibility. Default is `true` (visible).
* @todo stability experimental
*/
/**
* @typedef {Object} ol.parser.WFSWriteGetFeatureOptions
* @typedef {Object} olx.parser.WFSWriteGetFeatureOptions
* @property {string} featureNS The namespace URI used for features.
* @property {string} featurePrefix The prefix for the feature namespace.
* @property {Array.<string>} featureTypes The feature type names.
@@ -454,7 +455,7 @@
*/
/**
* @typedef {Object} ol.parser.WFSWriteTransactionOptions
* @typedef {Object} olx.parser.WFSWriteTransactionOptions
* @property {string} featureNS The namespace URI used for features.
* @property {string} featurePrefix The prefix for the feature namespace.
* @property {string} featureType The feature type name.
@@ -466,7 +467,7 @@
*/
/**
* @typedef {Object} ol.source.BingMapsOptions
* @typedef {Object} olx.source.BingMapsOptions
* @property {string|undefined} culture Culture code. Default is `en-us`.
* @property {string} key Bing Maps API key. Get yours at
* http://bingmapsportal.com/.
@@ -477,7 +478,7 @@
*/
/**
* @typedef {Object} ol.source.GeoJSONOptions
* @typedef {Object} olx.source.GeoJSONOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {ol.proj.ProjectionLike} defaultProjection Default projection.
* @property {ol.Extent|undefined} extent Extent.
@@ -490,7 +491,7 @@
*/
/**
* @typedef {Object} ol.source.MapGuideOptions
* @typedef {Object} olx.source.MapGuideOptions
* @property {string|undefined} url The mapagent url.
* @property {number|undefined} metersPerUnit The meters-per-unit value.
* @property {ol.Extent|undefined} extent Extent..
@@ -506,14 +507,14 @@
*/
/**
* @typedef {Object} ol.source.MapQuestOptions
* @typedef {Object} olx.source.MapQuestOptions
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
* function to load a tile given a URL.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.source.TileDebugOptions
* @typedef {Object} olx.source.TileDebugOptions
* @property {ol.Extent|undefined} extent Extent.
* @property {ol.proj.ProjectionLike} projection Projection.
* @property {ol.tilegrid.TileGrid|undefined} tileGrid Tile grid.
@@ -521,7 +522,7 @@
*/
/**
* @typedef {Object} ol.source.OSMOptions
* @typedef {Object} olx.source.OSMOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {number|undefined} maxZoom Max zoom.
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
@@ -533,7 +534,7 @@
*/
/**
* @typedef {Object} ol.source.ImageWMSOptions
* @typedef {Object} olx.source.ImageWMSOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests.
@@ -553,7 +554,7 @@
*/
/**
* @typedef {Object} ol.source.StamenOptions
* @typedef {Object} olx.source.StamenOptions
* @property {string} layer Layer.
* @property {number|undefined} minZoom Minimum zoom.
* @property {number|undefined} maxZoom Maximum zoom.
@@ -566,7 +567,7 @@
*/
/**
* @typedef {Object} ol.source.ImageStaticOptions
* @typedef {Object} olx.source.ImageStaticOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests.
@@ -579,7 +580,7 @@
*/
/**
* @typedef {Object} ol.source.TileJSONOptions
* @typedef {Object} olx.source.TileJSONOptions
* @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests.
* @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional
@@ -589,7 +590,7 @@
*/
/**
* @typedef {Object} ol.source.TileWMSOptions
* @typedef {Object} olx.source.TileWMSOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {Object.<string,*>} params WMS request parameters. At least a
* `LAYERS` param is required. `STYLES` is `` by default. `VERSION` is
@@ -598,6 +599,15 @@
* @property {null|string|undefined} crossOrigin crossOrigin setting for image
* requests.
* @property {ol.Extent|undefined} extent Extent.
* @property {number|undefined} gutter The size in pixels of the
* gutter around image tiles to ignore. By setting this property to a
* non-zero value, images will be requested that are wider and taller than
* the tile size by a value of `2 x gutter`. Defaults to zero. Using a
* non-zero value allows artifacts of rendering at tile edges to be ignored. If
* you control the WMS service it is recommended to address "artifacts at tile
* edges" issues by properly configuring the WMS service. For example, MapServer
* has a `tile_map_edge_buffer` configuration parameter for this. See
* http://mapserver.org/output/tile_mode.html.
* @property {string|undefined} logo Logo.
* @property {ol.tilegrid.TileGrid|undefined} tileGrid Tile grid.
* @property {number|undefined} maxZoom Maximum zoom.
@@ -611,7 +621,7 @@
*/
/**
* @typedef {Object} ol.source.VectorOptions
* @typedef {Object} olx.source.VectorOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {ol.Extent|undefined} extent Extent.
* @property {Array.<ol.Feature>|undefined} features Features.
@@ -621,7 +631,7 @@
*/
/**
* @typedef {Object} ol.source.VectorFileOptions
* @typedef {Object} olx.source.VectorFileOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {Document|undefined} doc Document.
* @property {ol.Extent|undefined} extent Extent.
@@ -635,7 +645,7 @@
*/
/**
* @typedef {Object} ol.source.WMTSOptions
* @typedef {Object} olx.source.WMTSOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {string|null|undefined} crossOrigin crossOrigin setting for image
* requests.
@@ -660,7 +670,7 @@
*/
/**
* @typedef {Object} ol.source.XYZOptions
* @typedef {Object} olx.source.XYZOptions
* @property {Array.<ol.Attribution>|undefined} attributions Attributions.
* @property {null|string|undefined} crossOrigin Cross origin setting for image
* requests.
@@ -681,13 +691,13 @@
*/
/**
* @typedef {Object} ol.style.FillOptions
* @typedef {Object} olx.style.FillOptions
* @property {ol.Color|string|undefined} color Color.
* @todo stability experimental
*/
/**
* @typedef {Object} ol.style.ImageOptions
* @typedef {Object} olx.style.ImageOptions
* @property {ol.Pixel} anchor Anchor.
* @property {null|string|undefined} crossOrigin crossOrigin setting for image.
* @property {HTMLCanvasElement|HTMLVideoElement|Image|undefined} image Image.
@@ -702,7 +712,7 @@
*/
/**
* @typedef {Object} ol.style.StrokeOptions
* @typedef {Object} olx.style.StrokeOptions
* @property {ol.Color|string|undefined} color Color.
* @property {string|undefined} lineCap Line cap style: `butt`, `round`, or `square`. Default is `butt`.
* @property {string|undefined} lineJoin Line join style: `bevel`, `round`, or `miter`. Default is `miter`.
@@ -713,7 +723,7 @@
*/
/**
* @typedef {Object} ol.style.TextOptions
* @typedef {Object} olx.style.TextOptions
* @property {string|undefined} font Font.
* @property {number|undefined} rotation Rotation.
* @property {string|undefined} text Text.
@@ -725,7 +735,7 @@
*/
/**
* @typedef {Object} ol.style.StyleOptions
* @typedef {Object} olx.style.StyleOptions
* @property {ol.style.Fill|undefined} fill Fill style.
* @property {ol.style.Image|undefined} image Image style.
* @property {ol.style.Stroke|undefined} stroke Stroke style.
@@ -735,7 +745,7 @@
*/
/**
* @typedef {Object} ol.tilegrid.TileGridOptions
* @typedef {Object} olx.tilegrid.TileGridOptions
* @property {number|undefined} minZoom Minimum zoom.
* @property {ol.Coordinate|undefined} origin Origin.
* @property {Array.<ol.Coordinate>|undefined} origins Origins.
@@ -746,7 +756,7 @@
*/
/**
* @typedef {Object} ol.tilegrid.WMTSOptions
* @typedef {Object} olx.tilegrid.WMTSOptions
* @property {ol.Coordinate|undefined} origin Origin.
* @property {Array.<ol.Coordinate>|undefined} origins Origins.
* @property {!Array.<number>} resolutions Resolutions.
@@ -757,7 +767,7 @@
*/
/**
* @typedef {Object} ol.tilegrid.XYZOptions
* @typedef {Object} olx.tilegrid.XYZOptions
* @property {number} maxZoom Maximum zoom.
* @todo stability experimental
*/