Skip to main content

@terascope/types / geo-interfaces

geo-interfaces

Enumerations​

EnumerationDescription
ESGeoShapeType-
GeoShapeRelation-
GeoShapeType-

Interfaces​

InterfaceDescription
GeoDistanceObj-
GeoPoint-

Type Aliases​

CoordinateTuple​

CoordinateTuple = [number, number]

Defined in: packages/types/src/geo-interfaces.ts:49

ESGeoShape​

ESGeoShape = ESGeoShapePoint | ESGeoShapePolygon | ESGeoShapeMultiPolygon

Defined in: packages/types/src/geo-interfaces.ts:22

ESGeoShapeMultiPolygon​

ESGeoShapeMultiPolygon = object

Defined in: packages/types/src/geo-interfaces.ts:17

Properties​

coordinates​

coordinates: CoordinateTuple[][][]

Defined in: packages/types/src/geo-interfaces.ts:19

type​

type: MultiPolygon

Defined in: packages/types/src/geo-interfaces.ts:18

ESGeoShapePoint​

ESGeoShapePoint = object

Defined in: packages/types/src/geo-interfaces.ts:7

Properties​

coordinates​

coordinates: CoordinateTuple

Defined in: packages/types/src/geo-interfaces.ts:9

type​

type: Point

Defined in: packages/types/src/geo-interfaces.ts:8

ESGeoShapePolygon​

ESGeoShapePolygon = object

Defined in: packages/types/src/geo-interfaces.ts:12

Properties​

coordinates​

coordinates: CoordinateTuple[][]

Defined in: packages/types/src/geo-interfaces.ts:14

type​

type: Polygon

Defined in: packages/types/src/geo-interfaces.ts:13

GeoBoundary​

GeoBoundary = readonly [GeoPoint, GeoPoint]

Defined in: packages/types/src/geo-interfaces.ts:72

A geo boundary is a box of geo points requiring at two geo points, one point is the top left, the other is the bottom right

GeoDistanceUnit​

GeoDistanceUnit = "miles" | "yards" | "feet" | "inch" | "kilometers" | "meters" | "centimeters" | "millimeters" | "nauticalmiles"

Defined in: packages/types/src/geo-interfaces.ts:83

GeoInput​

GeoInput = GeoPointInput | GeoPointInput[] | GeoShape

Defined in: packages/types/src/geo-interfaces.ts:81

GeoPointArr​

GeoPointArr = [number, number]

Defined in: packages/types/src/geo-interfaces.ts:51

GeoPointInput​

GeoPointInput = GeoPointArr | GeoPointStr | GeoObjShort | GeoObjLong | GeoShapePoint

Defined in: packages/types/src/geo-interfaces.ts:56

GeoPointStr​

GeoPointStr = string

Defined in: packages/types/src/geo-interfaces.ts:52

GeoShape​

GeoShape = GeoShapePoint | GeoShapePolygon | GeoShapeMultiPolygon

Defined in: packages/types/src/geo-interfaces.ts:45

GeoShapeMultiPolygon​

GeoShapeMultiPolygon = object

Defined in: packages/types/src/geo-interfaces.ts:40

Properties​

coordinates​

coordinates: CoordinateTuple[][][]

Defined in: packages/types/src/geo-interfaces.ts:42

type​

type: MultiPolygon

Defined in: packages/types/src/geo-interfaces.ts:41

GeoShapePoint​

GeoShapePoint = object

Defined in: packages/types/src/geo-interfaces.ts:30

Properties​

coordinates​

coordinates: CoordinateTuple

Defined in: packages/types/src/geo-interfaces.ts:32

type​

type: Point

Defined in: packages/types/src/geo-interfaces.ts:31

GeoShapePolygon​

GeoShapePolygon = object

Defined in: packages/types/src/geo-interfaces.ts:35

Properties​

coordinates​

coordinates: CoordinateTuple[][]

Defined in: packages/types/src/geo-interfaces.ts:37

type​

type: Polygon

Defined in: packages/types/src/geo-interfaces.ts:36

JoinGeoShape​

JoinGeoShape = GeoShape | ESGeoShape

Defined in: packages/types/src/geo-interfaces.ts:47

Variables​

GEO_DISTANCE_UNITS​

const GEO_DISTANCE_UNITS: object

Defined in: packages/types/src/geo-interfaces.ts:85

Index Signature​

[key: string]: GeoDistanceUnit