@xylabs/geo

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/geo

Classes

• GeoJson
• LayerBase
• MercatorBoundingBox
• MercatorLngLat

Type Aliases

• MercatorTile
• MercatorBoundary

Variables

• d2r
• r2d

Functions

• boundingBoxToBoundary
• boundingBoxToCenter
• boundingBoxToPolygon
• tileFromPoint
• tileFromQuadkey
• tileToBoundingBox
• tileToChildren
• tileToGeoJson
• tileToParent
• tileToPoint
• tileToQuadkey
• tileToSiblings
• tilesEqual
• tilesFromBoundingBox
• hasSiblings
• tilesHasTile

classes

GeoJson

@xylabs/geo

Constructors

Constructor

new GeoJson(quadkey): GeoJson;

Parameters

quadkey

string

Returns

GeoJson

Methods

featureCollection()

static featureCollection(features): FeatureCollection;

Parameters

features

Feature<Geometry, GeoJsonProperties>[]

Returns

FeatureCollection

featuresSource()

static featuresSource(data): GeoJSONSourceSpecification;

Parameters

data

FeatureCollection

Returns

GeoJSONSourceSpecification

geometryFeature()

static geometryFeature(geometry): Feature;

Parameters

geometry

Geometry

Returns

Feature

center()

center(): LngLat;

Returns

LngLat

point()

point(): Point;

Returns

Point

pointFeature()

pointFeature(): Feature;

Returns

Feature

pointFeatureCollection()

pointFeatureCollection(): FeatureCollection;

Returns

FeatureCollection

pointSource()

pointSource(): GeoJSONSourceSpecification;

Returns

GeoJSONSourceSpecification

polygon()

polygon(): Polygon;

Returns

Polygon

polygonFeature()

polygonFeature(): Feature;

Returns

Feature

polygonFeatureCollection()

polygonFeatureCollection(): FeatureCollection;

Returns

FeatureCollection

polygonSource()

polygonSource(): GeoJSONSourceSpecification;

Returns

GeoJSONSourceSpecification

zoom()

zoom(): number;

Returns

number

LayerBase

@xylabs/geo

Type Parameters

T

T extends MapBox.Layer

Constructors

Constructor

new LayerBase<T>(id, source): LayerBase<T>;

Parameters

id

string

source

string

Returns

LayerBase<T>

Properties

id

id: string;

source

source: string;

Methods

update()

update(map, show): void;

Parameters

map

Map$1

show

boolean = true

Returns

void

buildLayer()

abstract buildLayer(): T;

Returns

T

MercatorBoundingBox

@xylabs/geo

Extends

• LngLatBounds

Constructors

Constructor

new MercatorBoundingBox(sw?, ne?): MercatorBoundingBox;

Parameters

sw?

[number, number, number, number] | LngLatLike | [LngLatLike, LngLatLike]

ne?

LngLatLike

Returns

MercatorBoundingBox

Inherited from

MapBox.LngLatBounds.constructor

MercatorLngLat

@xylabs/geo

Extends

• LngLat

Constructors

Constructor

new MercatorLngLat(lng, lat): MercatorLngLat;

Parameters

lng

number

lat

number

Returns

MercatorLngLat

Inherited from

MapBox.LngLat.constructor

functions

boundingBoxToBoundary

@xylabs/geo

function boundingBoxToBoundary(box): MercatorBoundary;

Parameters

box

MercatorBoundingBox

Returns

MercatorBoundary

boundingBoxToCenter

@xylabs/geo

function boundingBoxToCenter(boundingBox, decimal): number[];

Parameters

boundingBox

MercatorBoundingBox

decimal

number = 6

Returns

number[]

boundingBoxToPolygon

@xylabs/geo

function boundingBoxToPolygon(box): Polygon;

Parameters

box

MercatorBoundingBox

Returns

Polygon

hasSiblings

@xylabs/geo

function hasSiblings(tiles, tile): boolean;

Parameters

tiles

MercatorTile[]

tile

MercatorTile

Returns

boolean

tileFromPoint

@xylabs/geo

function tileFromPoint(point, z): number[];

Parameters

point

MercatorLngLat

z

number

Returns

number[]

tileFromQuadkey

@xylabs/geo

function tileFromQuadkey(quadkey): number[];

Parameters

quadkey

string

Returns

number[]

tileToBoundingBox

@xylabs/geo

function tileToBoundingBox(tile): MercatorBoundingBox;

Parameters

tile

MercatorTile

Returns

MercatorBoundingBox

tileToChildren

@xylabs/geo

function tileToChildren(tile): number[][];

Parameters

tile

MercatorTile

Returns

number[][]

tileToGeoJson

@xylabs/geo

function tileToGeoJson(tile): Polygon;

Parameters

tile

MercatorTile

Returns

Polygon

tileToParent

@xylabs/geo

function tileToParent(tile): MercatorTile;

Parameters

tile

MercatorTile

Returns

MercatorTile

tileToPoint

@xylabs/geo

function tileToPoint(tile): MercatorLngLat;

Parameters

tile

MercatorTile

Returns

MercatorLngLat

tileToQuadkey

@xylabs/geo

function tileToQuadkey(tile): string;

Parameters

tile

MercatorTile

Returns

string

tileToSiblings

@xylabs/geo

function tileToSiblings(tile): MercatorTile[];

Parameters

tile

MercatorTile

Returns

MercatorTile[]

tilesEqual

@xylabs/geo

function tilesEqual(tile1, tile2): boolean;

Parameters

tile1

MercatorTile

tile2

MercatorTile

Returns

boolean

tilesFromBoundingBox

@xylabs/geo

function tilesFromBoundingBox(box, zoom): MercatorTile[];

Parameters

box

MercatorBoundingBox

zoom

number

Returns

MercatorTile[]

tilesHasTile

@xylabs/geo

function tilesHasTile(tiles, tile): boolean;

Parameters

tiles

MercatorTile[]

tile

MercatorTile

Returns

boolean

type-aliases

MercatorBoundary

@xylabs/geo

type MercatorBoundary = MercatorLngLat[];

MercatorTile

@xylabs/geo

type MercatorTile = number[];

variables

d2r

@xylabs/geo

const d2r: number;

r2d

@xylabs/geo

const r2d: number;

Part of sdk-js

Maintainers

• Arie Trouw (arietrouw.com)
• Matt Jones
• Joel Carter
• Jordan Trouw

License

See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs