@allmaps/stdlib

Allmaps Standard Library

License

MIT

API

$3

###### Parameters

* line ([Point, Point])

###### Returns

number.

$3

###### Parameters

* arrayMatrix (Array>)

###### Returns

[number, number].

$3

###### Parameters

* array (Array)
* isEqualObject (((t0: T, t1: T) => boolean) | undefined)

###### Returns

Array.

$3

###### Parameters

* bbox ([number, number, number, number])

###### Returns

[number, number].

$3

###### Parameters

* bbox ([number, number, number, number])

###### Returns

number.

$3

###### Parameters

* bbox ([number, number, number, number])

###### Returns

[Point, Point].

$3

###### Parameters

* bbox ([number, number, number, number])

###### Returns

Array>.

$3

###### Parameters

* bbox ([number, number, number, number])

###### Returns

[Point, Point, Point, Point].

$3

###### Parameters

* bbox ([number, number, number, number])

###### Returns

number.

$3

###### Parameters

* bbox ([number, number, number, number])

###### Returns

[number, number].

$3

###### Parameters

* bbox0 ([number, number, number, number])
* bbox1 ([number, number, number, number])

###### Returns

number.

$3

###### Parameters

* line ([Point, Point])

###### Returns

number.

$3

###### Parameters

* point ([number, number])
* min ([number, number])
* max ([number, number])

###### Returns

[number, number].

$3

###### Parameters

* point ([number, number])

###### Returns

[number, number].

$3

###### Parameters

* point ([number, number])

###### Returns

[number, number].

$3

###### Parameters

* value (number)
* min (number)
* max (number)

###### Returns

number.

$3

###### Parameters

* bbox ([number, number, number, number])
* dist0 (number)
* dist1 (number)

###### Returns

[number, number, number, number].

$3

###### Parameters

* bbox ([number, number, number, number])
* ratio? (number | undefined)

###### Returns

[number, number, number, number].

$3

###### Parameters

* string (string)

###### Returns

string.

$3

###### Parameters

* multiPolygon (Array>>)

###### Returns

Array>>.

$3

###### Parameters

* polygon (Array>)

###### Returns

Array>.

$3

###### Parameters

* ring (Array)

###### Returns

Array.

$3

###### Parameters

* bboxes ([number, number, number, number])

###### Returns

Bbox | undefined.

$3

###### Parameters

* points (Geometry | GeojsonGeometry)
* options? (Partial | undefined)

###### Returns

[number, number, number, number].

$3

###### Parameters

* values (Array)

###### Returns

[number, number].

$3

###### Parameters

* lineString (Array)

###### Returns

Array.

$3

###### Parameters

* multiLineString (Array>)

###### Returns

Array>.

$3

###### Parameters

* multiPolygon (Array>>)

###### Returns

Array>>.

$3

###### Parameters

* polygon (Array>)

###### Returns

Array>.

$3

###### Parameters

* ring (Array)

###### Returns

Array.

$3

###### Parameters

* geojsonGeometries (Array)

###### Returns

GeojsonMultiPoint | GeojsonMultiLineString | GeojsonMultiPolygon.

$3

###### Parameters

* geojsonLineStrings (Array)

###### Returns

{type: 'MultiLineString'; coordinates: number[][][]}.

$3

###### Parameters

* geojsonPoints (Array)

###### Returns

{type: 'MultiPoint'; coordinates: number[][]}.

$3

###### Parameters

* geojsonPolygons (Array)

###### Returns

{type: 'MultiPolygon'; coordinates: number[][][][]}.

$3

###### Parameters

* points (Array)

###### Returns

Ring | undefined.

$3

###### Parameters

* degrees (number)

###### Returns

number.

$3

###### Parameters

* from ([number, number])
* to ([number, number])

###### Returns

number.

$3

###### Parameters

* bbox0 ([number, number, number, number])
* bbox1 ([number, number, number, number])

###### Returns

boolean.

$3

###### Parameters

* set1 (Set | null)
* set2 (Set | null)

###### Returns

boolean.

$3

###### Parameters

* geojsonMultiGeometry (GeojsonMultiPoint | GeojsonMultiLineString | GeojsonMultiPolygon)

###### Returns

Array | Array | Array.

$3

###### Parameters

* geojsonMultiLineString ({type: 'MultiLineString'; coordinates: number[][][]})

###### Returns

Array.

$3

###### Parameters

* geojsonMultiPoint ({type: 'MultiPoint'; coordinates: number[][]})

###### Returns

Array.

$3

###### Parameters

* geojsonMultiPolygon ({type: 'MultiPolygon'; coordinates: number[][][][]})

###### Returns

Array.

$3

###### Parameters

* parsedIiif (Image | Manifest | Collection)

###### Returns

Promise>.

$3

###### Parameters

* input (RequestInfo | URL)
* init? (RequestInit | undefined)
* fetchFn? (FetchFn | undefined)

###### Returns

Promise.

$3

###### Parameters

* imageUri (string)
* init? (RequestInit | undefined)
* fetchFn? (FetchFn | undefined)

###### Returns

Promise.

$3

###### Parameters

* input (RequestInfo | URL)
* init? (RequestInit | undefined)
* fetchFn? (FetchFn | undefined)

###### Returns

Promise.

$3

###### Parameters

* input (RequestInfo | URL)
* init? (RequestInit | undefined)
* fetchFn? (FetchFn | undefined)

###### Returns

Promise.

$3

###### Parameters

* point ([number, number])

###### Returns

[number, number].

$3

###### Parameters

* point ([number, number])

###### Returns

[number, number].

$3

###### Parameters

* geojsonFeatureCollection ({type: 'FeatureCollection'; features: GeojsonFeature[]})

###### Returns

Array.

$3

###### Parameters

* geojsonFeature ({type: 'Feature'; properties: unknown; geometry: GeojsonGeometry})

###### Returns

| GeojsonPoint
| GeojsonLineString
| GeojsonPolygon
| GeojsonMultiPoint
| GeojsonMultiLineString
| GeojsonMultiPolygon.

$3

###### Parameters

* geojsonFeatures (GeojsonFeature | Array)

###### Returns

{type: 'FeatureCollection'; features: GeojsonFeature[]}.

$3

###### Parameters

* geojsonGeometries (Array)
* properties? (Array | undefined)

###### Returns

{type: 'FeatureCollection'; features: GeojsonFeature[]}.

$3

###### Parameters

* geojsonGeometry ( | GeojsonPoint
| GeojsonLineString
| GeojsonPolygon
| GeojsonMultiPoint
| GeojsonMultiLineString
| GeojsonMultiPolygon)
* properties? (unknown)

###### Returns

{type: 'Feature'; properties: unknown; geometry: GeojsonGeometry}.

$3

###### Parameters

* geojsonPoint ({type: 'Point'; coordinates: number[]})

###### Returns

[number, number].

$3

###### Parameters

* geojsonGeometry ( | GeojsonPoint
| GeojsonLineString
| GeojsonPolygon
| GeojsonMultiPoint
| GeojsonMultiLineString
| GeojsonMultiPolygon)

###### Returns

SvgCircle | SvgLine | SvgPolyLine | SvgPolygon | SvgRect.

$3

###### Parameters

* geojsonLineString ({type: 'LineString'; coordinates: number[][]})

###### Returns

Array.

$3

###### Parameters

* geojsonMultiLineString ({type: 'MultiLineString'; coordinates: number[][][]})

###### Returns

Array>.

$3

###### Parameters

* geojsonMultiPoint ({type: 'MultiPoint'; coordinates: number[][]})

###### Returns

Array.

$3

###### Parameters

* geojsonMultiPolygon ({type: 'MultiPolygon'; coordinates: number[][][][]})
* close (boolean | undefined)

###### Returns

Array>>.

$3

###### Parameters

* geojsonPoint ({type: 'Point'; coordinates: number[]})

###### Returns

[number, number].

$3

###### Parameters

* geojsonPolygon ({type: 'Polygon'; coordinates: number[][][]})
* close (boolean | undefined)

###### Returns

Array>.

$3

###### Parameters

* geojsonPolygon ({type: 'Polygon'; coordinates: number[][][]})
* close (boolean | undefined)

###### Returns

Array.

$3

###### Parameters

* geometry (Geometry | GeojsonGeometry)

###### Returns

number.

$3

###### Parameters

* point ([number, number])
* options? (Partial | undefined)

###### Returns

{type: 'Point'; coordinates: number[]}.

$3

###### Parameters

* point ([number, number])

###### Returns

{type: 'circle'; attributes?: SvgAttributes; coordinates: Point}.

$3

###### Parameters

* colors (Array)
* binSize (number | undefined)

###### Returns

{[bin: string]: ColorCount}.

$3

###### Parameters

* imageData (ImageData)
* resolution (number | undefined)

###### Returns

Array.

$3

###### Parameters

* imageWidth (number)
* imageHeight (number)

###### Returns

Array.

$3

###### Parameters

* imageBitmap (ImageBitmap)
* mask? (Array | undefined)

###### Returns

ImageData.

$3

###### Parameters

* histogram ({[bin: string]: ColorCount})

###### Returns

{count: number; color: Color}.

$3

###### Parameters

* cache (Map)
* key (K)
* computation (() => T)
* checkUse (((t: T) => boolean) | undefined)
* checkStore (((t: T) => boolean) | undefined)

###### Returns

T.

$3

###### Parameters

* cache (Map>)
* key0 (K0)
* key1 (K1)
* computation (() => T)
* checkUse (((t: T) => boolean) | undefined)
* checkStore (((t: T) => boolean) | undefined)

###### Returns

T.

$3

###### Parameters

* cache (Map>>>)
* key0 (K0)
* key1 (K1)
* key2 (K2)
* key3 (K3)
* computation (() => T)
* checkUse (((t: T) => boolean) | undefined)
* checkStore (((t: T) => boolean) | undefined)

###### Returns

T.

$3

###### Parameters

* cache (Map>>)
* key0 (K0)
* key1 (K1)
* key2 (K2)
* computation (() => T)
* checkUse (((t: T) => boolean) | undefined)
* checkStore (((t: T) => boolean) | undefined)

###### Returns

T.

$3

###### Parameters

* arr (Array)
* key ((i: T) => K)

###### Returns

{[P in K]: Array}.

$3

Convert hex to fractional RGBA, and sets the transparency to 1

###### Parameters

* hex (string)
* hex string, e.g. '#0033ffcc'

###### Returns

Fractional RGB, e ([number, number, number, number]).g. \[0, 0.2, 1, 1]

$3

Convert hex to fractional RGB

###### Parameters

* hex (string)
* hex string, e.g. '#0033ff'

###### Returns

Fractional RGB, e ([number, number, number]).g. \[0, 0.2, 1]

$3

Convert hex to fractional RGBA

###### Parameters

* hex (string)
* hex string, e.g. '#0033ffff'

###### Returns

Fractional RGB, e ([number, number, number, number]).g. \[0, 0.2, 1, 1]

$3

Convert HEX to RGB, and sets the transparency to 255

###### Parameters

* hex (string)
* HEX string, e.g. '#0033ffcc'

###### Returns

RGB, e ([number, number, number, number]).g. \[0, 51, 255, 255]

$3

Convert HEX to RGB

###### Parameters

* hex (string)
* HEX string, e.g. '#0033ff'

###### Returns

RGB, e ([number, number, number]).g. \[0, 51, 255]

$3

Convert HEX to RGB

###### Parameters

* hex (string)
* HEX string, e.g. '#0033ffff'

###### Returns

RGB, e ([number, number, number, number]).g. \[0, 51, 255, 255]

$3

###### Parameters

* bbox0 ([number, number, number, number])
* bbox1 ([number, number, number, number])

###### Returns

Bbox | undefined.

$3

###### Parameters

* point ([number, number])

###### Returns

[number, number].

$3

###### Parameters

* points (Array)

###### Returns

Array.

$3

###### Parameters

* input (Array)

###### Returns

boolean.

$3

###### Parameters

* array0 (Array)
* array1 (Array)
* isEqualObject (((t0: T, t1: T) => boolean) | undefined)

###### Returns

boolean.

$3

###### Parameters

* point0 ([number, number])
* point1 ([number, number])

###### Returns

boolean.

$3

###### Parameters

* pointArray0 (Array)
* pointArray1 (Array)

###### Returns

boolean.

$3

###### Parameters

* pointArrayArray0 (Array>)
* pointArrayArray1 (Array>)

###### Returns

boolean.

$3

###### Parameters

* obj (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* obj (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (unknown)

###### Returns

boolean.

$3

###### Parameters

* input (any)

###### Returns

boolean.

$3

###### Parameters

* input (any)

###### Returns

boolean.

$3

###### Parameters

* input (any)

###### Returns

boolean.

$3

###### Parameters

* input (any)

###### Returns

boolean.

$3

###### Parameters

* input (any)

###### Returns

boolean.

$3

###### Parameters

* string (string)

###### Returns

boolean.

$3

###### Parameters

* line ([Point, Point])

###### Returns

number.

$3

###### Parameters

* lineString (Array)

###### Returns

{type: 'LineString'; coordinates: number[][]}.

$3

###### Parameters

* lineString (Array)

###### Returns

Array.

$3

###### Parameters

* line0 ([Point, Point])
* line1 ([Point, Point])
* options? (Partial | undefined)

###### Returns

Point | undefined.

$3

###### Parameters

* map ({ type: "GeoreferencedMap"; gcps: { resource: [number, number]; geo: [number, number]; }[]; resource: { type: "ImageService1" | "ImageService2" | "ImageService3" | "Canvas"; id: string; partOf?: ({ type: string; id: string; label?: Record | undefined; } & { partOf?: ({ type: st...)

###### Returns

{type: 'polygon'; attributes?: SvgAttributes; coordinates: Ring}.

$3

###### Parameters

* geojsonFeatureCollections (Array)

###### Returns

{type: 'FeatureCollection'; features: GeojsonFeature[]}.

$3

###### Parameters

* baseOptions (T)
* additionalPartialOptions (U[0])

###### Returns

T & U[number].

$3

###### Parameters

* baseOptions (T)
* additionalOptions (Partial | undefined)

###### Returns

T & Partial.

$3

###### Parameters

* partialOptions (U[0])

###### Returns

{[P in keyof U[number]]?: U[number][P] | undefined}.

$3

###### Parameters

* baseOptions (T)
* additionalOption (Partial | undefined)

###### Returns

T & Partial.

$3

###### Parameters

* points ([number, number])

###### Returns

[number, number].

$3

###### Parameters

* lineString0 (Array)
* lineString1 (Array)
* t (number)

###### Returns

Array.

$3

###### Parameters

* number0 (number)
* number1 (number)
* t (number)

###### Returns

number.

$3

###### Parameters

* point0 ([number, number])
* point1 ([number, number])
* t (number)

###### Returns

[number, number].

$3

###### Parameters

* multiLineString (Array>)

###### Returns

{type: 'MultiLineString'; coordinates: number[][][]}.

$3

###### Parameters

* multiPoint (Array)

###### Returns

{type: 'MultiPoint'; coordinates: number[][]}.

$3

###### Parameters

* multiPolygon (Array>>)
* close (boolean | undefined)

###### Returns

{type: 'MultiPolygon'; coordinates: number[][][][]}.

$3

###### Parameters

* arrayMatrix (Array>)
* factor (number)

###### Returns

Array>.

$3

Create and fill a ArrayMatrix: an Arrays of Arrays, that can later be loaded as a ml-matrix Matrix

###### Parameters

* rows (number)
* cols (number)
* value (T | undefined)

###### Returns

Array>.

$3

###### Parameters

* blocks (Array>>>)
* emptyValue (T | undefined)

###### Returns

Array>.

$3

###### Parameters

* newObject (object)
* baseObject (object)
* objectKeysPossiblyChanged? (Array | undefined)

###### Returns

object.

$3

###### Parameters

* object (T)
* keys (Array)

###### Returns

{[P in keyof T]?: T[P] | undefined}.

$3

###### Parameters

* optionKeysByMapId (Map | undefined)

###### Returns

Map> | undefined.

$3

###### Parameters

* optionKeys (T | undefined)

###### Returns

Record | undefined.

$3

###### Parameters

* arrayMatrix (Array>)
* rowsStart (number)
* colsStart (number)
* subArrayMatrix (Array>)

###### Returns

Array>.

$3

###### Parameters

* pixel ([number, number])
* size ([number, number])
* channels (number)
* flipY (boolean | undefined)

###### Returns

number.

$3

###### Parameters

* point ([number, number])
* bbox ([number, number, number, number])

###### Returns

boolean.

$3

###### Parameters

* point ([number, number])

###### Returns

{type: 'Point'; coordinates: number[]}.

$3

###### Parameters

* point ([number, number])
* translate (Point | undefined)

###### Returns

[number, number].

$3

###### Parameters

* points0 (Array)
* points1 (Array)

###### Returns

Array.

$3

###### Parameters

* polygon (Array>)
* options? (Partial | undefined)

###### Returns

Array.

$3

###### Parameters

* polygon (Array>)
* close (boolean | undefined)

###### Returns

{type: 'Polygon'; coordinates: number[][][]}.

$3

###### Parameters

* line0 ([Point, Point])
* line1 ([Point, Point])

###### Returns

Point | undefined.

$3

###### Parameters

* radians (number)

###### Returns

number.

$3

###### Parameters

* rectangle ([Point, Point, Point, Point])

###### Returns

[number, number].

$3

###### Parameters

* rectangle0 ([Point, Point, Point, Point])
* rectangle1 ([Point, Point, Point, Point])

###### Returns

number.

$3

Convert RBG to HEX

###### Parameters

* color ([number, number, number])

###### Returns

HEX string, e (string).g. '#0033ff'

$3

Convert RBGA to HEX

###### Parameters

* color ([number, number, number, number])

###### Returns

HEX string, e (string).g. '#0033ffff'

$3

###### Parameters

* ring (Array)
* close (boolean | undefined)

###### Returns

{type: 'Polygon'; coordinates: number[][][]}.

$3

###### Parameters

* from (Array)
* to (Array)

###### Returns

number.

$3

###### Parameters

* point ([number, number])
* angle (number | undefined)
* anchor (Point | undefined)
* cosAngle? (number | undefined)
* sinAngle? (number | undefined)

###### Returns

[number, number].

$3

###### Parameters

* points (Array)
* angle (number | undefined)
* anchor (Point | undefined)
* cosAngle? (number | undefined)
* sinAngle? (number | undefined)

###### Returns

Array.

$3

###### Parameters

* point ([number, number])
* scale (number)

###### Returns

[number, number].

$3

###### Parameters

* points (Array)
* scale (number)

###### Returns

Array.

$3

###### Parameters

* size ([number, number])
* scale (number)

###### Returns

[number, number].

$3

###### Parameters

* arrayMatrix (Array>)

###### Returns

Array>.

$3

###### Parameters

* size ([number, number])

###### Returns

[number, number, number, number].

$3

###### Parameters

* size ([number, number])

###### Returns

[number, number].

$3

###### Parameters

* size ([number, number])

###### Returns

[Point, Point, Point, Point].

$3

###### Parameters

* size ([number, number])

###### Returns

number.

$3

Compute a size from two scales

For unspecified 'fit', the scale is computed based on the surface area derived from the sizes.

For specified 'fit':

Example for square rectangles '\*' and '+':

'contain' where '\*' contains '.'
(in the first image size0 is relatively wider)

``
**

`

.... ....

. . \ . .
.... ....
\ \
\\\\

'cover' where '\*' is covered by '.'
(in the first image size0 is relatively wider)

`
....
. .
`

..*.. \\\\*
. \ \ . \ \
..*.. \\\\*
. .
....

###### Parameters

* size0 ([number, number])
* first size
* size1 ([number, number])
* second size
* fit? (Fit | undefined)
* fit

###### Returns

number.

$3

###### Parameters

* arrayMatrix (Array>)
* rowsStart (number)
* colsStart (number)
* rowsEnd? (number | undefined)
* colsEnd? (number | undefined)

###### Returns

Array>.

$3

###### Parameters

* from ([number, number])
* to (Point | undefined)

###### Returns

number.

$3

###### Parameters

* point ([number, number])
* dist (number)
* angle (number)

###### Returns

[number, number].

$3

###### Parameters

* svg (string)

###### Returns

Generator.

$3

###### Parameters

* arrayMatrix (Array>)
* rows (Array)
* cols (Array)

###### Returns

Array>.

$3

###### Parameters

* arr1 (Array)
* arr2 (Array)

###### Returns

boolean.

$3

###### Parameters

* geometries (Array)

###### Returns

string.

$3

###### Parameters

* svgCircle ({type: 'circle'; attributes?: SvgAttributes; coordinates: Point})

###### Returns

[number, number].

$3

###### Parameters

* geometry (SvgCircle | SvgLine | SvgPolyLine | SvgPolygon | SvgRect)

###### Returns

string.

$3

Return angle alpha made at point A by points B and C

###### Parameters

* pointA ([number, number])
* pointB ([number, number])
* pointC ([number, number])

###### Returns

number.

$3

###### Parameters

* point ([number, number])
* translationPoint ([number, number])
* addOrSubstract ('add' | 'substract' | undefined)

###### Returns

[number, number].

$3

###### Parameters

* points (Array)
* point ([number, number])
* addOrSubstract ('add' | 'substract' | undefined)

###### Returns

Array.

$3

###### Parameters

* arrayMatrix (Array>)

###### Returns

Array>.

$3

###### Parameters

* triangle ([Point, Point, Point])

###### Returns

[number, number, number].

$3

###### Parameters

* triangle ([Point, Point, Point])

###### Returns

number.

$3

###### Parameters

* multiPolygon (Array>>)

###### Returns

Array>>.

$3

###### Parameters

* polygon (Array>)

###### Returns

Array>.

$3

###### Parameters

* ring (Array)

###### Returns

Array`.