@allmaps/types

Allmaps TypeScript types

Geometry types

The following Geometries are used by default Allmaps packages.

``ts
type Point = [number, number]

type LineString = Point[]

type Polygon = Point[][]
// A Polygon is an array of rings of at least three points
// Rings are not closed: the first point is not repeated at the end.
// There is no requirement on winding order.

type MultiPoint = Point[]
// Notice that this is equivalent to the LineString type, hence the isMultiGeometry option

type MultiLineString = Point[][]
// Notice that this is equivalent to the Polygon type, hence the isMultiGeometry option

type MultiPolygon = Point[][][]

type Geometry =
| Point
| LineString
| Polygon
| MultiPoint
| MultiLineString
| MultiPolygon
`

To interact with external data, the following types are used as well:

GeoJSON Geometries follow the GeoJSON specification.

SVG Geometries are expressed using the following types (but note that some functions allow svg's to be passed as a string):

`js
export type SvgCircle = {
type: 'circle'
attributes?: SvgAttributes
coordinates: Point
}

export type SvgLine = {
type: 'line'
attributes?: SvgAttributes
coordinates: [Point, Point]
}

export type SvgPolyLine = {
type: 'polyline'
attributes?: SvgAttributes
coordinates: Point[]
}

export type SvgPolygon = {
type: 'polygon'
attributes?: SvgAttributes
coordinates: Point[]
}

export type SvgRect = {
type: 'rect'
attributes?: SvgAttributes
coordinates: Point[]
}

export type SvgGeometry =
| SvgCircle
| SvgLine
| SvgPolyLine
| SvgPolygon
| SvgRect
`

API

$3

Bbox ([number, number, number, number]). Defined as \[xMin, yMin, xMax, yMax]

$3

###### Fields

* clipLngLat (boolean)
* clipWebMercator (boolean)

$3

###### Type

`ts
[number, number, number]
`

$3

###### Fields

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

$3

###### Type

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

$3

###### Type

`ts
(
input: Request | string | URL,
init?: RequestInit
) => Promise
`

$3

Two ways two rectangles (or shapes in general) can overlap: ('cover' | 'contain').

* 'contain': The first contains the second
* 'cover': The first is covered by the second

$3

###### Fields

* geo ([number, number])
* resource ([number, number])

$3

###### Fields

* geometry ( | GeojsonPoint
| GeojsonLineString
| GeojsonPolygon
| GeojsonMultiPoint
| GeojsonMultiLineString
| GeojsonMultiPolygon)
* properties (unknown)
* type ('Feature')

$3

###### Fields

* features (Array)
* type ('FeatureCollection')

$3

###### Type

`ts
| GeojsonPoint
| GeojsonLineString
| GeojsonPolygon
| GeojsonMultiPoint
| GeojsonMultiLineString
| GeojsonMultiPolygon
`

$3

###### Type

`ts
| 'Point'
| 'LineString'
| 'Polygon'
| 'MultiPoint'
| 'MultiLineString'
| 'MultiPolygon'
`

$3

###### Fields

* coordinates (Array>)
* type ('LineString')

$3

###### Type

`ts
GeojsonMultiPoint | GeojsonMultiLineString | GeojsonMultiPolygon
`

$3

###### Fields

* coordinates (Array>>)
* type ('MultiLineString')

$3

###### Fields

* coordinates (Array>)
* type ('MultiPoint')

$3

###### Fields

* coordinates (Array>>>)
* type ('MultiPolygon')

$3

###### Fields

* coordinates (Array)
* type ('Point')

$3

###### Fields

* coordinates (Array>>)
* type ('Polygon')

$3

###### Type

`ts
| Point
| LineString
| Polygon
| MultiPoint
| MultiLineString
| MultiPolygon
`

$3

###### Fields

* [bin: string] ({count: number; color: Color})

$3

Weights array of a 2D Homogeneous Transform Matrix

These coefficients are used in the same order in multiple places

* CSS Transform defined by a 2D matrix. Use toString() before using this as input for a CSS matrix() function.
* WebGL 2D transform matrices.
* OpenLayers' transform class.

See:
See:

Note: The weights array of a Polynomial1 Transformation has a different order. See the corresponding conversion functions.

###### Type

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

$3

###### Fields

* region? ({x: number; y: number; width: number; height: number})
* size? ({width: number; height: number})

$3

###### Type

`ts
[Point, Point]
`

$3

###### Type

`ts
Array
`

$3

###### Type

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

$3

###### Fields

* isMultiGeometry (boolean)

$3

###### Type

`ts
Array>
`

$3

###### Type

`ts
Array
`

$3

###### Type

`ts
Array>>
`

$3

###### Type

`ts
[number, number]
`

$3

###### Type

`ts
Array>
`

$3

Rectangle (or possibly quadrilateral) ([Point, Point, Point, Point]). Winding order of points is free.

$3

###### Fields

* height (number)
* width (number)
* x (number)
* y (number)

$3

Ring as [[number, number], ...] (Array).

Must contain at least 3 points
May not contain duplicate points
Must be unclosed: last element is not a repetition of the first
May not be self-intersecting
So far no requirement on self-intersection although that may be useful in future
So far no requirement on winding order. This is only applied when exporting to GeoJSON

$3

Two numbers indicating the size of a Bbox as \[width, height] or \[xSize, ySize] ([number, number]).
Alternatively, two numbers indicating the minimum and maximum of, for example, an array of numbers
Alternatively, two numbers indicating the dimensions of a matrix: rows, cols (which is a different handedness!)

$3

###### Fields

* height (number)
* width (number)

$3

###### Type

`ts
{[x: string]: string | number}
`

$3

###### Fields

* attributes? ({[x: string]: string | number})
* coordinates ([number, number])
* type ('circle')

$3

###### Type

`ts
SvgCircle | SvgLine | SvgPolyLine | SvgPolygon | SvgRect
`

$3

###### Fields

* attributes? ({[x: string]: string | number})
* coordinates ([Point, Point])
* type ('line')

$3

###### Fields

* attributes? ({[x: string]: string | number})
* coordinates (Array)
* type ('polyline')

$3

###### Fields

* attributes? ({[x: string]: string | number})
* coordinates (Array)
* type ('polygon')

$3

###### Fields

* attributes? ({[x: string]: string | number})
* coordinates (Array)
* type ('rect')

$3

###### Fields

* column (number)
* imageSize ([number, number])
* row (number)
* tileZoomLevel ({
scaleFactor: number
width: number
height: number
originalWidth: number
originalHeight: number
columns: number
rows: number
})

$3

###### Fields

* [key: number] ([number, number])

$3

###### Fields

* columns (number)
* height (number)
* originalHeight (number)
* originalWidth (number)
* rows (number)
* scaleFactor (number)
* width (number)

$3

Triangle
As [[x0, y0], [x1, y1], [x2, y2]] ([Point, Point, Point]).

Winding order of points is free.

$3

###### Type

`ts
P | TypedLineString

| TypedPolygon

| TypedMultiPoint

| TypedMultiLineString

| TypedMultiPolygon<...>
`

$3

###### Type

`ts
[P, P]
`

$3

###### Type

`ts
Array


`

$3

###### Type

`ts
Array>
`

$3

###### Type

`ts
Array


`

$3

###### Type

`ts
Array>>
`

$3

###### Type

`ts
Array>
`

$3

###### Type

`ts
[P, P, P, P]
`

$3

###### Type

`ts
Array


`

$3

###### Type

`ts
[P, P, P]
``