ol 10.3.2-dev.1738093069363 → 10.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ol",
-  "version": "10.3.2-dev.1738093069363",
+  "version": "10.4.0",
   "description": "OpenLayers mapping library",
   "keywords": [
     "map",

package/source/mapserver.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Creates a loader for MapServer images generated using the CGI interface,
+ * which predates OGC services. It is **strongly** recommended to configure
+ * MapServer to use WMS, and use the WMS createLoader.
+ * @param {LoaderOptions} options LoaderOptions Options.
+ * @return {import('../Image.js').ImageObjectPromiseLoader} MapServer image.
+ * @api
+ */
+export function createLoader(options: LoaderOptions): import("../Image.js").ImageObjectPromiseLoader;
+export type LoaderOptions = {
+    /**
+     * The MapServer url.
+     */
+    url: string;
+    /**
+     * 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.
+     * the image from the remote server.
+     */
+    crossOrigin?: string | null | undefined;
+    /**
+     * 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.
+     */
+    ratio?: number | undefined;
+    /**
+     * Additional query parameters.
+     */
+    params?: any;
+    /**
+     * 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}.
+     */
+    load?: ((arg0: HTMLImageElement, arg1: string) => Promise<import("../DataTile.js").ImageLike>) | undefined;
+};
+//# sourceMappingURL=mapserver.d.ts.map

package/source/mapserver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapserver.d.ts","sourceRoot":"","sources":["mapserver.js"],"names":[],"mappings":"AAmDA;;;;;;;GAOG;AACH,sCAJW,aAAa,GACZ,OAAO,aAAa,EAAE,wBAAwB,CAmBzD;;;;;SAhEa,MAAM;;;;;;;;;;;;;;;;;;;;;;mBAQG,gBAAgB,QAAE,MAAM,KAAG,OAAO,CAAC,OAAO,gBAAgB,EAAE,SAAS,CAAC"}

package/source/mapserver.js

@@ -0,0 +1,76 @@
+/**
+ * @module ol/source/mapserver
+ */
+
+import {decode} from '../Image.js';
+import {getHeight, getWidth} from '../extent.js';
+import {appendParams} from '../uri.js';
+import {getRequestExtent} from './Image.js';
+
+/**
+ * @typedef {Object} LoaderOptions
+ * @property {string} url The MapServer url.
+ * @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.
+ * the image from the remote server.
+ * @property {number} [ratio=1] 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 {Object} [params] Additional query parameters.
+ * @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}.
+ */
+
+/**
+ * @param {string} baseUrl The MapServer url.
+ * @param {Object<string, string|number>} params Request parameters.
+ * @param {import("../extent.js").Extent} extent Extent.
+ * @param {import("../size.js").Size} size Size.
+ * @return {string} The MapServer map image request URL.
+ */
+function getUrl(baseUrl, params, extent, size) {
+  const width = Math.round(size[0]);
+  const height = Math.round(size[1]);
+  const mapSize = `${width} ${height}`;
+  const mapExt = `${extent[0]} ${extent[1]} ${extent[2]} ${extent[3]}`;
+
+  const baseParams = {
+    mode: 'map',
+    map_imagetype: 'png',
+    mapext: mapExt,
+    imgext: mapExt,
+    map_size: mapSize,
+    imgx: width / 2,
+    imgy: height / 2,
+    imgxy: mapSize,
+  };
+  Object.assign(baseParams, params);
+  return appendParams(baseUrl, baseParams);
+}
+
+/**
+ * Creates a loader for MapServer images generated using the CGI interface,
+ * which predates OGC services. It is **strongly** recommended to configure
+ * MapServer to use WMS, and use the WMS createLoader.
+ * @param {LoaderOptions} options LoaderOptions Options.
+ * @return {import('../Image.js').ImageObjectPromiseLoader} MapServer image.
+ * @api
+ */
+export function createLoader(options) {
+  const load = options.load || decode;
+  const ratio = options.ratio ?? 1;
+  const crossOrigin = options.crossOrigin ?? null;
+
+  /** @type {import('../Image.js').ImageObjectPromiseLoader} */
+  return function (extent, resolution, pixelRatio) {
+    const image = new Image();
+    image.crossOrigin = crossOrigin;
+    extent = getRequestExtent(extent, resolution, pixelRatio, ratio);
+    const width = getWidth(extent) / resolution;
+    const height = getHeight(extent) / resolution;
+    const size = [width * pixelRatio, height * pixelRatio];
+    const src = getUrl(options.url, options.params, extent, size);
+    return load(image, src).then((image) => ({image, extent, pixelRatio}));
+  };
+}

package/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["util.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,4BAFY,KAAK,CAIhB;AASD;;;;;;;;GAQG;AACH,kCAHY,MAAM,CAKjB;AAED;;;GAGG;AACH,sBAFU,MAAM,CAEkC"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["util.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,4BAFY,KAAK,CAIhB;AASD;;;;;;;;GAQG;AACH,kCAHY,MAAM,CAKjB;AAED;;;GAGG;AACH,sBAFU,MAAM,CAEgB"}

package/util.js

@@ -33,4 +33,4 @@ export function getUid(obj) {
  * OpenLayers version.
  * @type {string}
  */
-export const VERSION = '10.3.2-dev.1738093069363';
+export const VERSION = '10.4.0';