You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
192 lines
6.4 KiB
192 lines
6.4 KiB
export default ImageMapGuide;
|
|
export type Options = {
|
|
/**
|
|
* The mapagent url.
|
|
*/
|
|
url?: string | undefined;
|
|
/**
|
|
* 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 display resolution.
|
|
*/
|
|
displayDpi?: number | undefined;
|
|
/**
|
|
* The meters-per-unit value.
|
|
*/
|
|
metersPerUnit?: number | undefined;
|
|
/**
|
|
* Use the `ol/Map#pixelRatio` value when requesting
|
|
* the image from the remote server.
|
|
*/
|
|
hidpi?: boolean | undefined;
|
|
/**
|
|
* If `true`, will use `GETDYNAMICMAPOVERLAYIMAGE`.
|
|
*/
|
|
useOverlay?: boolean | undefined;
|
|
/**
|
|
* Projection. Default is the view projection.
|
|
*/
|
|
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;
|
|
/**
|
|
* Resolutions.
|
|
* If specified, requests will be made for these resolutions only.
|
|
*/
|
|
resolutions?: number[] | undefined;
|
|
/**
|
|
* Optional function to load an image given a URL.
|
|
*/
|
|
imageLoadFunction?: import("../Image.js").LoadFunction | undefined;
|
|
/**
|
|
* Use interpolated values when resampling. By default,
|
|
* linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
|
|
*/
|
|
interpolate?: boolean | undefined;
|
|
/**
|
|
* Additional parameters.
|
|
*/
|
|
params?: any;
|
|
};
|
|
/**
|
|
* @typedef {Object} Options
|
|
* @property {string} [url] The mapagent 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.
|
|
* @property {number} [displayDpi=96] The display resolution.
|
|
* @property {number} [metersPerUnit=1] The meters-per-unit value.
|
|
* @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting
|
|
* the image from the remote server.
|
|
* @property {boolean} [useOverlay] If `true`, will use `GETDYNAMICMAPOVERLAYIMAGE`.
|
|
* @property {import("../proj.js").ProjectionLike} [projection] Projection. Default is the view projection.
|
|
* @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 {Array<number>} [resolutions] Resolutions.
|
|
* If specified, requests will be made for these resolutions only.
|
|
* @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} [params] Additional parameters.
|
|
*/
|
|
/**
|
|
* @classdesc
|
|
* Source for images from Mapguide servers
|
|
*
|
|
* @fires module:ol/source/Image.ImageSourceEvent
|
|
* @api
|
|
*/
|
|
declare class ImageMapGuide extends ImageSource {
|
|
/**
|
|
* @param {Options} options ImageMapGuide options.
|
|
*/
|
|
constructor(options: Options);
|
|
/**
|
|
* @private
|
|
* @type {?string}
|
|
*/
|
|
private crossOrigin_;
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private displayDpi_;
|
|
/**
|
|
* @private
|
|
* @type {!Object}
|
|
*/
|
|
private params_;
|
|
/**
|
|
* @private
|
|
* @type {string|undefined}
|
|
*/
|
|
private url_;
|
|
/**
|
|
* @private
|
|
* @type {import("../Image.js").LoadFunction}
|
|
*/
|
|
private imageLoadFunction_;
|
|
/**
|
|
* @private
|
|
* @type {boolean}
|
|
*/
|
|
private hidpi_;
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private metersPerUnit_;
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private ratio_;
|
|
/**
|
|
* @private
|
|
* @type {boolean}
|
|
*/
|
|
private useOverlay_;
|
|
/**
|
|
* @private
|
|
* @type {import("../Image.js").default}
|
|
*/
|
|
private image_;
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
private renderedRevision_;
|
|
/**
|
|
* 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(): any;
|
|
/**
|
|
* @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.
|
|
*/
|
|
getImageInternal(extent: import("../extent.js").Extent, resolution: number, pixelRatio: number, projection: import("../proj/Projection.js").default): import("../Image.js").default;
|
|
/**
|
|
* Return the image load function of the source.
|
|
* @return {import("../Image.js").LoadFunction} The image load function.
|
|
* @api
|
|
*/
|
|
getImageLoadFunction(): import("../Image.js").LoadFunction;
|
|
/**
|
|
* Update the user-provided params.
|
|
* @param {Object} params Params.
|
|
* @api
|
|
*/
|
|
updateParams(params: any): void;
|
|
/**
|
|
* @param {string} baseUrl The mapagent url.
|
|
* @param {Object<string, string|number>} params Request parameters.
|
|
* @param {import("../extent.js").Extent} extent Extent.
|
|
* @param {import("../size.js").Size} size Size.
|
|
* @param {import("../proj/Projection.js").default} projection Projection.
|
|
* @return {string} The mapagent map image request URL.
|
|
*/
|
|
getUrl(baseUrl: string, params: {
|
|
[x: string]: string | number;
|
|
}, extent: import("../extent.js").Extent, size: import("../size.js").Size, projection: import("../proj/Projection.js").default): string;
|
|
/**
|
|
* Set the image load function of the MapGuide source.
|
|
* @param {import("../Image.js").LoadFunction} imageLoadFunction Image load function.
|
|
* @api
|
|
*/
|
|
setImageLoadFunction(imageLoadFunction: import("../Image.js").LoadFunction): void;
|
|
}
|
|
import ImageSource from "./Image.js";
|
|
//# sourceMappingURL=ImageMapGuide.d.ts.map
|