diff --git a/config/jsdoc/api/index.md b/config/jsdoc/api/index.md index 8fc67508ec..45514dafc2 100644 --- a/config/jsdoc/api/index.md +++ b/config/jsdoc/api/index.md @@ -1,43 +1,43 @@ - + - +View with center, projection, resolution and rotation + - - +Map default interactions
+Interactions for vector features + +All interactions + - - + +ol/Geolocation
+ol/Overlay
MapViewLayers

A [map](module-ol_Map-Map.html) is made of [layers](module-ol_layer_Base-BaseLayer.html), a [view](module-ol_View-View.html) to visualize them, [interactions](module-ol_interaction_Interaction-Interaction.html) to modify map content and [controls](module-ol_control_Control-Control.html) with UI components.

-[Overview](module-ol_Map-Map.html)
-[Creation](module-ol_Map-Map.html#Map)
-[Events](module-ol_MapBrowserEvent-MapBrowserEvent.html)

A map is made of layers, a view to visualize them, interactions to modify map content and controls with UI components.

+Overview
+Creation
+Events

The view manages the visual parameters of the map view, like resolution or rotation.

-[View](module-ol_View-View.html) with center, projection, resolution and rotation

Layers are lightweight containers that get their data from [sources](module-ol_source_Source-Source.html).

-[ol/layer/Tile](module-ol_layer_Tile-TileLayer.html)
-[ol/layer/Image](module-ol_layer_Image-ImageLayer.html)
-[ol/layer/Vector](module-ol_layer_Vector-VectorLayer.html)
-[ol/layer/VectorTile](module-ol_layer_VectorTile-VectorTileLayer.html)

Layers are lightweight containers that get their data from sources.

+ol/layer/Tile
+ol/layer/Image
+ol/layer/Vector
+ol/layer/VectorTile
ControlsInteractionsSources and formats
[Map default controls](module-ol_control_util.html#.defaults)
-[All controls](module-ol_control_Control-Control.html) +		Map default controls
+All controls 		-[Map default interactions](module-ol_interaction.html#~defaults)
-Interactions for [vector features](module-ol_Feature-Feature.html) -
  • [ol/interaction/Select](module-ol_interaction_Select-Select.html)
    • -
  • [ol/interaction/Draw](module-ol_interaction_Draw-Draw.html)
    • -
  • [ol/interaction/Modify](module-ol_interaction_Modify-Modify.html)
-[All interactions](module-ol_interaction_Interaction-Interaction.html)		[Tile sources](module-ol_source_Tile-TileSource.html) for [ol/layer/Tile](module-ol_layer_Tile-TileLayer.html) -
[Image sources](module-ol_source_Image-ImageSource.html) for [ol/layer/Image](module-ol_layer_Image-ImageLayer.html) -
[Vector sources](module-ol_source_Vector-VectorSource.html) for [ol/layer/Vector](module-ol_layer_Vector-VectorLayer.html) -
[Vector tile sources](module-ol_source_VectorTile-VectorTile.html) for [ol/layer/VectorTile](module-ol_layer_VectorTile-VectorTileLayer.html) -
[Formats](module-ol_format_Feature-FeatureFormat.html) for reading/writing vector data -
[ol/format/WMSCapabilities](module-ol_format_WMSCapabilities-WMSCapabilities.html)
Tile sources for ol/layer/Tile +
Image sources for ol/layer/Image +
Vector sources for ol/layer/Vector +
Vector tile sources for ol/layer/VectorTile +
Formats for reading/writing vector data +
ol/format/WMSCapabilities
ProjectionsObservable objectsOther components

All coordinates and extents need to be provided in view projection (default: EPSG:3857). To transform, use [ol/proj#transform()](module-ol_proj.html#.transform) and [ol/proj#transformExtent()](module-ol_proj.html#.transformExtent).

-[ol/proj](module-ol_proj.html)

Changes to all [ol/Object](module-ol_Object-BaseObject.html)s can be observed by calling the [object.on('propertychange')](module-ol_Object-BaseObject.html#on) method. Listeners receive an [ol/Object.ObjectEvent](module-ol_Object-ObjectEvent.html) with information on the changed property and old value.

+

All coordinates and extents need to be provided in view projection (default: EPSG:3857). To transform, use ol/proj#transform() and ol/proj#transformExtent().

+ol/proj

Changes to all ol/Objects can be observed by calling the object.on('propertychange') method. Listeners receive an ol/Object.ObjectEvent with information on the changed property and old value.

 -[ol/Geolocation](module-ol_Geolocation.html)
-[ol/Overlay](module-ol_Overlay-Overlay.html)
  diff --git a/package.json b/package.json index d96d680ee1..25f84e5bfe 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "copy-css": "shx cp src/ol/ol.css build/ol/ol.css", "transpile": "shx rm -rf build/ol && shx mkdir -p build/ol && shx cp -rf src/ol build/ol/src && tsc --project config/tsconfig-build.json", "typecheck": "tsc --pretty", - "apidoc": "jsdoc config/jsdoc/api/index.md -c config/jsdoc/api/conf.json -P package.json -d build/apidoc" + "apidoc": "jsdoc -R config/jsdoc/api/index.md -c config/jsdoc/api/conf.json -P package.json -d build/apidoc" }, "main": "index.js", "repository": { @@ -68,8 +68,8 @@ "istanbul": "0.4.5", "istanbul-instrumenter-loader": "^3.0.1", "jquery": "3.4.1", - "jsdoc": "3.5.5", - "jsdoc-plugin-typescript": "^1.0.8", + "jsdoc": "3.6.1", + "jsdoc-plugin-typescript": "^2.0.0", "karma": "^4.0.1", "karma-chrome-launcher": "2.2.0", "karma-coverage": "^1.1.2",