Cartographic - Cesium Documentation

# Cartographic

#### new Cartographic(longitude, latitude, height)

  A position defined by longitude, latitude, and height.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `longitude` | Number | `0.0` | optional The longitude, in radians.
  `latitude` | Number | `0.0` | optional The latitude, in radians.
  `height` | Number | `0.0` | optional The height, in meters, above the ellipsoid.

  ##### See:

  - Ellipsoid
  Source: Core/Cartographic.js, line 27

### Members

#### staticconstantCartographic.ZERO :Cartographic

  An immutable Cartographic instance initialized to (0.0, 0.0, 0.0).
  Source: Core/Cartographic.js, line 176

#### height :Number

  The height, in meters, above the ellipsoid.
  Default Value: `0.0`
  Source: Core/Cartographic.js, line 47

#### latitude :Number

  The latitude, in radians.
  Default Value: `0.0`
  Source: Core/Cartographic.js, line 40

#### longitude :Number

  The longitude, in radians.
  Default Value: `0.0`
  Source: Core/Cartographic.js, line 33

### Methods

#### staticCartographic.clone(cartographic, result) → Cartographic

  Duplicates a Cartographic instance.

  Name | Type | Description
  --- | --- | ---
  `cartographic` | Cartographic | The cartographic to duplicate.
  `result` | Cartographic | optional The object onto which to store the result.

  ##### Returns:

  The modified result parameter or a new Cartographic instance if one was not provided. (Returns undefined if cartographic is undefined)
  Source: Core/Cartographic.js, line 115

#### staticCartographic.equals(left, right) → Boolean

  Compares the provided cartographics componentwise and returns `true` if they are equal, `false` otherwise.

  Name | Type | Description
  --- | --- | ---
  `left` | Cartographic | optional The first cartographic.
  `right` | Cartographic | optional The second cartographic.

  ##### Returns:

  `true` if left and right are equal, `false` otherwise.
  Source: Core/Cartographic.js, line 136

#### staticCartographic.equalsEpsilon(left, right, epsilon) → Boolean

  Compares the provided cartographics componentwise and returns `true` if they are within the provided epsilon, `false` otherwise.

  Name | Type | Description
  --- | --- | ---
  `left` | Cartographic | optional The first cartographic.
  `right` | Cartographic | optional The second cartographic.
  `epsilon` | Number | The epsilon to use for equality testing.

  ##### Returns:

  `true` if left and right are within the provided epsilon, `false` otherwise.
  Source: Core/Cartographic.js, line 155

#### staticCartographic.fromDegrees(longitude, latitude, height, result) → Cartographic

  Creates a new Cartographic instance from longitude and latitude specified in degrees. The values in the resulting object will be in radians.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `longitude` | Number |  | The longitude, in degrees.
  `latitude` | Number |  | The latitude, in degrees.
  `height` | Number | `0.0` | optional The height, in meters, above the ellipsoid.
  `result` | Cartographic |  | optional The object onto which to store the result.

  ##### Returns:

  The modified result parameter or a new Cartographic instance if one was not provided.
  Source: Core/Cartographic.js, line 93

#### staticCartographic.fromRadians(longitude, latitude, height, result) → Cartographic

  Creates a new Cartographic instance from longitude and latitude specified in radians.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `longitude` | Number |  | The longitude, in radians.
  `latitude` | Number |  | The latitude, in radians.
  `height` | Number | `0.0` | optional The height, in meters, above the ellipsoid.
  `result` | Cartographic |  | optional The object onto which to store the result.

  ##### Returns:

  The modified result parameter or a new Cartographic instance if one was not provided.
  Source: Core/Cartographic.js, line 60

#### clone(result) → Cartographic

  Duplicates this instance.

  Name | Type | Description
  --- | --- | ---
  `result` | Cartographic | optional The object onto which to store the result.

  ##### Returns:

  The modified result parameter or a new Cartographic instance if one was not provided.
  Source: Core/Cartographic.js, line 184

#### equals(right) → Boolean

  Compares the provided against this cartographic componentwise and returns `true` if they are equal, `false` otherwise.

  Name | Type | Description
  --- | --- | ---
  `right` | Cartographic | optional The second cartographic.

  ##### Returns:

  `true` if left and right are equal, `false` otherwise.
  Source: Core/Cartographic.js, line 195

#### equalsEpsilon(right, epsilon) → Boolean

  Compares the provided against this cartographic componentwise and returns `true` if they are within the provided epsilon, `false` otherwise.

  Name | Type | Description
  --- | --- | ---
  `right` | Cartographic | optional The second cartographic.
  `epsilon` | Number | The epsilon to use for equality testing.

  ##### Returns:

  `true` if left and right are within the provided epsilon, `false` otherwise.
  Source: Core/Cartographic.js, line 208

#### toString() → String

  Creates a string representing this cartographic in the format '(longitude, latitude, height)'.

  ##### Returns:

  A string representing the provided cartographic in the format '(longitude, latitude, height)'.
  Source: Core/Cartographic.js, line 217