Class TileGrid

Classdesc

Base class for setting the grid pattern for sources accessing tiled-image servers.

Param: options

Tile grid options.

Struct

Api

stable

Hierarchy

Constructors

constructor

Methods

forEachTileCoord getMaxZoom getMinZoom getOrigin getResolution getResolutions getTileCoordExtent getTileCoordForCoordAndResolution getTileCoordForCoordAndZ getTileSize getZForResolution

Constructors

constructor

  • new TileGrid(options): TileGrid

  • Parameters

    Returns TileGrid

    Classdesc

    Base class for setting the grid pattern for sources accessing tiled-image servers.

    Struct

    Api

    stable

Methods

forEachTileCoord

  • forEachTileCoord(extent, zoom, callback): void

  • Call a function with each tile coordinate for a given extent and zoom level.

    Parameters

    • extent: Extent

      Extent.

    • zoom: number

      Zoom level.

    • callback: ((coords) => any)

      Function called with each tile coordinate.

        • (coords): any

        • Parameters

          Returns any

    Returns void

    Api

getMaxZoom

  • getMaxZoom(): number

  • Get the maximum zoom level for the grid.

    Returns number

    Max zoom.

    Api

getMinZoom

  • getMinZoom(): number

  • Get the minimum zoom level for the grid.

    Returns number

    Min zoom.

    Api

getOrigin

  • getOrigin(z): Coordinate

  • Get the origin for the grid at the given zoom level.

    Parameters

    • z: number

      Z.

    Returns Coordinate

    Origin.

    Api

    stable

getResolution

  • getResolution(z): number

  • Get the resolution for the given zoom level.

    Parameters

    • z: number

      Z.

    Returns number

    Resolution.

    Api

    stable

getResolutions

  • getResolutions(): number[]

  • Get the list of resolutions for the tile grid.

    Returns number[]

    Resolutions.

    Api

    stable

getTileCoordExtent

  • getTileCoordExtent(tileCoord, opt_extent?): Extent

  • Get the extent of a tile coordinate.

    Parameters

    • tileCoord: TileCoord

      Tile coordinate.

    • Optional opt_extent: Extent

      Temporary extent object.

    Returns Extent

    Extent.

    Api

getTileCoordForCoordAndResolution

  • getTileCoordForCoordAndResolution(coordinate, resolution, opt_tileCoord?): TileCoord

  • Get the tile coordinate for the given map coordinate and resolution. This method considers that coordinates that intersect tile boundaries should be assigned the higher tile coordinate.

    Parameters

    • coordinate: Coordinate

      Coordinate.

    • resolution: number

      Resolution.

    • Optional opt_tileCoord: TileCoord

      Destination ol.TileCoord object.

    Returns TileCoord

    Tile coordinate.

    Api

getTileCoordForCoordAndZ

  • getTileCoordForCoordAndZ(coordinate, z, opt_tileCoord?): TileCoord

  • Get a tile coordinate given a map coordinate and zoom level.

    Parameters

    • coordinate: Coordinate

      Coordinate.

    • z: number

      Zoom level.

    • Optional opt_tileCoord: TileCoord

      Destination ol.TileCoord object.

    Returns TileCoord

    Tile coordinate.

    Api

getTileSize

  • getTileSize(z): number | Size

  • Get the tile size for a zoom level. The type of the return value matches the tileSize or tileSizes that the tile grid was configured with. To always get an ol.Size, run the result through ol.size.toSize().

    Parameters

    • z: number

      Z.

    Returns number | Size

    Tile size.

    Api

    stable

getZForResolution

  • getZForResolution(resolution, opt_direction?): number

  • Parameters

    • resolution: number

      Resolution.

    • Optional opt_direction: number

      If 0, the nearest resolution will be used. If 1, the nearest lower resolution will be used. If -1, the nearest higher resolution will be used. Default is 0.

    Returns number

    Z.

    Api

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc