WebMercatorTilingScheme - Cesium Documentation

# WebMercatorTilingScheme

#### new WebMercatorTilingScheme(options)

  A tiling scheme for geometry referenced to a `WebMercatorProjection`, EPSG:3857. This is the tiling scheme used by Google Maps, Microsoft Bing Maps, and most of ESRI ArcGIS Online.

  Name | Type | Description
  --- | --- | ---

  `options`

  Object

  optional Object with the following properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `ellipsoid` | Ellipsoid | `Ellipsoid.WGS84` | optional The ellipsoid whose surface is being tiled. Defaults to the WGS84 ellipsoid.
  `numberOfLevelZeroTilesX` | Number | `1` | optional The number of tiles in the X direction at level zero of the tile tree.
  `numberOfLevelZeroTilesY` | Number | `1` | optional The number of tiles in the Y direction at level zero of the tile tree.
  `rectangleSouthwestInMeters` | Cartesian2 |  | optional The southwest corner of the rectangle covered by the tiling scheme, in meters. If this parameter or rectangleNortheastInMeters is not specified, the entire globe is covered in the longitude direction and an equal distance is covered in the latitude direction, resulting in a square projection.
  `rectangleNortheastInMeters` | Cartesian2 |  | optional The northeast corner of the rectangle covered by the tiling scheme, in meters. If this parameter or rectangleSouthwestInMeters is not specified, the entire globe is covered in the longitude direction and an equal distance is covered in the latitude direction, resulting in a square projection.

  Source: Core/WebMercatorTilingScheme.js, line 43

### Members

#### ellipsoid :Ellipsoid

  Gets the ellipsoid that is tiled by this tiling scheme.
  Source: Core/WebMercatorTilingScheme.js, line 74

#### projection :MapProjection

  Gets the map projection used by this tiling scheme.
  Source: Core/WebMercatorTilingScheme.js, line 96

#### rectangle :Rectangle

  Gets the rectangle, in radians, covered by this tiling scheme.
  Source: Core/WebMercatorTilingScheme.js, line 85

### Methods

#### getNumberOfXTilesAtLevel(level) → Number

  Gets the total number of tiles in the X direction at a specified level-of-detail.

  Name | Type | Description
  --- | --- | ---
  `level` | Number | The level-of-detail.

  ##### Returns:

  The number of tiles in the X direction at the given level.
  Source: Core/WebMercatorTilingScheme.js, line 109

#### getNumberOfYTilesAtLevel(level) → Number

  Gets the total number of tiles in the Y direction at a specified level-of-detail.

  Name | Type | Description
  --- | --- | ---
  `level` | Number | The level-of-detail.

  ##### Returns:

  The number of tiles in the Y direction at the given level.
  Source: Core/WebMercatorTilingScheme.js, line 119

#### positionToTileXY(position, level, result) → Cartesian2

  Calculates the tile x, y coordinates of the tile containing a given cartographic position.

  Name | Type | Description
  --- | --- | ---
  `position` | Cartographic | The position.
  `level` | Number | The tile level-of-detail. Zero is the least detailed.
  `result` | Cartesian2 | optional The instance to which to copy the result, or undefined if a new instance should be created.

  ##### Returns:

  The specified 'result', or a new object containing the tile x, y coordinates if 'result' is undefined.
  Source: Core/WebMercatorTilingScheme.js, line 220

#### rectangleToNativeRectangle(rectangle, result) → Rectangle

  Transforms an rectangle specified in geodetic radians to the native coordinate system of this tiling scheme.

  Name | Type | Description
  --- | --- | ---
  `rectangle` | Rectangle | The rectangle to transform.
  `result` | Rectangle | optional The instance to which to copy the result, or undefined if a new instance should be created.

  ##### Returns:

  The specified 'result', or a new object containing the native rectangle if 'result' is undefined.
  Source: Core/WebMercatorTilingScheme.js, line 133

#### tileXYToNativeRectangle(x, y, level, result) → Rectangle

  Converts tile x, y coordinates and level to an rectangle expressed in the native coordinates of the tiling scheme.

  Name | Type | Description
  --- | --- | ---
  `x` | Number | The integer x coordinate of the tile.
  `y` | Number | The integer y coordinate of the tile.
  `level` | Number | The tile level-of-detail. Zero is the least detailed.
  `result` | Object | optional The instance to which to copy the result, or undefined if a new instance should be created.

  ##### Returns:

  The specified 'result', or a new object containing the rectangle if 'result' is undefined.
  Source: Core/WebMercatorTilingScheme.js, line 161

#### tileXYToRectangle(x, y, level, result) → Rectangle

  Converts tile x, y coordinates and level to a cartographic rectangle in radians.

  Name | Type | Description
  --- | --- | ---
  `x` | Number | The integer x coordinate of the tile.
  `y` | Number | The integer y coordinate of the tile.
  `level` | Number | The tile level-of-detail. Zero is the least detailed.
  `result` | Object | optional The instance to which to copy the result, or undefined if a new instance should be created.

  ##### Returns:

  The specified 'result', or a new object containing the rectangle if 'result' is undefined.
  Source: Core/WebMercatorTilingScheme.js, line 195