From ae5581487577a37f5aa50ca07fd99d1cf7b616d3 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Mon, 7 May 2018 15:33:14 -0600 Subject: [PATCH] Use module paths in example docs --- examples/arcgis-tiled.html | 2 +- examples/bing-maps.html | 2 +- examples/box-selection.html | 2 +- examples/cluster.html | 2 +- examples/custom-interactions.html | 4 ++-- examples/d3.js | 2 +- examples/drag-and-drop-image-vector.html | 2 +- examples/draw-and-modify-features.html | 4 ++-- examples/draw-features.html | 2 +- examples/draw-freehand.html | 6 +++--- examples/draw-shapes.html | 4 ++-- examples/earthquake-clusters.html | 2 +- examples/earthquake-custom-symbol.html | 2 +- examples/getfeatureinfo-layers.html | 2 +- examples/heatmap-earthquakes.html | 2 +- examples/here-maps.html | 2 +- examples/icon-color.html | 2 +- examples/image-vector-layer.html | 2 +- examples/kml-timezones.html | 2 +- examples/kml.html | 2 +- examples/mousewheel-zoom.html | 4 ++-- examples/navigation-controls.html | 6 +++--- examples/osm-vector-tiles.html | 2 +- examples/pinch-zoom.html | 2 +- examples/popup.html | 2 +- examples/raster.html | 2 +- examples/region-growing.html | 2 +- examples/sea-level.html | 2 +- examples/shaded-relief.html | 2 +- examples/topojson.html | 2 +- examples/wms-custom-proj.html | 2 +- examples/xyz-esri-4326-512.html | 2 +- examples/xyz-esri.html | 2 +- examples/zoomslider.js | 2 +- 34 files changed, 42 insertions(+), 42 deletions(-) diff --git a/examples/arcgis-tiled.html b/examples/arcgis-tiled.html index 72ec115b97..576abf6b4d 100644 --- a/examples/arcgis-tiled.html +++ b/examples/arcgis-tiled.html @@ -6,7 +6,7 @@ docs: > This example shows how to use an ArcGIS REST MapService as tiles. This source type supports Map and Image Services. For cached ArcGIS services, better performance is available by using - ol.source.XYZ instead. + ol/source/XYZ instead. tags: arcgis, tile, tilelayer" ---
diff --git a/examples/bing-maps.html b/examples/bing-maps.html index 93db3cc0c4..ac66ba1fe9 100644 --- a/examples/bing-maps.html +++ b/examples/bing-maps.html @@ -3,7 +3,7 @@ layout: example.html title: Bing Maps shortdesc: Example of a Bing Maps layer. docs: > -

When the Bing Maps tile service doesn't have tiles for a given resolution and region it returns "placeholder" tiles indicating that. Zoom the map beyond level 19 to see the "placeholder" tiles. If you want OpenLayers to display stretched tiles in place of "placeholder" tiles beyond zoom level 19 then set maxZoom to 19 in the options passed to ol.source.BingMaps.

+

When the Bing Maps tile service doesn't have tiles for a given resolution and region it returns "placeholder" tiles indicating that. Zoom the map beyond level 19 to see the "placeholder" tiles. If you want OpenLayers to display stretched tiles in place of "placeholder" tiles beyond zoom level 19 then set maxZoom to 19 in the options passed to ol/source/BingMaps.

tags: "bing, bing-maps" cloak: - key: As1HiMj1PvLPlqc_gtM7AqZfBL8ZL3VrjaS3zIb22Uvb9WKhuJObROC-qUpa81U5 diff --git a/examples/box-selection.html b/examples/box-selection.html index 28e8d121c3..2660efa27c 100644 --- a/examples/box-selection.html +++ b/examples/box-selection.html @@ -4,7 +4,7 @@ title: Box Selection shortdesc: Using a DragBox interaction to select features. docs: >

This example shows how to use a DragBox interaction to select features. Selected features are added - to the feature overlay of a select interaction (ol.interaction.Select) for highlighting.

+ to the feature overlay of a select interaction (ol/interaction/Select) for highlighting.

Use Ctrl+Drag (Command+Drag on Mac) to draw boxes.

tags: "DragBox, feature, selection, box" --- diff --git a/examples/cluster.html b/examples/cluster.html index 813f63b8c6..65c39a2236 100644 --- a/examples/cluster.html +++ b/examples/cluster.html @@ -1,7 +1,7 @@ --- layout: example.html title: Clustered Features -shortdesc: Example of using ol.source.Cluster. +shortdesc: Example of using ol/source/Cluster. docs: > This example shows how to do clustering on point features. tags: "cluster, vector" diff --git a/examples/custom-interactions.html b/examples/custom-interactions.html index d73a85aaa8..908520101b 100644 --- a/examples/custom-interactions.html +++ b/examples/custom-interactions.html @@ -3,8 +3,8 @@ layout: example.html title: Custom Interactions shortdesc: Example of a custom interaction. docs: > - This example demonstrates creating a custom interaction by subclassing `ol.interaction.Pointer`. - Note that the built in interaction `ol.interaction.Translate` might be a better option for moving features. + This example demonstrates creating a custom interaction by subclassing `ol/interaction/Pointer`. + Note that the built in interaction `ol/interaction/Translate` might be a better option for moving features. tags: "drag, feature, vector, editing, custom, interaction" ---
diff --git a/examples/d3.js b/examples/d3.js index 778add595b..d26aaffb13 100644 --- a/examples/d3.js +++ b/examples/d3.js @@ -24,7 +24,7 @@ const map = new Map({ /** - * Load the topojson data and create an ol.layer.Image for that data. + * Load the topojson data and create an ol/layer/Image for that data. */ d3.json('data/topojson/us.json', function(error, us) { const features = topojson.feature(us, us.objects.counties); diff --git a/examples/drag-and-drop-image-vector.html b/examples/drag-and-drop-image-vector.html index 717f83b647..81d4457810 100644 --- a/examples/drag-and-drop-image-vector.html +++ b/examples/drag-and-drop-image-vector.html @@ -3,7 +3,7 @@ layout: example.html title: Drag-and-Drop Image Vector shortdesc: Example of using the drag-and-drop interaction with image vector rendering. docs: > - Example of using the drag-and-drop interaction with an `ol.layer.Vector` with `renderMode: 'image'``. Drag and drop GPX, GeoJSON, IGC, KML, or TopoJSON files on to the map. Each file is rendered to an image on the client. + Example of using the drag-and-drop interaction with an `ol/layer/Vector` with `renderMode: 'image'``. Drag and drop GPX, GeoJSON, IGC, KML, or TopoJSON files on to the map. Each file is rendered to an image on the client. tags: "drag-and-drop-image-vector, gpx, geojson, igc, kml, topojson, vector, image" cloak: - key: As1HiMj1PvLPlqc_gtM7AqZfBL8ZL3VrjaS3zIb22Uvb9WKhuJObROC-qUpa81U5 diff --git a/examples/draw-and-modify-features.html b/examples/draw-and-modify-features.html index 551a9d18a2..bf3ff2e7a4 100644 --- a/examples/draw-and-modify-features.html +++ b/examples/draw-and-modify-features.html @@ -1,9 +1,9 @@ --- layout: example.html title: Draw and Modify Features -shortdesc: Example of using the ol.interaction.Draw interaction together with the ol.interaction.Modify interaction. +shortdesc: Example of using the ol/interaction/Draw interaction together with the ol/interaction/Modify interaction. docs: > - Example of using the ol.interaction.Draw interaction together with the ol.interaction.Modify interaction. + Example of using the ol/interaction/Draw interaction together with the ol/interaction/Modify interaction. tags: "draw, edit, modify, vector, featureoverlay" ---
diff --git a/examples/draw-features.html b/examples/draw-features.html index 613a82a911..79481fbb9d 100644 --- a/examples/draw-features.html +++ b/examples/draw-features.html @@ -1,7 +1,7 @@ --- layout: example.html title: Draw Features -shortdesc: Example of using the ol.interaction.Draw interaction. +shortdesc: Example of using the ol/interaction/Draw interaction. docs: > Example of using the Draw interaction. Select a geometry type from the dropdown above to start drawing. To finish drawing, click the last diff --git a/examples/draw-freehand.html b/examples/draw-freehand.html index 76f830b287..8f6767a8a8 100644 --- a/examples/draw-freehand.html +++ b/examples/draw-freehand.html @@ -1,13 +1,13 @@ --- layout: example.html title: Freehand Drawing -shortdesc: Example using the ol.interaction.Draw interaction in freehand mode. +shortdesc: Example using the ol/interaction/Draw interaction in freehand mode. docs: > - This example demonstrates the `ol.interaction.Draw` in freehand mode. During + This example demonstrates the `ol/interaction/Draw` in freehand mode. During freehand drawing, points are added while dragging. Set `freehand: true` to enable freehand mode. Note that freehand mode can be conditionally enabled by using the `freehandCondition` option. For example to toggle freehand mode - with the `Shift` key, use `freehandCondition: ol.events.condition.shiftKeyOnly`. + with the `Shift` key, use `freehandCondition: shiftKeyOnly`. tags: "draw, edit, freehand, vector" ---
diff --git a/examples/draw-shapes.html b/examples/draw-shapes.html index 19501e090c..0ceead0499 100644 --- a/examples/draw-shapes.html +++ b/examples/draw-shapes.html @@ -1,10 +1,10 @@ --- layout: example.html title: Draw Shapes -shortdesc: Using the ol.interaction.Draw to create regular shapes +shortdesc: Using the ol/interaction/Draw to create regular shapes docs: > This demonstrates the use of the `geometryFunction` option for the - `ol.interaction.Draw`. Select a shape type from the dropdown above to start + `ol/interaction/Draw`. Select a shape type from the dropdown above to start drawing. To activate freehand drawing, hold the `Shift` key. Square drawing is achieved by using `type: 'Circle'` type with a `geometryFunction` that creates a 4-sided regular polygon instead of a circle. Box drawing uses `type: 'Circle'` diff --git a/examples/earthquake-clusters.html b/examples/earthquake-clusters.html index 667b829683..773711a2b3 100644 --- a/examples/earthquake-clusters.html +++ b/examples/earthquake-clusters.html @@ -6,7 +6,7 @@ docs: >

This example parses a KML file and renders the features as clusters on a vector layer. The styling in this example is quite involved. Single earthquake locations (rendered as stars) have a size relative to their magnitude. Clusters have an opacity relative to the number of features in the cluster, and a size that represents the extent of the features that make up the cluster. When clicking or hovering on a cluster, the individual features that make up the cluster will be shown.

-

To achieve this, we make heavy use of style functions and ol.style.Style#geometry.

+

To achieve this, we make heavy use of style functions.

tags: "KML, vector, style, geometry, cluster" ---
diff --git a/examples/earthquake-custom-symbol.html b/examples/earthquake-custom-symbol.html index d3f1a0dcd9..729d8eb3e7 100644 --- a/examples/earthquake-custom-symbol.html +++ b/examples/earthquake-custom-symbol.html @@ -1,7 +1,7 @@ --- layout: example.html title: Earthquakes with custom symbols -shortdesc: Demonstrates the use of `ol.render.toCanvas` to create custom icon symbols. +shortdesc: Demonstrates the use of `toCanvas` to create custom icon symbols. docs: > This example parses a KML file and renders the features as a vector layer. The layer is given a style that renders earthquake locations with a custom lightning symbol and a size relative to their magnitude. tags: "KML, vector, style, canvas, symbol" diff --git a/examples/getfeatureinfo-layers.html b/examples/getfeatureinfo-layers.html index 8c48c294ae..3173a15329 100644 --- a/examples/getfeatureinfo-layers.html +++ b/examples/getfeatureinfo-layers.html @@ -6,7 +6,7 @@ shortdesc: > request docs: > Demonstrates the use of the `layers` option in the - `ol.format.WMSGetFeatureInfo` format object, which allows features returned + `ol/format/WMSGetFeatureInfo` format object, which allows features returned by a single WMS GetFeatureInfo request that asks for more than one layer to be read by layer name. --- diff --git a/examples/heatmap-earthquakes.html b/examples/heatmap-earthquakes.html index d670888d12..612b1206fc 100644 --- a/examples/heatmap-earthquakes.html +++ b/examples/heatmap-earthquakes.html @@ -3,7 +3,7 @@ layout: example.html title: Earthquakes Heatmap shortdesc: Demonstrates the use of a heatmap layer. docs: > - This example parses a KML file and renders the features as a ol.layer.Heatmap layer. + This example parses a KML file and renders the features as a ol/layer/Heatmap layer. tags: "heatmap, kml, vector, style" ---
diff --git a/examples/here-maps.html b/examples/here-maps.html index 3349a5f365..61df8fa4d2 100644 --- a/examples/here-maps.html +++ b/examples/here-maps.html @@ -3,7 +3,7 @@ layout: example.html title: HERE Map Tile API shortdesc: Example of a map with map tiles from HERE. docs: > -

HERE Map Tile API used with ol.source.XYZ.

+

HERE Map Tile API used with ol/source/XYZ.

Be sure to respect the HERE Service Terms when using their tile API.

tags: "here, here-maps, here-tile-api" cloak: diff --git a/examples/icon-color.html b/examples/icon-color.html index 04a98626de..f102fb16a2 100644 --- a/examples/icon-color.html +++ b/examples/icon-color.html @@ -4,7 +4,7 @@ title: Icon Colors shortdesc: Example assigning a custom color to an icon docs: > Example assigning a custom color to an icon. The features in this examples are all using the same image with the different colors coming from the javascript file. - Note that icon files need to obey the same origin policy or send proper CORS headers for this to work. When relying on CORS headers, the `ol.style.Icon` must be configured with `crossOrigin: 'anonymous'`. + Note that icon files need to obey the same origin policy or send proper CORS headers for this to work. When relying on CORS headers, the `ol/style/Icon` must be configured with `crossOrigin: 'anonymous'`. tags: "vector, style, icon, marker" resources: --- diff --git a/examples/image-vector-layer.html b/examples/image-vector-layer.html index ecd3444b74..99613624d3 100644 --- a/examples/image-vector-layer.html +++ b/examples/image-vector-layer.html @@ -3,7 +3,7 @@ layout: example.html title: Image Vector Layer shortdesc: Example of an image vector layer. docs: > -

This example uses ol.layer.Vector with `renderMode: 'image'`. This mode results in faster rendering during interaction and animations, at the cost of less accurate rendering.

+

This example uses ol/layer/Vector with `renderMode: 'image'`. This mode results in faster rendering during interaction and animations, at the cost of less accurate rendering.

tags: "vector, image" ---
diff --git a/examples/kml-timezones.html b/examples/kml-timezones.html index abd5410367..67b8943ae3 100644 --- a/examples/kml-timezones.html +++ b/examples/kml-timezones.html @@ -3,7 +3,7 @@ layout: example.html title: Timezones in KML shortdesc: Demonstrates rendering timezones from KML. docs: > - This example parses a KML file and renders the features as a vector layer. The layer is given a ol.style.Style that fills timezones + This example parses a KML file and renders the features as a vector layer. The layer is given a ol/style/Style that fills timezones yellow with an opacity calculated based on the current offset to local noon. tags: "KML, vector, style" resources: diff --git a/examples/kml.html b/examples/kml.html index afc93cf25f..74cb28ecb3 100644 --- a/examples/kml.html +++ b/examples/kml.html @@ -3,7 +3,7 @@ layout: example.html title: KML shortdesc: Rendering KML with a vector source. docs: > - This example uses the ol.format.KML to parse KML for rendering with a vector source. + This example uses the ol/format/KML to parse KML for rendering with a vector source. tags: "KML" cloak: - key: As1HiMj1PvLPlqc_gtM7AqZfBL8ZL3VrjaS3zIb22Uvb9WKhuJObROC-qUpa81U5 diff --git a/examples/mousewheel-zoom.html b/examples/mousewheel-zoom.html index 1e20bba4da..6ddee867f7 100644 --- a/examples/mousewheel-zoom.html +++ b/examples/mousewheel-zoom.html @@ -3,12 +3,12 @@ layout: example.html title: Mousewheel/Trackpad Zoom shortdesc: Shows advanced wheel/trackpad zoom options. docs: > - This example uses a custom `ol.interaction.MouseWheelZoom` configuration: + This example uses a custom `ol/interaction/MouseWheelZoom` configuration: * By default, wheel/trackpad zoom is always active, which can be unexpected on pages with a lot of scrollable content and an embedded map. To perform wheel/trackpad zoom actions only when the map has the focus, set - `condition: ol.events.condition.focus` as constructor option. This requires + `condition: focus` as constructor option. This requires a map div with a `tabindex` attribute set. * By default, the interaction can leave the map at fractional zoom levels. If instead you want to constrain wheel/trackpad zooming to integer zoom diff --git a/examples/navigation-controls.html b/examples/navigation-controls.html index 0906e425f7..b7be536dba 100644 --- a/examples/navigation-controls.html +++ b/examples/navigation-controls.html @@ -3,11 +3,11 @@ layout: example.html title: Navigation Controls shortdesc: Shows how to add navigation controls. docs: > -

This example shows how to use the ol.control.ZoomToExtent control.

+

This example shows how to use the ol/control/ZoomToExtent control.

The following navigation controls are added to the map:

tags: "control, navigation, extent" --- diff --git a/examples/osm-vector-tiles.html b/examples/osm-vector-tiles.html index c026fe0e5c..6012be721b 100644 --- a/examples/osm-vector-tiles.html +++ b/examples/osm-vector-tiles.html @@ -3,7 +3,7 @@ layout: example.html title: OSM Vector Tiles shortdesc: Using OpenStreetMap vector tiles. docs: > - A simple vector tiles map with Mapzen vector tiles. This example uses the TopoJSON format's `layerName` option to determine the layer ("water", "roads", "buildings") for styling. **Note**: [`ol.format.MVT`](../apidoc/ol.format.MVT.html) is an even more efficient format for vector tiles. + A simple vector tiles map with Mapzen vector tiles. This example uses the TopoJSON format's `layerName` option to determine the layer ("water", "roads", "buildings") for styling. **Note**: [`ol/format/MVT`] is an even more efficient format for vector tiles. tags: "vector, tiles, osm, mapzen" cloak: - key: vector-tiles-5eJz6JX diff --git a/examples/pinch-zoom.html b/examples/pinch-zoom.html index ca434a64fd..ab61eef6fc 100644 --- a/examples/pinch-zoom.html +++ b/examples/pinch-zoom.html @@ -3,7 +3,7 @@ layout: example.html title: Pinch Zoom shortdesc: Restrict pinch zooming to integer zoom levels. docs: > - By default, the `ol.interaction.PinchZoom` can leave the map at fractional zoom levels. + By default, the `ol/interaction/PinchZoom` can leave the map at fractional zoom levels. If instead you want to constrain pinch zooming to integer zoom levels, set constrainResolution: true when constructing the interaction. tags: "pinch, zoom, interaction" diff --git a/examples/popup.html b/examples/popup.html index ed9fc2f751..eaa0924f63 100644 --- a/examples/popup.html +++ b/examples/popup.html @@ -4,7 +4,7 @@ title: Popup shortdesc: Uses an overlay to create a popup. docs: >

- Click on the map to get a popup. The popup is composed of a few basic elements: a container, a close button, and a place for the content. To anchor the popup to the map, an ol.Overlay is created with the popup container. A listener is registered for the map's click event to display the popup, and another listener is set as the click handler for the close button to hide the popup. + Click on the map to get a popup. The popup is composed of a few basic elements: a container, a close button, and a place for the content. To anchor the popup to the map, an ol/Overlay is created with the popup container. A listener is registered for the map's click event to display the popup, and another listener is set as the click handler for the close button to hide the popup.

tags: "overlay, popup" --- diff --git a/examples/raster.html b/examples/raster.html index 564841b47a..27783106d9 100644 --- a/examples/raster.html +++ b/examples/raster.html @@ -4,7 +4,7 @@ title: Raster Source shortdesc: Demonstrates pixelwise operations with a raster source. docs: >

- This example uses a ol.source.Raster to generate data + This example uses a ol/source/Raster to generate data based on another source. The raster source accepts any number of input sources (tile or image based) and runs a pipeline of operations on the input pixels. The return from the final diff --git a/examples/region-growing.html b/examples/region-growing.html index edc14faaf0..f84faf786c 100644 --- a/examples/region-growing.html +++ b/examples/region-growing.html @@ -5,7 +5,7 @@ shortdesc: Grow a region from a seed pixel docs: >

Click a region on the map. The computed region will be red.

- This example uses a ol.source.Raster to generate data + This example uses a ol/source/Raster to generate data based on another source. The raster source accepts any number of input sources (tile or image based) and runs a pipeline of operations on the input data. The return from the final diff --git a/examples/sea-level.html b/examples/sea-level.html index c8b5f57282..401370981e 100644 --- a/examples/sea-level.html +++ b/examples/sea-level.html @@ -4,7 +4,7 @@ title: Sea Level shortdesc: Render sea level at different elevations docs: >

- This example uses a ol.source.Raster with + This example uses a ol/source/Raster with Mapbox Terrain-RGB tiles to "flood" areas below the elevation shown on the sea level slider.

diff --git a/examples/shaded-relief.html b/examples/shaded-relief.html index 1d8c0b46da..116040ccb8 100644 --- a/examples/shaded-relief.html +++ b/examples/shaded-relief.html @@ -4,7 +4,7 @@ title: Shaded Relief shortdesc: Calculate shaded relief from elevation data docs: >

- This example uses a ol.source.Raster to generate data + This example uses a ol/source/Raster to generate data based on another source. The raster source accepts any number of input sources (tile or image based) and runs a pipeline of operations on the input data. The return from the final diff --git a/examples/topojson.html b/examples/topojson.html index 1d9038bb59..c679c7a5f1 100644 --- a/examples/topojson.html +++ b/examples/topojson.html @@ -3,7 +3,7 @@ layout: example.html title: TopoJSON shortdesc: Demonstrates rendering of features from a TopoJSON topology. docs: > - This example uses a vector layer with `ol.format.TopoJSON` for rendering features from [TopoJSON](https://github.com/mbostock/topojson/wiki). + This example uses a vector layer with `ol/format/TopoJSON` for rendering features from [TopoJSON](https://github.com/mbostock/topojson/wiki). tags: "topojson, vector, style" ---

diff --git a/examples/wms-custom-proj.html b/examples/wms-custom-proj.html index a799d9bebd..889b3ca0b9 100644 --- a/examples/wms-custom-proj.html +++ b/examples/wms-custom-proj.html @@ -3,7 +3,7 @@ layout: example.html title: Custom Tiled WMS shortdesc: Example of using custom coordinate transform functions. docs: > - With `ol.proj.addCoordinateTransforms()`, custom coordinate transform functions can be added to configured projections. + With `addCoordinateTransforms()`, custom coordinate transform functions can be added to configured projections. tags: "wms, tile, tilelayer, projection" ---
diff --git a/examples/xyz-esri-4326-512.html b/examples/xyz-esri-4326-512.html index 88df1436dd..94225e4c71 100644 --- a/examples/xyz-esri-4326-512.html +++ b/examples/xyz-esri-4326-512.html @@ -3,7 +3,7 @@ layout: example.html title: ArcGIS REST with 512x512 Tiles shortdesc: Example of a XYZ source in EPSG:4326 using Esri 512x512 tiles. docs: > - ArcGIS REST tile services with custom tile sizes (here: 512x512 pixels) and projection (here: EPSG:4326) are supported by `ol.source.XYZ`. A custom tile url function is used to handle zoom level offsets. + ArcGIS REST tile services with custom tile sizes (here: 512x512 pixels) and projection (here: EPSG:4326) are supported by `ol/source/XYZ`. A custom tile url function is used to handle zoom level offsets. tags: "xyz, esri, tilesize, custom projection" ---
diff --git a/examples/xyz-esri.html b/examples/xyz-esri.html index 902496a7c0..702f92996e 100644 --- a/examples/xyz-esri.html +++ b/examples/xyz-esri.html @@ -3,7 +3,7 @@ layout: example.html title: XYZ Esri shortdesc: Example of a XYZ source using Esri tiles. docs: > - ArcGIS REST tile services are supported by `ol.source.XYZ`. + ArcGIS REST tile services are supported by `ol/source/XYZ`. tags: "xyz, esri, arcgis rest" ---
diff --git a/examples/zoomslider.js b/examples/zoomslider.js index 3505ba58a0..33e53e599d 100644 --- a/examples/zoomslider.js +++ b/examples/zoomslider.js @@ -9,7 +9,7 @@ import OSM from '../src/ol/source/OSM.js'; * Helper method for map-creation. * * @param {string} divId The id of the div for the map. - * @return {ol.PluggableMap} The ol.Map instance. + * @return {ol.PluggableMap} The map instance. */ function createMap(divId) { const source = new OSM();