TileMatrix interface

Package:

@azure/planetarycomputer

Tile Matrix Definition

A tile matrix, usually corresponding to a particular zoom level of a TileMatrixSet.

ref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/tileMatrix.json

Definition of a tile matrix at a specific zoom level within a tile matrix set

Properties

cellSize	Size of a pixel in map units at this tile matrix level
cornerOfOrigin	The corner of the tile matrix (topLeft or bottomLeft) used as the origin for numbering tile rows and columns. This corner is also a corner of the (0, 0) tile.
description	Human-readable description of this tile matrix level
id	Unique identifier for this tile matrix level, often the zoom level
keywords	Unordered list of one or more commonly used or formalized word(s) or phrase(s) used to describe this dataset
matrixHeight	Number of tiles vertically at this matrix level
matrixWidth	Number of tiles horizontally at this matrix level
pointOfOrigin	Precise position in CRS coordinates of the corner of origin (e.g. the top-left corner) for this tile matrix. This position is also a corner of the (0, 0) tile. In previous version, this was 'topLeftCorner' and 'cornerOfOrigin' did not exist.
scaleDenominator	Scale denominator representing the scale of this tile matrix level
tileHeight	Pixel height of each tile at this level
tileWidth	Pixel width of each tile at this level
title	Human-readable title of the tile matrix level
variableMatrixWidths	Describes the rows that has variable matrix width ref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/variableMatrixWidth.json

Property Details

cellSize

Size of a pixel in map units at this tile matrix level

cellSize: number

Property Value

number

cornerOfOrigin

The corner of the tile matrix (topLeft or bottomLeft) used as the origin for numbering tile rows and columns. This corner is also a corner of the (0, 0) tile.

cornerOfOrigin?: string

Property Value

string

description

Human-readable description of this tile matrix level

description?: string

Property Value

string

id

Unique identifier for this tile matrix level, often the zoom level

id: string

Property Value

string

keywords

Unordered list of one or more commonly used or formalized word(s) or phrase(s) used to describe this dataset

keywords?: string[]

Property Value

string[]

matrixHeight

Number of tiles vertically at this matrix level

matrixHeight: number

Property Value

number

matrixWidth

Number of tiles horizontally at this matrix level

matrixWidth: number

Property Value

number

pointOfOrigin

Precise position in CRS coordinates of the corner of origin (e.g. the top-left corner) for this tile matrix. This position is also a corner of the (0, 0) tile. In previous version, this was 'topLeftCorner' and 'cornerOfOrigin' did not exist.

pointOfOrigin: number[]

Property Value

number[]

scaleDenominator

Scale denominator representing the scale of this tile matrix level

scaleDenominator: number

Property Value

number

tileHeight

Pixel height of each tile at this level

tileHeight: number

Property Value

number

tileWidth

Pixel width of each tile at this level

tileWidth: number

Property Value

number

title

Human-readable title of the tile matrix level

title?: string

Property Value

string

variableMatrixWidths

Describes the rows that has variable matrix width

ref: https://github.com/opengeospatial/2D-Tile-Matrix-Set/blob/master/schemas/tms/2.0/json/variableMatrixWidth.json

variableMatrixWidths?: VariableMatrixWidth[]

Property Value

VariableMatrixWidth[]