Namespace Mercator

The Mercator module provides utility functions when working with a map in Mercator project, such as converting between geographical coordinates and pixel coordinates and calculating coordinate bounds.

Index

Functions

Functions

Const coordToPoint

coordToPoint(lat: number, lon: number, zoom: number, center?: Coordinate, size?: Size): Point

- Defined in src/maps/proj/Mercator.ts:103
Returns the pixel location for the specified pixel location on a map.

Parameters
- lat: number
- lon: number
- zoom: number
- Default value center: Coordinate = undefined
- Default value size: Size = undefined
Returns Point

Const coordToTile

coordToTile(coord: Coordinate, zoom: number): Point

- Defined in src/maps/proj/Mercator.ts:250
Returns the map tile coordinate that contains the given geographical coordinate based on a specific zoom level.

Parameters
- coord: Coordinate
- zoom: number
Returns Point

Const getBoundsCenter

getBoundsCenter(bounds: GeoBounds): Coordinate

- Defined in src/maps/proj/Mercator.ts:127
Returns the center coordinate for the specified coordinate bounds.

Parameters
- bounds: GeoBounds
Returns Coordinate

Const getBoundsThatFits

getBoundsThatFits(bounds: GeoBounds, size: Size, padding?: number): GeoBounds

- Defined in src/maps/proj/Mercator.ts:196
Returns a new coordinate bounds that best fits the given coordinate bounds based on the map size and any amount of padding.

Parameters
- bounds: GeoBounds
- size: Size
- Default value padding: number = 0
Returns GeoBounds

Const getBoundsZoomLevel

getBoundsZoomLevel(bounds: GeoBounds, size: Size): number

- Defined in src/maps/proj/Mercator.ts:146
Returns the zoom level that best fits the given coordinate bounds based on the map size.

Parameters
- bounds: GeoBounds
- size: Size
Returns number

Const getSizeForBounds

getSizeForBounds(bounds: GeoBounds, zoom: number): Size

- Defined in src/maps/proj/Mercator.ts:178
Returns the map size for the given coordinate bounds and zoom level.

Parameters
- bounds: GeoBounds
- zoom: number
Returns Size

Const pointToCoord

pointToCoord(x: number, y: number, zoom: number, center?: Coordinate, size?: Size): Coordinate

- Defined in src/maps/proj/Mercator.ts:75
Returns the coordinate for the specified pixel location on a map.

Parameters
- x: number
- y: number
- zoom: number
- Default value center: Coordinate = undefined
- Default value size: Size = undefined
Returns Coordinate

Const tileToCoord

tileToCoord(tile: Point, zoom: number): Coordinate

- Defined in src/maps/proj/Mercator.ts:270
Returns the geographical coordinate for the top-left corner of the given map tile coordinate based on a specific zoom level.

Parameters
- tile: Point
- zoom: number
Returns Coordinate

Generated using TypeDoc