@allmaps/render

Allmaps render module. Renders georeferenced IIIF maps specified by a Georeference Annotation.

The following renderers are implemented:

* CanvasRenderer: renders WarpedMaps to a HTML Canvas element with the Canvas 2D API
* WebGL2Renderer: renders WarpedMaps to a WebGL 2 context
* IntArrayRenderer: renders WarpedMaps to an IntArray

This module is mainly used in the Allmaps pipeline by the following packages:

* Allmaps plugin for Leaflet
* Allmaps plugin for MapLibre
* Allmaps plugin for OpenLayers

It is also used in the Allmaps Preview worker.

How it works

The render module accomplishes this task with the following classes:

* All renderers use the concept of a Viewport, describing coordinate reach that should be rendered. Create a viewport using it's constructor or the static methods in the Viewport class. The CanvasRenderer and WebGL2Renderer can deduce a viewport from the current WarpedMapList and the size of their (WebGL2-enabled) canvas.
* All renderers extend the BaseRenderer class, which implements the general actions of the (automatically throttled) render() calls: checking which maps are inside the current viewport, initially loading their image informations, checking which zoomlevel corresponds to the viewport, getting the IIIF tiles of that zoomlevel that are within the viewport.
* For the WebGL2Renderer, a WebGL2RenderingContext contains the rendering context for the drawing surface of an HTML element, and a WebGLProgram stores the vertex and fragment shader used for rendering a map, its lines and points.
* A WarpedMap is made from every Georeferenced Map (which in term are parsed Georeference Annotations) and is added to the renderer and hence to its warpedMapList. It contains useful properties like mask, center, size ... in resource, geospatial and projected geospatial coordinates. It contains a copy of the ground control points (GCPs) and resource masks, a projected version of the GCPs, a transformation built using the latter and usable to transform points from IIIF resource coordinates to projected geospatial coordinates.
* If WebGL2Renderer is used, a TriangulatedWarpedMap is created for every WarpedMap, finely triangulating the map, and a WebGL2WarpedMap is created, containing the WebGL2 information of the map (buffers etc.).
* A WarpedMapList contains the list of WarpedMaps to draw and uses an RTree for geospatial map lookup.
* A TileCache fetches and stores the image data of cached IIIF tiles.

$3

During a CanvasRenderer or IntArrayRenderer render call, a map undergoes the following steps from Georeference Annotation to the canvas:

* For each viewport pixel, from its viewport coordinates its projected geospatial coordinates are obtained and transformed to its corresponding resource coordinates, i.e. it's location in the IIIF image.
* We find the tile on which this point is located, and express the resource coordinates in local tile coordinates.
* We set the color of this pixel from the colors of the four tile pixels surrounding the tile point, through a bilinear interpolation.

During a WebGL2Renderer render call, a map undergoes the following steps from Georeference Annotation to the canvas:

* The resource mask is triangulated: the area within is divided into small triangles.
* The optimal tile zoom level for the current viewport is searched, telling us which IIIF tile scaleFactor to use.
* The Viewport is transformed backwards from projected geospatial coordinates to resource coordinates of the IIIF image. The IIIF tiles covering this viewport on the resource image are fetched and cached in the TileCache.
* The area inside the resource mask is rendered in the viewport, triangle by triangle, using the cached tiles. The location of where to render each triangle is computed using the forward transformation built from the GPCs.

Installation

This package works in browsers and in Node.js as an ESM module.

Install with pnpm:

``sh
pnpm install @allmaps/render
`

You can optionally build this package locally by running:

`sh
pnpm run build
`

Usage

The most straightforward way to use the render logic in this package is by rendering a Georeference Annotation on a webmaps using one of the Allmaps plugins (which use the WebGL2Renderer) or setting up the Allmaps TileServer (which uses the CanvasRenderer).

It's also possible to call a renderer directly:

$3

`js
import { CanvasRenderer } from '@allmaps/render/canvas'

// Create a canvas and set your desired width and height
const canvas = document.getElementById('canvas')
canvas.width = width // Your width
canvas.height = height // Your height

// Create a renderer from your canvas
const renderer = new CanvasRenderer(canvas)

// Fetch and parse an annotation
const annotationUrl = 'https://annotations.allmaps.org/images/4af0fa9c8207b36c'
const annotation = await fetch(annotationUrl).then((response) =>
response.json()
)

// Add the annotation to the renderer
await renderer.addGeoreferenceAnnotation(annotation)

// Render
// Note: no viewport specified, so one will be deduced. See below.
await renderer.render()
`

Notes:

* Maps with strong warping may appear to not exactly follow the specified viewport. This is due the backwards transform being explicitly used in the CanvasRenderer and IntArrayRenderer (and not in the WebGL2Renderer). For maps with strong warping, the backwards transform is currently not exact (even for polynomial transformations).

$3

`js
import { WebGL2Renderer } from '@allmaps/render/webgl2'

// Create a canvas and set your desired width and height
const canvas = document.getElementById('canvas')
canvas.width = width // Your width
canvas.height = height // Your height

// Get the webgl context of your canvas
const gl = canvas.getContext('webgl2', { premultipliedAlpha: true })

// Create a renderer from your canvas
const renderer = new WebGL2Renderer(gl)

// Fetch and parse an annotation
const annotationUrl = 'https://annotations.allmaps.org/images/4af0fa9c8207b36c'
const annotation = await fetch(annotationUrl).then((response) =>
response.json()
)

// Add the annotation to the renderer
await renderer.addGeoreferenceAnnotation(annotation)

// Render
// Note: no viewport specified, so one will be deduced. See below.
renderer.render()
`

Notes: the WebGL2Renderer is not fully functional yet.

The WebGL2Renderer works with events which are meant to trigger re-renders. This logic can currently be implemented outside of this library (see the plugins), and will be implemented within* this library soon. As this will affect the API, please refrain from using this renderer as described above for now.
* The WebGL2Renderer loads images via web-workers. The bundling needs to be optimised to support using this renderer in all possible environments.

$3

`js
import { IntArrayRenderer } from '@allmaps/render/intarray'

// Create a renderer
// See the IntArrayRenderer constructor for more info
// And the Allmaps Preview application for a concrete example
const renderer =
new IntArrayRenderer() <
D > // A data type
(getImageData, // A function to get the image date from an image
getImageDataValue, // A function to get the image data value from an image
getImageDataSize, // A function to get the image data size from an image
options) // IntArrayRenderer options

const annotationUrl = 'https://annotations.allmaps.org/images/4af0fa9c8207b36c'
const annotation = await fetch(annotationUrl).then((response) =>
response.json()
)

await renderer.addGeoreferenceAnnotation(annotation)

// Create your viewport (mandatory for this renderer)
const viewport = viewport // Your viewport, see below

const image = await renderer.render(viewport)
`

Notes:

* Maps with strong warping may appear to not exactly follow the specified viewport. This is due the backwards transform being explicitly used in the CanvasRenderer and IntArrayRenderer (and not in the WebGL2Renderer). For maps with strong warping, the backwards transform is currently not exact (even for polynomial transformations).

$3

The render() call of all renderers take a Viewport as input. For the IntArrayRenderer, this argument is required. For the others, it is optional: if unspecified a viewport will be deduced from the canvas size and the warpedMapList formed by the annotations.

A viewport can be created through one of the following options:

Directly using the Viewport constructor:

`js
import { Viewport } from '@allmaps/render'

new Viewport(
viewportSize, // Your viewport size, as [width, height]
projectedGeoCenter, // Your center, in geo coordinates
projectedGeoPerViewportScale, // Your geo-per-viewport scale
{
rotation, // Your rotation
devicePixelRatio, // Your device pixel ratio, e.g. window.devicePixelRatio or just 1
projection // Your projection (of the above projected geospatial coordinates), as compatible with Proj4js
}
)
`

Using one of the following static methods:

* Viewport.fromSizeAndMaps()
* Viewport.fromSizeAndGeoPolygon()
* Viewport.fromSizeAndProjectedGeoPolygon()
* Viewport.fromScaleAndMaps()
* Viewport.fromScaleAndGeoPolygon()
* Viewport.fromScaleAndProjectedGeoPolygon()

For example, to derive a Viewport from a size and maps:

`js
const viewport = Viewport.fromSizeAndMaps(
viewportSize, // Your viewport size, as [width, height]
warpedMapList, // Your WarpedMapList, e.g. renderer.warpedMapList
partialExtendedViewportOptions // Your extended viewport options, including viewport options (rotation, devicePixelRatio and projection (used both to retrieve the extent of the maps and for the viewport itself)), a zoom; a fit; and WarpedMapList selection options like mapIds or onlyVisible
)
`

Or, to derive a Viewport from a scale and maps:

`js
const viewport = Viewport.fromScaleAndMaps(
projectedGeoPerViewportScale, // Your scale
warpedMapList, // Your WarpedMapList, e.g. renderer.warpedMapList
partialExtendedViewportOptions // Your extended viewport options, including viewport options (rotation, devicePixelRatio and projection (used both to retrieve the extent of the maps and for the viewport itself)), a zoom; and WarpedMapList selection options like mapIds or onlyVisible
)

// In this case, resize your canvas to the computed viewport
// before rendering, to encompass the entire image.
canvas.width = viewport.canvasSize[0]
canvas.height = viewport.canvasSize[1]
canvas.style.width = viewport.viewportSize[0] + 'px'
canvas.style.height = viewport.viewportSize[1] + 'px'
context.scale(viewport.devicePixelRatio, viewport.devicePixelRatio)
`

For usage examples in webmapping libraries, see the source code of the Allmaps plugins for Leaflet,
MapLibre and OpenLayers.

Naming conventions

In this package the following naming conventions are used:

* viewport... indicates properties described in viewport coordinates (i.e. with pixel size as perceived by the user)
* canvas... indicates properties described in canvas coordinates, so viewport device pixel ratio (i.e. with effective pixel size in memory)
* resource... indicates properties described in resource coordinates (i.e. IIIF tile coordinates of zoomlevel 1)
* geo... indicates properties described in geospatial coordinates ('WGS84', i.e. [lon, lat])
* projectedGeo... indicates properties described in projected geospatial coordinates (following a CRS, by default 'EPSG:3857' WebMercator)
* tile... indicates properties described IIIF tile coordinates

License

MIT

API

$3

###### Fields

* animate (boolean)

$3

###### Type

`ts
object & SpecificWarpedMapListOptions & Partial
`

$3

###### Type

`ts
object & SpecificWarpedMapListOptions & Partial
`

$3

###### Type

`ts
W extends WebGL2WarpedMap
? WebGL2WarpedMapOptions
: W extends TriangulatedWarpedMap
? TriangulatedWarpedMapOptions
: W extends WarpedMap
? WarpedMapOptions
: never
`

$3

###### Type

`ts
object & SpecificWarpedMapListOptions & Partial
`

$3

###### Fields

* projection ({id?: string; name?: string; definition: ProjectionDefinition})

$3

###### Fields

* geoBbox? ([number, number, number, number])
* geoPoint? ([number, number])
* mapIds? (Iterable)
* onlyVisible? (boolean)

$3

###### Type

`ts
object
`

$3

###### Fields

* distortionMeasures (Array)
* resourceResolution? (number)

$3

###### Fields

* animatedOptions (Array)
* createRTree (boolean)
* rtreeUpdatedOptions (Array)

$3

###### Fields

* height (number)
* imageId (string)
* scaleFactor (number)
* spriteTileScale? (number)
* width (number)
* x (number)
* y (number)

$3

###### Fields

* imageSize ([number, number])
* imageUrl (string)
* sprites (Array)

$3

###### Fields

* options? (unknown)
* type ( | 'straight'
| 'helmert'
| 'polynomial'
| 'polynomial1'
| 'polynomial2'
| 'polynomial3'
| 'thinPlateSpline'
| 'projective'
| 'linear')

$3

Creates an instance of a TriangulatedWarpedMap.

###### Parameters

* mapId (string)
* ID of the map
* georeferencedMap ({ type: "GeoreferencedMap"; resource: { type: "ImageService1" | "ImageService2" | "ImageService3" | "Canvas"; id: string; height?: number | undefined; width?: number | undefined; partOf?: ({ type: string; id: string; label?: Record | undefined; } & { partOf?: ({ type: string; i...)
* Georeferenced map used to construct the WarpedMap
* listOptions? (Partial | undefined)
* mapOptions? (Partial | undefined)

###### Returns

TriangulatedWarpedMap.

###### Extends

* WarpedMap

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Type

`ts
SpecificTriangulatedWarpedMapOptions & WarpedMapOptions
`

$3

###### Type

`ts
{ resourceResolution?: number | undefined; distortionMeasures?: Array | undefined; fetchFn?: FetchFn | undefined; gcps?: Array | undefined; resourceMask?: Ring | undefined; ... 5 more ...; distortionMeasure?: DistortionMeasure | undefined; }
`

$3

###### Type

`ts
{ resourceResolution?: number | undefined; distortionMeasures?: Array | undefined; fetchFn?: FetchFn | undefined; gcps?: Array | undefined; resourceMask?: Ring | undefined; ... 5 more ...; distortionMeasure?: DistortionMeasure | undefined; }
`

$3

###### Type

`ts
{ resourceResolution?: number | undefined; distortionMeasures?: Array | undefined; fetchFn?: FetchFn | undefined; gcps?: Array | undefined; resourceMask?: Ring | undefined; ... 5 more ...; distortionMeasure?: DistortionMeasure | undefined; }
`

$3

Mix previous transform properties with new ones (when changing an ongoing animation).

###### Parameters

* t (number)
* animation progress

###### Returns

void.

$3

###### Type

`ts
SpecificTriangulatedWarpedMapOptions & WarpedMapOptions
`

$3

###### Type

`ts
number | undefined
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
{
resourceResolution: number | undefined
gcpUniquePoints: GcpAndDistortions[]
uniquePointIndices: number[]
uniquePointIndexInterpolatedPolygon: TypedPolygon
}
`

$3

###### Type

`ts
{
resourceResolution: number | undefined
gcpUniquePoints: GcpAndDistortions[]
uniquePointIndices: number[]
uniquePointIndexInterpolatedPolygon: TypedPolygon
}
`

$3

###### Type

`ts
Map<
number,
Map>>
>
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
Array
`

$3

Reset previous transform properties to new ones (when completing an animation).

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Type

`ts
number | undefined
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
Map>
`

$3

Set default options

###### Parameters

There are no parameters.

###### Returns

void.

$3

Set the distortionMeasure

###### Parameters

* distortionMeasure? (DistortionMeasure | undefined)
* the disortion measure

###### Returns

void.

$3

Update the ground control points loaded from a georeferenced map to new ground control points.

###### Parameters

* gcps (Array)
* the new ground control points

###### Returns

void.

$3

Set the internal projection

###### Parameters

* projection ({id?: string; name?: string; definition: ProjectionDefinition})
* the internal projection

###### Returns

void.

$3

Set the projection

###### Parameters

* projection ({id?: string; name?: string; definition: ProjectionDefinition})
* the projection

###### Returns

void.

$3

Update the resource mask loaded from a georeferenced map to a new mask.

###### Parameters

* resourceFullMask (Array)
* resourceAppliableMask (Array)
* resourceMask (Array)
* the new mask

###### Returns

void.

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
0
`

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

Derive the (previous and new) resource and projectedGeo points from their corresponding triangulations.

Also derive the (previous and new) triangulation-refined resource and projectedGeo mask

###### Parameters

There are no parameters.

###### Returns

void.

$3

Derive the (previous and new) distortions from their corresponding triangulations.

###### Parameters

There are no parameters.

###### Returns

void.

$3

Update the (previous and new) triangulation of the resourceMask. Use cache if available.

###### Parameters

There are no parameters.

###### Returns

void.

$3

Get default options

###### Parameters

There are no parameters.

###### Returns

SpecificTriangulatedWarpedMapOptions & WarpedMapOptions.

$3

###### Type

`ts
SpecificTriangulatedWarpedMapOptions & WarpedMapOptions
`

$3

Creates a new Viewport

###### Parameters

* viewportSize ([number, number])
* Size of the viewport in viewport pixels, as \[width, height].
* projectedGeoCenter ([number, number])
* Center point of the viewport, in projected geospatial coordinates.
* projectedGeoPerViewportScale (number)
* Scale of the viewport, in projection coordinates per viewport pixel.
* partialViewportOptions? (Partial | undefined)

###### Returns

Viewport.

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
number
`

$3

###### Type

`ts
[number, number]
`

$3

###### Parameters

There are no parameters.

###### Returns

[number, number, number, number, number, number].

$3

###### Parameters

There are no parameters.

###### Returns

[number, number, number, number, number, number].

$3

###### Parameters

There are no parameters.

###### Returns

[number, number, number, number, number, number].

$3

###### Parameters

There are no parameters.

###### Returns

[number, number, number, number, number, number].

$3

Returns a rectangle in projected geospatial coordinates

The rectangle is the result of a horizontal rectangle in Viewport space of size 'viewportSize',
scaled using projectedGeoPerViewportScale, centered,
rotated using 'rotation' and translated to 'projectedGeoCenter'.

###### Parameters

* viewportSize ([number, number])
* projectedGeoPerViewportScale (number)
* rotation (number)
* projectedGeoCenter ([number, number])

###### Returns

[Point, Point, Point, Point].

$3

###### Type

`ts
number
`

$3

###### Type

`ts
[number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
number
`

$3

###### Type

`ts
[number, number]
`

$3

###### Parameters

* bufferFraction? (number | undefined)

###### Returns

[Point, Point, Point, Point].

$3

###### Parameters

* bufferFraction? (number | undefined)

###### Returns

[Point, Point, Point, Point].

$3

###### Type

`ts
[number, number]
`

$3

###### Type

`ts
number
`

$3

###### Type

`ts
number
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
number
`

$3

###### Type

`ts
[number, number]
`

$3

###### Type

`ts
[number, number, number, number, number, number]
`

$3

###### Type

`ts
[number, number, number, number, number, number]
`

$3

###### Type

`ts
[number, number, number, number, number, number]
`

$3

###### Type

`ts
{id?: string; name?: string; definition: ProjectionDefinition}
`

$3

###### Type

`ts
number
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
number
`

$3

###### Type

`ts
[number, number]
`

$3

###### Type

`ts
[number, number, number, number, number, number]
`

$3

Static method that creates a Viewport from a scale and a polygon in geospatial coordinates, i.e. lon-lat EPSG:4326.

Note: the scale is still in projected geospatial per viewport pixel!

###### Parameters

* projectedGeoPerViewportScale (number)
* Scale of the viewport, in projected geospatial coordinates per viewport pixel.
* geoPolygon (Array>)
* A polygon in geospatial coordinates.
* partialExtendedViewportOptions? ( | Partial<
{rotation: number; devicePixelRatio: number} & ProjectionOptions &
ZoomOptions >
| undefined)

###### Returns

A new Viewport object (Viewport).

$3

Static method that creates a Viewport from a scale and maps.

Optionally specify a projection, to be used both when obtaining the extent of selected warped maps in projected geospatial coordinates, as well as when create a viewport

###### Parameters

* projectedGeoPerViewportScale (number)
* Scale of the viewport, in projected geospatial coordinates per viewport pixel.
* warpedMapList (WarpedMapList)
* A WarpedMapList.
* partialExtendedViewportOptions? ( | Partial<
{rotation: number; devicePixelRatio: number} & ProjectionOptions &
ZoomOptions &
SelectionOptions >
| undefined)
* Optional viewport options.

###### Returns

A new Viewport object (Viewport).

$3

Static method that creates a Viewport from a scale and a polygon in projected geospatial coordinates.

###### Parameters

* projectedGeoPerViewportScale (number)
* Scale of the viewport, in projected geospatial coordinates per viewport pixel.
* projectedGeoPolygon (Array>)
* A polygon in projected geospatial coordinates.
* partialExtendedViewportOptions? ( | Partial<
{rotation: number; devicePixelRatio: number} & ProjectionOptions &
ZoomOptions >
| undefined)

###### Returns

A new Viewport object (Viewport).

$3

Static method that creates a Viewport from a size and a polygon in geospatial coordinates, i.e. lon-lat EPSG:4326.

###### Parameters

* viewportSize ([number, number])
* Size of the viewport in viewport pixels, as \[width, height].
* geoPolygon (Array>)
* A polygon in geospatial coordinates.
* partialExtendedViewportOptions? ( | Partial<
{rotation: number; devicePixelRatio: number} & ProjectionOptions &
ZoomOptions &
FitOptions >
| undefined)
* Optional viewport options

###### Returns

A new Viewport object (Viewport).

$3

Static method that creates a Viewport from a size and maps.

Optionally specify a projection, to be used both when obtaining the extent of selected warped maps in projected geospatial coordinates, as well as when create a viewport

###### Parameters

* viewportSize ([number, number])
* Size of the viewport in viewport pixels, as \[width, height].
* warpedMapList (WarpedMapList)
* A WarpedMapList.
* partialExtendedViewportOptions? ( | Partial<
{rotation: number; devicePixelRatio: number} & ProjectionOptions &
ZoomOptions &
FitOptions &
SelectionOptions >
| undefined)
* Optional viewport options

###### Returns

A new Viewport object (Viewport).

$3

Static method that creates a Viewport from a size and a polygon in projected geospatial coordinates.

###### Parameters

* viewportSize ([number, number])
* Size of the viewport in viewport pixels, as \[width, height].
* projectedGeoPolygon (Array>)
* A polygon in projected geospatial coordinates.
* partialExtendedViewportOptions? ( | Partial<
{rotation: number; devicePixelRatio: number} & ProjectionOptions &
ZoomOptions &
FitOptions >
| undefined)
* Optional viewport options

###### Returns

A new Viewport object (Viewport).

$3

Creates an instance of WarpedMap.

###### Parameters

* mapId (string)
* ID of the map
* georeferencedMap ({ type: "GeoreferencedMap"; resource: { type: "ImageService1" | "ImageService2" | "ImageService3" | "Canvas"; id: string; height?: number | undefined; width?: number | undefined; partOf?: ({ type: string; id: string; label?: Record | undefined; } & { partOf?: ({ type: string; i...)
* Georeferenced map used to construct the WarpedMap
* listOptions (Partial | undefined)
* mapOptions (Partial | undefined)

###### Returns

WarpedMap.

###### Extends

* EventTarget

$3

###### Type

`ts
AbortController
`

$3

###### Parameters

* animationOptions? (Partial | undefined)

###### Returns

object.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Type

`ts
{
fetchFn?: FetchFn
gcps: Gcp[]
resourceMask: Ring
transformationType: TransformationType
internalProjection: Projection
projection: Projection
visible: boolean
applyMask: boolean
distortionMeasure: DistortionMeasure | undefined
}
`

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Type

`ts
'log2sigma' | 'twoOmega' | 'airyKavr' | 'signDetJ' | 'thetaa'
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
boolean
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
{ type: "GeoreferencedMap"; resource: { type: "ImageService1" | "ImageService2" | "ImageService3" | "Canvas"; id: string; height?: number | undefined; width?: number | undefined; partOf?: ({ type: string; id: string; label?: Record | undefined; } & { partOf?: ({ type: string; i...
`

$3

###### Type

`ts
{ fetchFn?: FetchFn | undefined; gcps?: Array | undefined; resourceMask?: Ring | undefined; transformationType?: TransformationType | undefined; ... 4 more ...; distortionMeasure?: DistortionMeasure | undefined; }
`

$3

Get default and georeferenced map options

###### Parameters

There are no parameters.

###### Returns

{
fetchFn?: FetchFn
gcps: Gcp[]
resourceMask: Ring
transformationType: TransformationType
internalProjection: Projection
projection: Projection
visible: boolean
applyMask: boolean
distortionMeasure: DistortionMeasure | undefined
}.

$3

Get a projected transformer of the given transformation type.

Uses cashed projected transformers by transformation type,
and only computes a new projected transformer if none found.

Returns a projected transformer in the current projection,
even if the cached transformer was computed in a different projection.

Default settings apply for the options.

###### Parameters

* transformationType ( | 'straight'
| 'helmert'
| 'polynomial'
| 'polynomial1'
| 'polynomial2'
| 'polynomial3'
| 'thinPlateSpline'
| 'projective'
| 'linear')
* partialProjectedGcpTransformerOptions? (Partial | undefined)

###### Returns

A projected transformer (ProjectedGcpTransformer).

$3

Get the reference scaling from the forward transformation of the projected Helmert transformer

###### Parameters

There are no parameters.

###### Returns

number.

$3

###### Parameters

There are no parameters.

###### Returns

[Point, Point, Point, Point].

$3

Get scale of the warped map, in resource pixels per canvas pixels.

###### Parameters

* viewport (Viewport)
* the current viewport

###### Returns

number.

$3

Get scale of the warped map, in resource pixels per viewport pixels.

###### Parameters

* viewport (Viewport)
* the current viewport

###### Returns

number.

$3

Check if this instance has parsed image

###### Parameters

There are no parameters.

###### Returns

boolean.

$3

###### Type

`ts
Image
`

$3

###### Type

`ts
{id?: string; name?: string; definition: ProjectionDefinition}
`

$3

###### Type

`ts
{ createRTree?: boolean | undefined; rtreeUpdatedOptions?: Array | undefined; animatedOptions?: Array | undefined; renderMaps?: boolean | undefined; renderLines?: boolean | undefined; renderPoints?: boolean | undefined; ... 58 more ...; distortionMeasure?: DistortionMeasure | undefined; }
`

$3

Load the parsed image from cache, or fetch and parse the image info to create it

###### Parameters

* imagesById? (Map | undefined)

###### Returns

Promise.

$3

###### Type

`ts
string
`

$3

###### Type

`ts
{ fetchFn?: FetchFn | undefined; gcps?: Array | undefined; resourceMask?: Ring | undefined; transformationType?: TransformationType | undefined; ... 4 more ...; distortionMeasure?: DistortionMeasure | undefined; }
`

$3

Mix previous transform properties with new ones (when changing an ongoing animation).

###### Parameters

* t (number)
* animation progress

###### Returns

void.

$3

###### Type

`ts
false
`

$3

###### Type

`ts
{
fetchFn?: FetchFn
gcps: Gcp[]
resourceMask: Ring
transformationType: TransformationType
internalProjection: Projection
projection: Projection
visible: boolean
applyMask: boolean
distortionMeasure: DistortionMeasure | undefined
}
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
{
scaleFactor: number
width: number
height: number
originalWidth: number
originalHeight: number
columns: number
rows: number
}
`

$3

###### Type

`ts
'log2sigma' | 'twoOmega' | 'airyKavr' | 'signDetJ' | 'thetaa'
`

$3

###### Type

`ts
{id?: string; name?: string; definition: ProjectionDefinition}
`

$3

###### Type

`ts
| 'straight'
| 'helmert'
| 'polynomial'
| 'polynomial1'
| 'polynomial2'
| 'polynomial3'
| 'thinPlateSpline'
| 'projective'
| 'linear'
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
ProjectedGcpTransformer
`

$3

###### Type

`ts
ProjectedGcpTransformer
`

$3

###### Type

`ts
Map
`

$3

###### Type

`ts
Map>
`

$3

###### Type

`ts
{id?: string; name?: string; definition: ProjectionDefinition}
`

$3

Reset the properties for the current values

###### Parameters

There are no parameters.

###### Returns

void.

$3

Reset previous transform properties to new ones (when completing an animation).

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
[number, number, number, number]
`

$3

###### Type

`ts
[Point, Point, Point, Point]
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
number
`

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

Set the distortionMeasure

###### Parameters

* distortionMeasure? (DistortionMeasure | undefined)
* the disortion measure

###### Returns

void.

$3

Set tiles for the current viewport

###### Parameters

* fetchableTiles (Array)

###### Returns

void.

$3

Update the ground control points loaded from a georeferenced map to new ground control points.

###### Parameters

* gcps (Array)

###### Returns

void.

$3

Set the internal projection

###### Parameters

* projection? (Projection | undefined)
* the internal projection

###### Returns

void.

$3

###### Parameters

* listOptions? (Partial | undefined)
* animationOptions? (Partial | undefined)

###### Returns

object.

$3

###### Parameters

* mapOptions? (Partial | undefined)
* listOptions? (Partial | undefined)
* animationOptions? (Partial | undefined)

###### Returns

object.

$3

Set overview tiles for the current viewport

###### Parameters

* overviewFetchableTiles (Array)

###### Returns

void.

$3

Set the overview tile zoom level for the current viewport

###### Parameters

* tileZoomLevel? (TileZoomLevel | undefined)
* tile zoom level for the current viewport

###### Returns

void.

$3

Set projectedGeoBufferedViewportRectangle for the current viewport

###### Parameters

* projectedGeoBufferedViewportRectangle? (Rectangle | undefined)

###### Returns

void.

$3

Set the projection

###### Parameters

* projection? (Projection | undefined)
* the projection

###### Returns

void.

$3

Set resourceBufferedViewportRingBboxAndResourceMaskBboxIntersection for the current viewport

###### Parameters

* resourceBufferedViewportRingBboxAndResourceMaskBboxIntersection? (Bbox | undefined)

###### Returns

void.

$3

Set resourceBufferedViewportRing for the current viewport

###### Parameters

* resourceBufferedViewportRing? (Ring | undefined)

###### Returns

void.

$3

Update the resource mask loaded from a georeferenced map to a new mask.

###### Parameters

* resourceFullMask (Array)
* resourceAppliableMask (Array)
* resourceMask (Array)

###### Returns

void.

$3

Set the tile zoom level for the current viewport

###### Parameters

* tileZoomLevel? (TileZoomLevel | undefined)
* tile zoom level for the current viewport

###### Returns

void.

$3

Set the transformationType

###### Parameters

* transformationType ( | 'straight'
| 'helmert'
| 'polynomial'
| 'polynomial1'
| 'polynomial2'
| 'polynomial3'
| 'thinPlateSpline'
| 'projective'
| 'linear')

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

boolean.

$3

###### Parameters

There are no parameters.

###### Returns

boolean.

$3

###### Parameters

There are no parameters.

###### Returns

boolean.

$3

###### Type

`ts
[number, number]
`

$3

###### Type

`ts
{
scaleFactor: number
width: number
height: number
originalWidth: number
originalHeight: number
columns: number
rows: number
}
`

$3

###### Type

`ts
| 'straight'
| 'helmert'
| 'polynomial'
| 'polynomial1'
| 'polynomial2'
| 'polynomial3'
| 'thinPlateSpline'
| 'projective'
| 'linear'
`

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

Get default options

###### Parameters

There are no parameters.

###### Returns

{
fetchFn?: FetchFn
gcps: Gcp[]
resourceMask: Ring
transformationType: TransformationType
internalProjection: Projection
projection: Projection
visible: boolean
applyMask: boolean
distortionMeasure: DistortionMeasure | undefined
}.

$3

###### Parameters

* type (WarpedMapEventType)
* data? (Partial | undefined)

###### Returns

WarpedMapEvent.

###### Extends

* Event

$3

###### Type

`ts
{
mapIds?: Array | undefined
tileUrl?: string | undefined
optionKeys?: Array | undefined
spritesInfo?: SpritesInfo | undefined
}
`

$3

Creates an instance of a WarpedMapList

###### Parameters

* warpedMapFactory ((
mapId: string,
georeferencedMap: GeoreferencedMap,
listOptions?: Partial,
mapOptions?: Partial
) => W)
* Factory function for creating WarpedMap objects
* options? (Partial | undefined)
* Options of this list, which will be set on newly added maps as their list options

###### Returns

WarpedMapList.

###### Extends

* EventTarget

$3

###### Parameters

* warpedMap (W)

###### Returns

void.

$3

Parses an annotation and adds its georeferenced map to this list

###### Parameters

* annotation (unknown)
* Annotation
* mapOptions? (Partial> | undefined)
* Map options

###### Returns

Map IDs of the maps that were added, or an error per map (Promise>).

$3

Adds a georeferenced map to this list

###### Parameters

* georeferencedMap (unknown)
* Georeferenced Map
* mapOptions? (Partial> | undefined)
* Map options

###### Returns

Map ID of the map that was added (Promise).

$3

###### Parameters

* georeferencedMap ({ type: "GeoreferencedMap"; resource: { type: "ImageService1" | "ImageService2" | "ImageService3" | "Canvas"; id: string; height?: number | undefined; width?: number | undefined; partOf?: ({ type: string; id: string; label?: Record | undefined; } & { partOf?: ({ type: string; i...)
* mapOptions? (Partial> | undefined)

###### Returns

Promise.

$3

Adds image informations, parses them to images and adds them to the image cache

###### Parameters

* imageInfos (Array)
* Image informations

###### Returns

Image IDs of the image informations that were added (Array).

$3

###### Parameters

* warpedMap (W)

###### Returns

void.

$3

Changes the z-index of the specified maps to bring them forward

###### Parameters

* mapIds (Iterable)
* Map IDs

###### Returns

void.

$3

Changes the z-index of the specified maps to bring them to front

###### Parameters

* mapIds (Iterable)
* Map IDs

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

Get the default options of the list

###### Parameters

There are no parameters.

###### Returns

SpecificWarpedMapListOptions &
Partial &
GetWarpedMapOptions.

$3

Get the default options of a map

These come from the default option settings for WebGL2WarpedMaps and the map's georeferenced map proporties

###### Parameters

* mapId (string)
* Map ID for which the options apply

###### Returns

GetWarpedMapOptions | undefined.

$3

Get mapIds for selected maps

The selectionOptions allow a.o. to:

* filter for visible maps
* filter for specific mapIds
* filter for maps whose geoBbox overlap with the specified geoBbox
* filter for maps that overlap with a given geoPoint

###### Parameters

* partialSelectionOptions? (Partial | undefined)
* Selection options (e.g. mapIds), defaults to all visible maps

###### Returns

mapIds (Array).

$3

Get the map-specific options of a map

###### Parameters

* mapId (string)
* Map ID for which the options apply

###### Returns

Partial> | undefined.

$3

Get the options of a map

These options are the result of merging the default, georeferenced map,
layer and map-specific options of that map.

###### Parameters

* mapId (string)
* Map ID for which the options apply

###### Returns

GetWarpedMapOptions | undefined.

$3

Get the z-index of a map

###### Parameters

* mapId (string)
* Map ID for which to get the z-index

###### Returns

number | undefined.

$3

Get the bounding box of the maps in this list

The result is returned in the list's projection, EPSG:3857 by default
Use {projection: {definition: 'EPSG:4326'}} to request the result in lon-lat EPSG:4326

###### Parameters

* partialSelectionAndProjectionOptions? (Partial | undefined)
* Selection (e.g. mapIds) and projection options, defaults to all visible maps and current projection

###### Returns

The bbox of all selected maps, in the chosen projection, or undefined if there were no maps matching the selection (Bbox | undefined).

$3

Get the center of the bounding box of the maps in this list

The result is returned in the list's projection, EPSG:3857 by default
Use {projection: {definition: 'EPSG:4326'}} to request the result in lon-lat EPSG:4326

###### Parameters

* partialSelectionAndProjectionOptions? (Partial | undefined)
* Selection (e.g. mapIds) and projection options, defaults to all visible maps and current projection

###### Returns

The center of the bbox of all selected maps, in the chosen projection, or undefined if there were no maps matching the selection (Point | undefined).

$3

Get the convex hull of the maps in this list

The result is returned in the list's projection, EPSG:3857 by default
Use {projection: {definition: 'EPSG:4326'}} to request the result in lon-lat EPSG:4326

###### Parameters

* partialSelectionAndProjectionOptions? (Partial | undefined)
* Selection (e.g. mapIds) and projection options, defaults to all visible maps and current projection

###### Returns

The convex hull of all selected maps, in the chosen projection, or undefined if there were no maps matching the selection (Ring | undefined).

$3

Get the options of this list

###### Parameters

There are no parameters.

###### Returns

{ createRTree?: boolean | undefined; rtreeUpdatedOptions?: Array | undefined; animatedOptions?: Array | undefined; renderMaps?: boolean | undefined; renderLines?: boolean | undefined; renderPoints?: boolean | undefined; ... 58 more ...; distortionMeasure?: DistortionMeasure | undefined; }.

$3

###### Parameters

* georeferencedMap ({ type: "GeoreferencedMap"; resource: { type: "ImageService1" | "ImageService2" | "ImageService3" | "Canvas"; id: string; height?: number | undefined; width?: number | undefined; partOf?: ({ type: string; id: string; label?: Record | undefined; } & { partOf?: ({ type: string; i...)

###### Returns

Promise.

$3

###### Parameters

* partialSelectionAndProjectionOptions? (Partial | undefined)

###### Returns

Array.

$3

Get the WarpedMap instance for a map

###### Parameters

* mapId (string)
* Map ID of the requested WarpedMap instance

###### Returns

WarpedMap instance, or undefined (W | undefined).

$3

Get the WarpedMap instances for selected maps

The selectionOptions allow a.o. to:

* filter for visible maps
* filter for specific mapIds
* filter for maps whose geoBbox overlap with the specified geoBbox
* filter for maps that overlap with a given geoPoint

###### Parameters

* partialSelectionOptions? (Partial | undefined)
* Selection options (e.g. mapIds), defaults to all visible maps

###### Returns

WarpedMap instances (Iterable).

$3

###### Parameters

* mapId (string)

###### Returns

void.

$3

###### Type

`ts
Map
`

$3

Internal set map options

###### Parameters

* mapOptionsByMapId? (Map | undefined> | undefined)
* listOptions? (Partial | undefined)
* animationOptions? (Partial | undefined)

###### Returns

void.

$3

###### Type

`ts
SpecificWarpedMapListOptions & Partial
`

$3

Order mapIds

Use this as anonymous sort function in Array.prototype.sort()

###### Parameters

* mapId0 (string)
* mapId1 (string)

###### Returns

number.

$3

###### Parameters

* warpedMap (W)

###### Returns

void.

$3

###### Parameters

* warpedMap (W)

###### Returns

void.

$3

Parses an annotation and removes its georeferenced map from this list

###### Parameters

* annotation (unknown)

###### Returns

Map IDs of the maps that were removed, or an error per map (Promise>).

$3

Removes a georeferenced map from this list

###### Parameters

* georeferencedMap (unknown)

###### Returns

Map ID of the removed map, or an error (Promise).

$3

Removes a georeferenced map from the list by its ID

###### Parameters

* mapId (string)
* Map ID

###### Returns

Map ID of the removed map, or an error (Promise).

$3

###### Parameters

* mapId (string)

###### Returns

Promise.

$3

###### Parameters

* georeferencedMap ({ type: "GeoreferencedMap"; resource: { type: "ImageService1" | "ImageService2" | "ImageService3" | "Canvas"; id: string; height?: number | undefined; width?: number | undefined; partOf?: ({ type: string; id: string; label?: Record | undefined; } & { partOf?: ({ type: string; i...)

###### Returns

Promise.

$3

###### Parameters

There are no parameters.

###### Returns

void.

$3

Resets the map-specific options of maps (and the list options)

An empty array resets all options, undefined resets no options.

###### Parameters

* mapIds (Array)
* Map IDs for which to reset the options
* mapOptionKeys? (Array | undefined)
* Keys of the map-specific options to reset
* listOptionKeys? (Array | undefined)
* Keys of the list options to reset
* animationOptions? (Partial | undefined)
* Animation options

###### Returns

void.

$3

Resets the map-specific options of maps by map ID (and the list options)

An empty array or map resets all options (for all maps), undefined resets no options.

###### Parameters

* mapOptionkeysByMapId? (Map> | undefined)
* Keys of map-specific options to reset by map ID
* listOptionKeys? (Array | undefined)
* Keys of the list options to reset
* animationOptions? (Partial | undefined)
* Animation options

###### Returns

void.

$3

Resets the list options

An empty array resets all options, undefined resets no options.

###### Parameters

* listOptionKeys? (Array | undefined)
* Keys of the list options to reset
* animationOptions? (Partial | undefined)
* Animation options

###### Returns

void.

$3

###### Type

`ts
RTree
`

$3

Changes the zIndex of the specified maps to send them backward

###### Parameters

* mapIds (Iterable)
* Map IDs

###### Returns

void.

$3

Changes the z-index of the specified maps to send them to back

###### Parameters

* mapIds (Iterable)
* Map IDs

###### Returns

void.

$3

Set the map-specific options of maps (and the list options)

###### Parameters

* mapIds (Array)
* Map IDs for which the options apply
* mapOptions? (Partial | undefined)
* Map-specific options
* listOptions? (Partial | undefined)
* list options
* animationOptions? (Partial | undefined)
* Animation options

###### Returns

void.

$3

Set the map-specific options of maps by map ID (and the list options)

This is useful when when multiple (and possibly different)
map-specific options are changed at once,
but only one animation should be fired

###### Parameters

* mapOptionsByMapId? (Map> | undefined)
* Map-specific options by map ID
* listOptions? (Partial | undefined)
* List options
* animationOptions? (Partial | undefined)
* Animation options

###### Returns

void.

$3

Set the options of this list

Note: Map-specific options set here will be passed to newly added maps.

###### Parameters

* options? (Partial | undefined)
* List Options
* animationOptions? (Partial | undefined)
* Animation options

###### Returns

void.

$3

###### Type

`ts
(
mapId: string,
georeferencedMap: GeoreferencedMap,
listOptions?: Partial,
mapOptions?: Partial
) => W
`

$3

Maps in this list, indexed by their ID (Map).

$3

###### Type

`ts
Map
`

$3

###### Type

`ts
SpecificWarpedMapListOptions & Partial
`

$3

###### Fields

* applyMask (boolean)
* distortionMeasure (DistortionMeasure | undefined)
* fetchFn? ((
input: Request | string | URL,
init?: RequestInit
) => Promise)
* gcps (Array)
* internalProjection ({id?: string; name?: string; definition: ProjectionDefinition})
* projection ({id?: string; name?: string; definition: ProjectionDefinition})
* resourceMask (Array)
* transformationType ( | 'straight'
| 'helmert'
| 'polynomial'
| 'polynomial1'
| 'polynomial2'
| 'polynomial3'
| 'thinPlateSpline'
| 'projective'
| 'linear')
* visible (boolean)

$3

###### Parameters

There are no parameters.

###### Returns

(
mapId: string,
georeferencedMap: GeoreferencedMap,
listOptions?: Partial,
mapOptions?: Partial
) => WarpedMap.

$3

###### Parameters

* getImageData ((data: Uint8ClampedArray) => D)
* getImag