Module: ol/source/mapguide

Functions

createLoader(options){ImageObjectPromiseLoader}

source/mapguide.js, line 92

import {createLoader} from 'ol/source/mapguide';

Creates a loader for MapGuide images.

Name	Type	Description
url	string | undefined	The mapagent url.
crossOrigin	null | 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.
displayDpi	number (defaults to 96)	The display resolution.
metersPerUnit	number (defaults to 1)	The meters-per-unit value.
hidpi	boolean (defaults to true)	Use the ol/Map#pixelRatio value when requesting the image from the remote server.
useOverlay	boolean | undefined	If true, will use GETDYNAMICMAPOVERLAYIMAGE.
ratio	number (defaults to 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.
params	Object | undefined	Additional query parameters.
load	function | undefined	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 decode.

Returns:

ArcGIS Rest image.

Type Definitions

LoaderOptions{Object}

Properties:

Name	Type	Description
url	string | undefined	The mapagent url.
crossOrigin	null | 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.
displayDpi	number (defaults to 96)	The display resolution.
metersPerUnit	number (defaults to 1)	The meters-per-unit value.
hidpi	boolean (defaults to true)	Use the ol/Map#pixelRatio value when requesting the image from the remote server.
useOverlay	boolean | undefined	If true, will use GETDYNAMICMAPOVERLAYIMAGE.
ratio	number (defaults to 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.
params	Object | undefined	Additional query parameters.
load	function | undefined	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 decode.