ol 10.7.1 → 10.7.2

package/source/OGCMap.js

@@ -1,227 +0,0 @@
-/**
- * @module ol/source/OGCMap
- */
-
-import {decode} from '../Image.js';
-import ImageSource, {defaultImageLoadFunction} from './Image.js';
-import {createLoader} from './ogcMapUtil.js';
-
-/**
- * @typedef {Object} Options
- * @property {import("./Source.js").AttributionLike} [attributions] Attributions.
- * @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 {ReferrerPolicy} [referrerPolicy] The `referrerPolicy` property for loaded images.
- * @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting
- * the image from the remote server.
- * @property {import("../Image.js").LoadFunction} [imageLoadFunction] Optional function to load an image given a URL.
- * @property {boolean} [interpolate=true] Use interpolated values when resampling.  By default,
- * linear interpolation is used when resampling.  Set to false to use the nearest neighbor instead.
- * @property {Object<string,*>} [params] OGC Maps request parameters.
- * No param is required by default. `width`, `height`, `bbox`, `crs` and `bbox-crs` will be set dynamically.
- * @property {import("../proj.js").ProjectionLike} [projection] Projection. Default is the view projection.
- * @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 {Array<number>} [resolutions] Resolutions.
- * If specified, requests will be made for these resolutions only.
- * @property {string} [url] OGC Maps service URL.
- */
-
-/**
- * @classdesc
- * Source for OGC Maps servers providing single, untiled images.
- *
- * @fires module:ol/source/Image.ImageSourceEvent
- * @api
- */
-class OGCMap extends ImageSource {
-  /**
-   * @param {Options} [options] OGCMapOptions options.
-   */
-  constructor(options) {
-    options = options ? options : {};
-
-    super({
-      attributions: options.attributions,
-      interpolate: options.interpolate,
-      projection: options.projection,
-      resolutions: options.resolutions,
-    });
-
-    /**
-     * @private
-     * @type {?string}
-     */
-    this.crossOrigin_ =
-      options.crossOrigin !== undefined ? options.crossOrigin : null;
-
-    /**
-     * @private
-     * @type {ReferrerPolicy}
-     */
-    this.referrerPolicy_ = options.referrerPolicy;
-
-    /**
-     * @private
-     * @type {string|undefined}
-     */
-    this.url_ = options.url;
-
-    /**
-     * @private
-     * @type {import("../Image.js").LoadFunction}
-     */
-    this.imageLoadFunction_ =
-      options.imageLoadFunction !== undefined
-        ? options.imageLoadFunction
-        : defaultImageLoadFunction;
-
-    /**
-     * @private
-     * @type {!Object}
-     */
-    this.params_ = Object.assign({}, options.params);
-
-    /**
-     * @private
-     * @type {boolean}
-     */
-    this.hidpi_ = options.hidpi !== undefined ? options.hidpi : true;
-
-    /**
-     * @private
-     * @type {number}
-     */
-    this.renderedRevision_ = 0;
-
-    /**
-     * @private
-     * @type {number}
-     */
-    this.ratio_ = options.ratio !== undefined ? options.ratio : 1.5;
-
-    /**
-     * @private
-     * @type {import("../proj/Projection.js").default}
-     */
-    this.loaderProjection_ = null;
-  }
-
-  /**
-   * Get the user-provided params, i.e. those passed to the constructor through
-   * the "params" option, and possibly updated using the updateParams method.
-   * @return {Object} Params.
-   * @api
-   */
-  getParams() {
-    return this.params_;
-  }
-
-  /**
-   * @param {import("../extent.js").Extent} extent Extent.
-   * @param {number} resolution Resolution.
-   * @param {number} pixelRatio Pixel ratio.
-   * @param {import("../proj/Projection.js").default} projection Projection.
-   * @return {import("../Image.js").default} Single image.
-   * @override
-   */
-  getImageInternal(extent, resolution, pixelRatio, projection) {
-    if (this.url_ === undefined) {
-      return null;
-    }
-    if (!this.loader || this.loaderProjection_ !== projection) {
-      // Lazily create loader to pick up the view projection and to allow `params` updates
-      this.loaderProjection_ = projection;
-      this.loader = createLoader({
-        crossOrigin: this.crossOrigin_,
-        referrerPolicy: this.referrerPolicy_,
-        params: this.params_,
-        projection: projection,
-        hidpi: this.hidpi_,
-        url: this.url_,
-        ratio: this.ratio_,
-        load: (image, src) => {
-          this.image.setImage(image);
-          this.imageLoadFunction_(this.image, src);
-          return decode(image);
-        },
-      });
-    }
-
-    return super.getImageInternal(extent, resolution, pixelRatio, projection);
-  }
-
-  /**
-   * Return the image load function of the source.
-   * @return {import("../Image.js").LoadFunction} The image load function.
-   * @api
-   */
-  getImageLoadFunction() {
-    return this.imageLoadFunction_;
-  }
-
-  /**
-   * Return the URL used for this OGC Maps source.
-   * @return {string|undefined} URL.
-   * @api
-   */
-  getUrl() {
-    return this.url_;
-  }
-
-  /**
-   * Set the image load function of the source.
-   * @param {import("../Image.js").LoadFunction} imageLoadFunction Image load function.
-   * @api
-   */
-  setImageLoadFunction(imageLoadFunction) {
-    this.imageLoadFunction_ = imageLoadFunction;
-    this.changed();
-  }
-
-  /**
-   * Set the URL to use for requests.
-   * @param {string|undefined} url URL.
-   * @api
-   */
-  setUrl(url) {
-    if (url != this.url_) {
-      this.url_ = url;
-      this.loader = null;
-      this.changed();
-    }
-  }
-
-  /**
-   * Set the user-provided params.
-   * @param {Object} params Params.
-   * @api
-   */
-  setParams(params) {
-    this.params_ = Object.assign({}, params);
-    // Reset loader to pick up new params
-    this.loader = null;
-    this.changed();
-  }
-
-  /**
-   * Update the user-provided params.
-   * @param {Object} params Params.
-   * @api
-   */
-  updateParams(params) {
-    Object.assign(this.params_, params);
-    this.changed();
-  }
-
-  /**
-   * @override
-   */
-  changed() {
-    this.image = null;
-    super.changed();
-  }
-}
-
-export default OGCMap;

package/source/ogcMapUtil.d.ts

@@ -1,88 +0,0 @@
-/**
- * @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 OGC Map params. Will be modified in place.
- * @return {string} Request URL.
- */
-export function getRequestUrl(baseUrl: string, extent: import("../extent.js").Extent, size: import("../size.js").Size, projection: import("../proj/Projection.js").default, params: any): string;
-/**
- * @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 OGC Map service url.
- * @param {Object} params OGC Map params.
- * @return {string} Image src.
- */
-export function getImageSrc(extent: import("../extent").Extent, resolution: number, pixelRatio: number, projection: import("../proj.js").Projection, url: string, params: any): string;
-/**
- * @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 {ReferrerPolicy} [referrerPolicy] The `referrerPolicy` property for loaded images.
- * @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting
- * the image from the remote server.
- * @property {Object<string,*>} [params] OGC Map request parameters.
- * No param is required by default. `width`, `height`, `bbox`, `crs` and `bbox-crs` will be set dynamically.
- * @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 {string} url OGC Map 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 OGC Map images.
- * @param {LoaderOptions} options Loader options.
- * @return {import("../Image.js").ImageObjectPromiseLoader} Loader.
- * @api
- */
-export function createLoader(options: LoaderOptions): import("../Image.js").ImageObjectPromiseLoader;
-export type LoaderOptions = {
-    /**
-     * 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.
-     */
-    crossOrigin?: string | null | undefined;
-    /**
-     * The `referrerPolicy` property for loaded images.
-     */
-    referrerPolicy?: ReferrerPolicy | undefined;
-    /**
-     * Use the `ol/Map#pixelRatio` value when requesting
-     * the image from the remote server.
-     */
-    hidpi?: boolean | undefined;
-    /**
-     * OGC Map request parameters.
-     * No param is required by default. `width`, `height`, `bbox`, `crs` and `bbox-crs` will be set dynamically.
-     */
-    params?: {
-        [x: string]: any;
-    } | undefined;
-    /**
-     * Projection. Default is 'EPSG:3857'.
-     */
-    projection?: import("../proj.js").ProjectionLike;
-    /**
-     * 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;
-    /**
-     * OGC Map service URL.
-     */
-    url: string;
-    /**
-     * 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=ogcMapUtil.d.ts.map

package/source/ogcMapUtil.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ogcMapUtil.d.ts","sourceRoot":"","sources":["ogcMapUtil.js"],"names":[],"mappings":"AAYA;;;;;;;GAOG;AACH,uCAPW,MAAM,UACN,OAAO,cAAc,EAAE,MAAM,QAC7B,OAAO,YAAY,EAAE,IAAI,cACzB,OAAO,uBAAuB,EAAE,OAAO,gBAEtC,MAAM,CAejB;AAED;;;;;;;;GAQG;AACH,oCARW,OAAO,WAAW,EAAE,MAAM,cAC1B,MAAM,cACN,MAAM,cACN,OAAO,YAAY,EAAE,UAAU,OAC/B,MAAM,gBAEL,MAAM,CAwBjB;AAED;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;GAKG;AACH,sCAJW,aAAa,GACZ,OAAO,aAAa,EAAE,wBAAwB,CA8BzD;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA1Ca,OAAO,YAAY,EAAE,cAAc;;;;;;;;;SAGnC,MAAM;;;;;;mBACG,gBAAgB,QAAE,MAAM,KAAG,OAAO,CAAC,OAAO,gBAAgB,EAAE,SAAS,CAAC"}

package/source/ogcMapUtil.js

@@ -1,121 +0,0 @@
-/**
- * @module ol/source/ogcMapUtil
- */
-
-import {decode} from '../Image.js';
-import {getHeight, getWidth} from '../extent.js';
-import {round} from '../math.js';
-import {get as getProjection} from '../proj.js';
-import {appendParams} from '../uri.js';
-import {getRequestExtent} from './Image.js';
-import {DECIMALS} from './common.js';
-
-/**
- * @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 OGC Map 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();
-  params['crs'] = projection.getCode();
-  params['bbox-crs'] = projection.getCode();
-  const bbox = axisOrientation.startsWith('ne')
-    ? [extent[1], extent[0], extent[3], extent[2]]
-    : extent;
-  params['bbox'] = bbox.join(',');
-
-  return appendParams(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 OGC Map service url.
- * @param {Object} params OGC Map params.
- * @return {string} Image src.
- */
-export function getImageSrc(
-  extent,
-  resolution,
-  pixelRatio,
-  projection,
-  url,
-  params,
-) {
-  params = Object.assign({}, params);
-
-  const imageResolution = resolution / pixelRatio;
-
-  const imageSize = [
-    round(getWidth(extent) / imageResolution, DECIMALS),
-    round(getHeight(extent) / imageResolution, DECIMALS),
-  ];
-
-  if (pixelRatio !== 1) {
-    params['mm-per-pixel'] = 0.28 / pixelRatio;
-  }
-
-  return getRequestUrl(url, extent, imageSize, projection, 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 {ReferrerPolicy} [referrerPolicy] The `referrerPolicy` property for loaded images.
- * @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting
- * the image from the remote server.
- * @property {Object<string,*>} [params] OGC Map request parameters.
- * No param is required by default. `width`, `height`, `bbox`, `crs` and `bbox-crs` will be set dynamically.
- * @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 {string} url OGC Map 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 OGC Map 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;
-  const crossOrigin = options.crossOrigin ?? null;
-
-  return (extent, resolution, pixelRatio) => {
-    extent = getRequestExtent(extent, resolution, pixelRatio, ratio);
-    if (pixelRatio !== 1 && !hidpi) {
-      pixelRatio = 1;
-    }
-    const src = getImageSrc(
-      extent,
-      resolution,
-      pixelRatio,
-      projection,
-      options.url,
-      options.params,
-    );
-    const image = new Image();
-    image.crossOrigin = crossOrigin;
-    if (options.referrerPolicy !== undefined) {
-      image.referrerPolicy = options.referrerPolicy;
-    }
-    return load(image, src).then((image) => ({image, extent, pixelRatio}));
-  };
-}