@swim/geo

@swim/geo implements geospatial coordinate, projection, and geometry types. @swim/geo is part of the @swim/core framework.

For an npm-managed project, npm install @swim/geo to make it a dependency. TypeScript sources will be installed into node_modules/@swim/geo/main. Transpiled JavaScript and TypeScript definition files install into node_modules/@swim/geo/lib/main. And a pre-built UMD script can be found in node_modules/@swim/geo/dist/main/swim-geo.js.

Browser

Browser applications can load swim-core.js, which comes bundled with the @swim/geo library, directly from the SwimOS CDN.

<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-core.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-core.min.js"></script>

Alternatively, the standalone swim-system.js script may be loaded from the SwimOS CDN, which bundles @swim/geo together with all other @swim/system libraries.

<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-system.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-system.min.js"></script>

Usage

ES6/TypeScript

@swim/geo can be imported as an ES6 module from TypeScript and other ES6-compatible environments.

import * as geo from "@swim/geo";

CommonJS/Node.js

@swim/geo can also be used as a CommonJS module in Node.js applications.

var geo = require("@swim/geo");

Browser

When loaded by a web browser, the swim-core.js script adds all @swim/geo library exports to the global swim namespace.

The swim-system.js script also adds all @swim/geo library exports to the global swim namespace, making it a drop-in replacement for swim-core.js when additional @swim/system libraries are needed.

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

AnyGeoShape

AnyGeoSpline

AnyGeoSpline: GeoSpline | GeoSplinePoints

AnyGeoTile

AnyGeoTile: GeoTile | GeoTileInit | GeoTileTuple

GeoJson

GeoJson: GeoJsonGeometry | GeoJsonFeature | GeoJsonFeatureCollection

GeoJsonBbox

GeoJsonBbox: [number, number, number, number] | [number, number, number, number, number, number]

GeoJsonGeometry

GeoJsonGeometryType

GeoJsonObjectType

GeoJsonObjectType: GeoJsonGeometryType | "Feature" | "FeatureCollection"

GeoJsonPosition

GeoJsonPosition: [number, number] | [number, number, number]

GeoJsonProperties

GeoJsonProperties: {}

Type declaration

[name: string]: unknown

GeoPathSplines

GeoPathSplines: ReadonlyArray<AnyGeoSpline>

GeoPointTuple

GeoPointTuple: [number, number]

GeoSplinePoints

GeoSplinePoints: ReadonlyArray<AnyGeoPoint>

GeoTileTuple

GeoTileTuple: [number, number, number]

Variables

Const GeoBoxInterpolator

GeoBoxInterpolator: { prototype: Interpolator<GeoBox> }

Type declaration

- (s0: GeoBox, s1: GeoBox): Interpolator<GeoBox>
- Parameters
  - s0: GeoBox
  - s1: GeoBox
  Returns Interpolator<GeoBox>
prototype: Interpolator<GeoBox>

GeoJson

GeoJson: { is: any; toShape: any }

Type declaration

is: function
- is(value: unknown): value is GeoJson
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:61
  Parameters
  - value: unknown
  Returns value is GeoJson
toShape: function
- toShape(geometry: GeoJsonGeometry): GeoShape
- toShape(feature: GeoJsonFeature<GeoJsonGeometry, GeoJsonProperties>): null | GeoShape
- toShape(collection: GeoJsonFeatureCollection<GeoJsonGeometry, GeoJsonProperties>): (null | GeoShape)[]
- toShape(object: GeoJson): null | GeoShape | (null | GeoShape)[]
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:62
  Parameters
  - geometry: GeoJsonGeometry
  Returns GeoShape
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:63
  Parameters
  - feature: GeoJsonFeature<GeoJsonGeometry, GeoJsonProperties>
  Returns null | GeoShape
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:64
  Parameters
  - collection: GeoJsonFeatureCollection<GeoJsonGeometry, GeoJsonProperties>
  Returns (null | GeoShape)[]
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:65
  Parameters
  - object: GeoJson
  Returns null | GeoShape | (null | GeoShape)[]

GeoJsonFeature

GeoJsonFeature: { is: any; toShape: any }

Type declaration

is: function
- is(value: unknown): value is GeoJsonFeature<GeoJsonGeometry, GeoJsonProperties>
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:100
  Parameters
  - value: unknown
  Returns value is GeoJsonFeature<GeoJsonGeometry, GeoJsonProperties>
toShape: function
- toShape(feature: GeoJsonFeature<GeoJsonGeometry, GeoJsonProperties>): null | GeoShape
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:101
  Parameters
  - feature: GeoJsonFeature<GeoJsonGeometry, GeoJsonProperties>
  Returns null | GeoShape

GeoJsonFeatureCollection

GeoJsonFeatureCollection: { is: any; toShapes: any }

Type declaration

is: function
- is(value: unknown): value is GeoJsonFeatureCollection<GeoJsonGeometry, GeoJsonProperties>
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:104
  Parameters
  - value: unknown
  Returns value is GeoJsonFeatureCollection<GeoJsonGeometry, GeoJsonProperties>
toShapes: function
- toShapes(object: GeoJsonFeatureCollection<GeoJsonGeometry, GeoJsonProperties>): (null | GeoShape)[]
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:105
  Parameters
  - object: GeoJsonFeatureCollection<GeoJsonGeometry, GeoJsonProperties>
  Returns (null | GeoShape)[]

GeoJsonGeometry

GeoJsonGeometry: { is: any; toShape: any }

Type declaration

is: function
- is(value: unknown): value is GeoJsonGeometry
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:68
  Parameters
  - value: unknown
  Returns value is GeoJsonGeometry
toShape: function
- toShape(object: GeoJsonGeometry): GeoShape
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:69
  Parameters
  - object: GeoJsonGeometry
  Returns GeoShape

GeoJsonGeometryCollection

GeoJsonGeometryCollection: { is: any; toShape: any }

Type declaration

is: function
- is(value: unknown): value is GeoJsonGeometryCollection
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:96
  Parameters
  - value: unknown
  Returns value is GeoJsonGeometryCollection
toShape: function
- toShape(object: GeoJsonGeometryCollection): GeoGroup<GeoShape>
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:97
  Parameters
  - object: GeoJsonGeometryCollection
  Returns GeoGroup<GeoShape>

GeoJsonLineString

GeoJsonLineString: { is: any; toShape: any }

Type declaration

is: function
- is(value: unknown): value is GeoJsonLineString
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:80
  Parameters
  - value: unknown
  Returns value is GeoJsonLineString
toShape: function
- toShape(object: GeoJsonLineString): GeoSpline
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:81
  Parameters
  - object: GeoJsonLineString
  Returns GeoSpline

GeoJsonMultiLineString

GeoJsonMultiLineString: { is: any; toShape: any }

Type declaration

is: function
- is(value: unknown): value is GeoJsonMultiLineString
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:84
  Parameters
  - value: unknown
  Returns value is GeoJsonMultiLineString
toShape: function
- toShape(object: GeoJsonMultiLineString): GeoGroup<GeoSpline>
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:85
  Parameters
  - object: GeoJsonMultiLineString
  Returns GeoGroup<GeoSpline>

GeoJsonMultiPoint

GeoJsonMultiPoint: { is: any; toShape: any }

Type declaration

is: function
- is(value: unknown): value is GeoJsonMultiPoint
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:76
  Parameters
  - value: unknown
  Returns value is GeoJsonMultiPoint
toShape: function
- toShape(object: GeoJsonMultiPoint): GeoGroup<GeoPoint>
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:77
  Parameters
  - object: GeoJsonMultiPoint
  Returns GeoGroup<GeoPoint>

GeoJsonMultiPolygon

GeoJsonMultiPolygon: { is: any; toShape: any }

Type declaration

is: function
- is(value: unknown): value is GeoJsonMultiPolygon
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:92
  Parameters
  - value: unknown
  Returns value is GeoJsonMultiPolygon
toShape: function
- toShape(object: GeoJsonMultiPolygon): GeoGroup<GeoPath>
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:93
  Parameters
  - object: GeoJsonMultiPolygon
  Returns GeoGroup<GeoPath>

GeoJsonPoint

GeoJsonPoint: { is: any; toShape: any }

Type declaration

is: function
- is(value: unknown): value is GeoJsonPoint
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:72
  Parameters
  - value: unknown
  Returns value is GeoJsonPoint
toShape: function
- toShape(object: GeoJsonPoint): GeoPoint
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:73
  Parameters
  - object: GeoJsonPoint
  Returns GeoPoint

GeoJsonPolygon

GeoJsonPolygon: { is: any; toShape: any }

Type declaration

is: function
- is(value: unknown): value is GeoJsonPolygon
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:88
  Parameters
  - value: unknown
  Returns value is GeoJsonPolygon
toShape: function
- toShape(object: GeoJsonPolygon): GeoPath
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoJson.d.ts:89
  Parameters
  - object: GeoJsonPolygon
  Returns GeoPath

Const GeoPointInterpolator

GeoPointInterpolator: { prototype: Interpolator<GeoPoint> }

Type declaration

- (p0: GeoPoint, p1: GeoPoint): Interpolator<GeoPoint>
- Parameters
  - p0: GeoPoint
  - p1: GeoPoint
  Returns Interpolator<GeoPoint>
prototype: Interpolator<GeoPoint>

GeoProjection

GeoProjection: { is: any }

Type declaration

is: function
- is(object: unknown): object is GeoProjection
- - Defined in swim-system-js/swim-core-js/@swim/geo/lib/main/GeoProjection.d.ts:10
  Parameters
  - object: unknown
  Returns object is GeoProjection

Const GeoSegmentInterpolator

GeoSegmentInterpolator: { prototype: Interpolator<GeoSegment> }

Type declaration

- (s0: GeoSegment, s1: GeoSegment): Interpolator<GeoSegment>
- Parameters
  - s0: GeoSegment
  - s1: GeoSegment
  Returns Interpolator<GeoSegment>
prototype: Interpolator<GeoSegment>

@swim/geo

Installation

npm

Browser

Usage

ES6/TypeScript

CommonJS/Node.js

Browser

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

AnyGeoBox

AnyGeoPath

AnyGeoPoint

AnyGeoSegment

AnyGeoShape

AnyGeoSpline

AnyGeoTile

GeoJson

GeoJsonBbox

GeoJsonGeometry

GeoJsonGeometryType

GeoJsonObjectType

GeoJsonPosition

GeoJsonProperties

Type declaration

[name: string]: unknown

GeoPathSplines

GeoPointTuple

GeoSplinePoints

GeoTileTuple

Variables

Const GeoBoxInterpolator

Type declaration

Parameters

s0: GeoBox

s1: GeoBox

Returns Interpolator<GeoBox>

prototype: Interpolator<GeoBox>

GeoJson

Type declaration

is: function

Parameters

value: unknown

Returns value is GeoJson

toShape: function

Parameters

geometry: GeoJsonGeometry

Returns GeoShape

Parameters

feature: GeoJsonFeature<GeoJsonGeometry, GeoJsonProperties>

Returns null | GeoShape

Parameters

collection: GeoJsonFeatureCollection<GeoJsonGeometry, GeoJsonProperties>

Returns (null | GeoShape)[]

Parameters

object: GeoJson

Returns null | GeoShape | (null | GeoShape)[]

GeoJsonFeature

Type declaration

is: function

Parameters

value: unknown

Returns value is GeoJsonFeature<GeoJsonGeometry, GeoJsonProperties>

toShape: function

Parameters

feature: GeoJsonFeature<GeoJsonGeometry, GeoJsonProperties>

Returns null | GeoShape

GeoJsonFeatureCollection

Type declaration

is: function

Parameters

value: unknown

Returns value is GeoJsonFeatureCollection<GeoJsonGeometry, GeoJsonProperties>

toShapes: function

Parameters

object: GeoJsonFeatureCollection<GeoJsonGeometry, GeoJsonProperties>