Edit

Share via

VectorTileSourceOptions interface

  • Reference
Package:
azure-maps-control

A data source for managing shape data that will be displayed on the map. A data source must be added to a layer before it is visible on the map. Options for a VectorTileSource.

Extends
Options

Properties

bounds

A bounding box that specifies where tiles are available. When specified, no tiles outside of the bounding box will be requested.
isTMS

Specifies is the tile systems y coordinate uses the OSGeo Tile Map Services which reverses the Y coordinate axis. default false
maxZoom

An integer specifying the maximum zoom level to render the layer at. default 22
minZoom

An integer specifying the minimum zoom level to render the layer at. default 0
tiles

An array of one or more tile source URLs. Supported URL parameters:

  • `{x}` - X position of tile. Tile URL usually also needs {y} and {z}.
  • `{y}` - Y position of tile. Tile URL usually also needs {x} and {z}.
  • `{z}` - Zoom level of tile. Tile URL usually also needs {x} and {y}.
  • `{quadkey}` - Tile quadkey id based on the Bing Maps tile system naming convention.
  • `{bbox-epsg-3857}` - A bounding box string with the format "{west},{south},{east},{north}" with coordinates in the EPSG 3857 Spatial Reference System also commonly known as WGS84 Web Mercator. This is useful when working with WMS imagery services.
url

A URL to a TileJSON resource. Supported protocols are http: and https:.

Property Details

bounds

A bounding box that specifies where tiles are available. When specified, no tiles outside of the bounding box will be requested.

bounds?: BoundingBox

Property Value

BoundingBox

isTMS

Specifies is the tile systems y coordinate uses the OSGeo Tile Map Services which reverses the Y coordinate axis. default false

isTMS?: boolean

Property Value

boolean

maxZoom

An integer specifying the maximum zoom level to render the layer at. default 22

maxZoom?: number

Property Value

number

minZoom

An integer specifying the minimum zoom level to render the layer at. default 0

minZoom?: number

Property Value

number

tiles

An array of one or more tile source URLs. Supported URL parameters:

  • `{x}` - X position of tile. Tile URL usually also needs {y} and {z}.
  • `{y}` - Y position of tile. Tile URL usually also needs {x} and {z}.
  • `{z}` - Zoom level of tile. Tile URL usually also needs {x} and {y}.
  • `{quadkey}` - Tile quadkey id based on the Bing Maps tile system naming convention.
  • `{bbox-epsg-3857}` - A bounding box string with the format "{west},{south},{east},{north}" with coordinates in the EPSG 3857 Spatial Reference System also commonly known as WGS84 Web Mercator. This is useful when working with WMS imagery services.
      • tiles?: string[]

      Property Value

      string[]

url

A URL to a TileJSON resource. Supported protocols are http: and https:.

url?: string

Property Value

string