On this page
Constructors
Properties
Methods

Class MercatorCoordinate

A MercatorCoordinate object represents a projected three dimensional position.

MercatorCoordinate uses the web mercator projection (EPSG:3857) with slightly different units:

  • the size of 1 unit is the width of the projected world instead of the "mercator meter"
  • the origin of the coordinate space is at the north-west corner instead of the middle

For example, MercatorCoordinate(0, 0, 0) is the north-west corner of the mercator world and MercatorCoordinate(1, 1, 0) is the south-east corner. If you are familiar with vector tiles it may be helpful to think of the coordinate space as the 0/0/0 tile with an extent of 1.

The z dimension of MercatorCoordinate is conformal. A cube in the mercator coordinate space would be rendered as a cube.

let nullIsland = new MercatorCoordinate(0.5, 0.5, 0);

Implements

Index

Constructors

constructor

Properties

x y z

Methods

meterInMercatorCoordinateUnits toAltitude toLngLat fromLngLat

Constructors

  • Parameters

    • x: number

      The x component of the position.

    • y: number

      The y component of the position.

    • Optionalz: number

      The z component of the position.

    Returns MercatorCoordinate

Properties

x: number
y: number
z: number

Methods

  • Returns the distance of 1 meter in MercatorCoordinate units at this latitude.

    For coordinates in real world units using meters, this naturally provides the scale to transform into MercatorCoordinates.

    Returns number

    Distance of 1 meter in MercatorCoordinate units.

  • Returns the altitude in meters of the coordinate.

    Returns number

    The altitude in meters.

    let coord = new MercatorCoordinate(0, 0, 0.02);
coord.toAltitude(); // 6914.281956295339

  • Returns the LngLat for the coordinate.

    Returns LngLat

    The LngLat object.

    let coord = new MercatorCoordinate(0.5, 0.5, 0);
let lngLat = coord.toLngLat(); // LngLat(0, 0)

  • Project a LngLat to a MercatorCoordinate.

    Parameters

    • lngLatLike: LngLatLike

      The location to project.

    • Optionalaltitude: number

      The altitude in meters of the position.

    Returns MercatorCoordinate

    The projected mercator coordinate.

    let coord = MercatorCoordinate.fromLngLat({ lng: 0, lat: 0}, 0);
coord; // MercatorCoordinate(0.5, 0.5, 0)
Was this helpful?
SDK JS
Reference
MercatorCoordinate