ol 7.5.1 → 8.0.0-dev.1692053484481

package/source/wms.js

@@ -2,6 +2,16 @@
  * @module ol/source/wms
  */
 
+import {DECIMALS} from './common.js';
+import {appendParams} from '../uri.js';
+import {assert} from '../asserts.js';
+import {compareVersions} from '../string.js';
+import {decode} from '../Image.js';
+import {getHeight, getWidth} from '../extent.js';
+import {get as getProjection} from '../proj.js';
+import {getRequestExtent} from './Image.js';
+import {round} from '../math.js';
+
 /**
  * Default WMS version.
  * @type {string}
@@ -17,3 +27,163 @@ export const DEFAULT_VERSION = '1.3.0';
  *  - `'mapserver'`: HiDPI support for [MapServer](https://mapserver.org/)
  *  - `'qgis'`: HiDPI support for [QGIS](https://qgis.org/)
  */
+
+/**
+ * @param {string} baseUrl Base URL.
+ * @param {import("../extent.js").Extent} extent Extent.
+ * @param {import("../size.js").Size} size Size.
+ * @param {import("../proj/Projection.js").default} projection Projection.
+ * @param {Object} params WMS params. Will be modified in place.
+ * @return {string} Request URL.
+ */
+export function getRequestUrl(baseUrl, extent, size, projection, params) {
+  params['WIDTH'] = size[0];
+  params['HEIGHT'] = size[1];
+
+  const axisOrientation = projection.getAxisOrientation();
+  let bbox;
+  const v13 = compareVersions(params['VERSION'], '1.3') >= 0;
+  params[v13 ? 'CRS' : 'SRS'] = projection.getCode();
+  if (v13 && axisOrientation.substr(0, 2) == 'ne') {
+    bbox = [extent[1], extent[0], extent[3], extent[2]];
+  } else {
+    bbox = extent;
+  }
+  params['BBOX'] = bbox.join(',');
+
+  return appendParams(/** @type {string} */ (baseUrl), params);
+}
+
+/**
+ * @param {import("../extent").Extent} extent Extent.
+ * @param {number} resolution Resolution.
+ * @param {number} pixelRatio pixel ratio.
+ * @param {import("../proj.js").Projection} projection Projection.
+ * @param {string} url WMS service url.
+ * @param {Object} params WMS params.
+ * @param {import("./wms.js").ServerType} serverType The type of the remote WMS server.
+ * @return {string} Image src.
+ */
+export function getImageSrc(
+  extent,
+  resolution,
+  pixelRatio,
+  projection,
+  url,
+  params,
+  serverType
+) {
+  params = Object.assign({REQUEST: 'GetMap'}, params);
+
+  const imageResolution = resolution / pixelRatio;
+
+  const imageSize = [
+    round(getWidth(extent) / imageResolution, DECIMALS),
+    round(getHeight(extent) / imageResolution, DECIMALS),
+  ];
+
+  if (pixelRatio != 1) {
+    switch (serverType) {
+      case 'geoserver':
+        const dpi = (90 * pixelRatio + 0.5) | 0;
+        if ('FORMAT_OPTIONS' in params) {
+          params['FORMAT_OPTIONS'] += ';dpi:' + dpi;
+        } else {
+          params['FORMAT_OPTIONS'] = 'dpi:' + dpi;
+        }
+        break;
+      case 'mapserver':
+        params['MAP_RESOLUTION'] = 90 * pixelRatio;
+        break;
+      case 'carmentaserver':
+      case 'qgis':
+        params['DPI'] = 90 * pixelRatio;
+        break;
+      default: // Unknown `serverType` configured
+        assert(false, 8);
+        break;
+    }
+  }
+
+  const src = getRequestUrl(url, extent, imageSize, projection, params);
+  return src;
+}
+
+/**
+ * @param {Object} params WMS params.
+ * @param {string} request WMS `REQUEST`.
+ * @return {Object} WMS params with required properties set.
+ */
+export function getRequestParams(params, request) {
+  return Object.assign(
+    {
+      'REQUEST': request,
+      'SERVICE': 'WMS',
+      'VERSION': DEFAULT_VERSION,
+      'FORMAT': 'image/png',
+      'STYLES': '',
+      'TRANSPARENT': true,
+    },
+    params
+  );
+}
+
+/**
+ * @typedef {Object} LoaderOptions
+ * @property {null|string} [crossOrigin] The `crossOrigin` attribute for loaded images.  Note that
+ * you must provide a `crossOrigin` value if you want to access pixel data with the Canvas renderer.
+ * See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
+ * @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting
+ * the image from the remote server.
+ * @property {Object<string,*>} [params] WMS request parameters.
+ * At least a `LAYERS` param is required. `STYLES` is
+ * `''` by default. `VERSION` is `1.3.0` by default. `WIDTH`, `HEIGHT` and `BBOX` will be set
+ * dynamically. `CRS` (`SRS` for WMS version < 1.3.0) will is derived from the `proection` config.
+ * @property {import("../proj.js").ProjectionLike} [projection] Projection. Default is 'EPSG:3857'.
+ * @property {number} [ratio=1.5] Ratio. `1` means image requests are the size of the map viewport, `2` means
+ * twice the width and height of the map viewport, and so on. Must be `1` or higher.
+ * @property {import("./wms.js").ServerType} [serverType] The type of
+ * the remote WMS server: `mapserver`, `geoserver`, `carmentaserver`, or `qgis`.
+ * Only needed if `hidpi` is `true`.
+ * @property {string} url WMS service URL.
+ * @property {function(HTMLImageElement, string): Promise<import('../DataTile.js').ImageLike>} [load] Function
+ * to perform loading of the image. Receives the created `HTMLImageElement` and the desired `src` as argument and
+ * returns a promise resolving to the loaded or decoded image. Default is {@link module:ol/Image.decode}.
+ */
+
+/**
+ * Creates a loader for WMS images.
+ * @param {LoaderOptions} options Loader options.
+ * @return {import("../Image.js").ImageObjectPromiseLoader} Loader.
+ * @api
+ */
+export function createLoader(options) {
+  const hidpi = options.hidpi === undefined ? true : options.hidpi;
+  const projection = getProjection(options.projection || 'EPSG:3857');
+  const ratio = options.ratio || 1.5;
+  const load = options.load || decode;
+
+  /**
+   * @type {import("../Image.js").Loader}
+   */
+  return (extent, resolution, pixelRatio) => {
+    extent = getRequestExtent(extent, resolution, pixelRatio, ratio);
+    if (pixelRatio != 1 && (!hidpi || options.serverType === undefined)) {
+      pixelRatio = 1;
+    }
+    const src = getImageSrc(
+      extent,
+      resolution,
+      pixelRatio,
+      projection,
+      options.url,
+      getRequestParams(options.params, 'GetMap'),
+      options.serverType
+    );
+    const image = new Image();
+    if (options.crossOrigin !== null) {
+      image.crossOrigin = options.crossOrigin;
+    }
+    return load(image, src).then((image) => ({image, extent, pixelRatio}));
+  };
+}

package/source.d.ts

@@ -28,7 +28,7 @@ export { default as OGCVectorTile } from "./source/OGCVectorTile.js";
 export { default as OSM } from "./source/OSM.js";
 export { default as Raster } from "./source/Raster.js";
 export { default as Source } from "./source/Source.js";
-export { default as Stamen } from "./source/Stamen.js";
+export { default as StadiaMaps } from "./source/StadiaMaps.js";
 export { default as Tile } from "./source/Tile.js";
 export { default as TileArcGISRest } from "./source/TileArcGISRest.js";
 export { default as TileDebug } from "./source/TileDebug.js";
@@ -42,4 +42,8 @@ export { default as VectorTile } from "./source/VectorTile.js";
 export { default as WMTS } from "./source/WMTS.js";
 export { default as XYZ } from "./source/XYZ.js";
 export { default as Zoomify } from "./source/Zoomify.js";
+export { createLoader as createWMSLoader } from "./source/wms.js";
+export { createLoader as createArcGISRestLoader } from "./source/arcgisRest.js";
+export { createLoader as creaetStaticLoader } from "./source/static.js";
+export { createLoader as createMapGuideLoader } from "./source/mapguide.js";
 //# sourceMappingURL=source.d.ts.map

package/source.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["source.js"],"names":[],"mappings":"AAuCA;;;;;;;;;;;GAWG;AACH,8CATW,OAAO,wBAAwB,EAAE,OAAO,kBAC/B,OAAO,gBAAgB,EAAE,SAAS,KAAG,OAAO,oBAAoB,EAAE,OAAO,UAKxE,OAAO,aAAa,EAAE,MAAM,QAAE,MAAM,KAAG,MAAM,OAAO,oBAAoB,EAAE,OAAO,CAAC,CAuBtG"}
+{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["source.js"],"names":[],"mappings":"AA2CA;;;;;;;;;;;GAWG;AACH,8CATW,OAAO,wBAAwB,EAAE,OAAO,kBAC/B,OAAO,gBAAgB,EAAE,SAAS,KAAG,OAAO,oBAAoB,EAAE,OAAO,UAKxE,OAAO,aAAa,EAAE,MAAM,QAAE,MAAM,KAAG,MAAM,OAAO,oBAAoB,EAAE,OAAO,CAAC,CAuBtG"}

package/source.js

@@ -22,7 +22,7 @@ export {default as OGCVectorTile} from './source/OGCVectorTile.js';
 export {default as OSM} from './source/OSM.js';
 export {default as Raster} from './source/Raster.js';
 export {default as Source} from './source/Source.js';
-export {default as Stamen} from './source/Stamen.js';
+export {default as StadiaMaps} from './source/StadiaMaps.js';
 export {default as Tile} from './source/Tile.js';
 export {default as TileArcGISRest} from './source/TileArcGISRest.js';
 export {default as TileDebug} from './source/TileDebug.js';
@@ -36,6 +36,10 @@ export {default as VectorTile} from './source/VectorTile.js';
 export {default as WMTS} from './source/WMTS.js';
 export {default as XYZ} from './source/XYZ.js';
 export {default as Zoomify} from './source/Zoomify.js';
+export {createLoader as createWMSLoader} from './source/wms.js';
+export {createLoader as createArcGISRestLoader} from './source/arcgisRest.js';
+export {createLoader as creaetStaticLoader} from './source/static.js';
+export {createLoader as createMapGuideLoader} from './source/mapguide.js';
 
 /**
  * Creates a sources function from a tile grid. This function can be used as value for the