054af09032
This updates ESLint and our shared eslint-config-openlayers to use Prettier. Most formatting changes were automatically applied with this:
npm run lint -- --fix
A few manual changes were required:
* In `examples/offscreen-canvas.js`, the `//eslint-disable-line` comment needed to be moved to the appropriate line to disable the error about the `'worker-loader!./offscreen-canvas.worker.js'` import.
* In `examples/webpack/exapmle-builder.js`, spaces could not be added after a couple `function`s for some reason. While editing this, I reworked `ExampleBuilder` to be a class.
* In `src/ol/format/WMSGetFeatureInfo.js`, the `// @ts-ignore` comment needed to be moved down one line so it applied to the `parsersNS` argument.
79 lines
2.6 KiB
JavaScript
79 lines
2.6 KiB
JavaScript
/**
|
|
* @module ol/Map
|
|
*/
|
|
import CompositeMapRenderer from './renderer/Composite.js';
|
|
import PluggableMap from './PluggableMap.js';
|
|
import {assign} from './obj.js';
|
|
import {defaults as defaultControls} from './control.js';
|
|
import {defaults as defaultInteractions} from './interaction.js';
|
|
|
|
/**
|
|
* @classdesc
|
|
* The map is the core component of OpenLayers. For a map to render, a view,
|
|
* one or more layers, and a target container are needed:
|
|
*
|
|
* import Map from 'ol/Map';
|
|
* import View from 'ol/View';
|
|
* import TileLayer from 'ol/layer/Tile';
|
|
* import OSM from 'ol/source/OSM';
|
|
*
|
|
* var map = new Map({
|
|
* view: new View({
|
|
* center: [0, 0],
|
|
* zoom: 1
|
|
* }),
|
|
* layers: [
|
|
* new TileLayer({
|
|
* source: new OSM()
|
|
* })
|
|
* ],
|
|
* target: 'map'
|
|
* });
|
|
*
|
|
* The above snippet creates a map using a {@link module:ol/layer/Tile} to
|
|
* display {@link module:ol/source/OSM~OSM} OSM data and render it to a DOM
|
|
* element with the id `map`.
|
|
*
|
|
* The constructor places a viewport container (with CSS class name
|
|
* `ol-viewport`) in the target element (see `getViewport()`), and then two
|
|
* further elements within the viewport: one with CSS class name
|
|
* `ol-overlaycontainer-stopevent` for controls and some overlays, and one with
|
|
* CSS class name `ol-overlaycontainer` for other overlays (see the `stopEvent`
|
|
* option of {@link module:ol/Overlay~Overlay} for the difference). The map
|
|
* itself is placed in a further element within the viewport.
|
|
*
|
|
* Layers are stored as a {@link module:ol/Collection~Collection} in
|
|
* layerGroups. A top-level group is provided by the library. This is what is
|
|
* accessed by `getLayerGroup` and `setLayerGroup`. Layers entered in the
|
|
* options are added to this group, and `addLayer` and `removeLayer` change the
|
|
* layer collection in the group. `getLayers` is a convenience function for
|
|
* `getLayerGroup().getLayers()`. Note that {@link module:ol/layer/Group~Group}
|
|
* is a subclass of {@link module:ol/layer/Base}, so layers entered in the
|
|
* options or added with `addLayer` can be groups, which can contain further
|
|
* groups, and so on.
|
|
*
|
|
* @api
|
|
*/
|
|
class Map extends PluggableMap {
|
|
/**
|
|
* @param {import("./PluggableMap.js").MapOptions} options Map options.
|
|
*/
|
|
constructor(options) {
|
|
options = assign({}, options);
|
|
if (!options.controls) {
|
|
options.controls = defaultControls();
|
|
}
|
|
if (!options.interactions) {
|
|
options.interactions = defaultInteractions();
|
|
}
|
|
|
|
super(options);
|
|
}
|
|
|
|
createRenderer() {
|
|
return new CompositeMapRenderer(this);
|
|
}
|
|
}
|
|
|
|
export default Map;
|