PyramidTileId Class
Note
Bing Maps Web Control SDK retirement
Bing Maps Web Control SDK is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps Web Control SDK until June 30th, 2025. Enterprise account customers can continue to use Bing Maps Web Control SDK until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps Web Control SDK will need to be updated to use Azure Maps Web SDK by the retirement date that applies to your Bing Maps for Enterprise account type. For detailed migration guidance, see Migrate from Bing Maps Web Control SDK and Migrate Bing Maps Enterprise applications to Azure Maps with GitHub Copilot.
Azure Maps is Microsoft's next-generation maps and geospatial services for developers. Azure Maps has many of the same features as Bing Maps for Enterprise, and more. To get started with Azure Maps, create a free Azure subscription and an Azure Maps account. For more information about azure Maps, see Azure Maps Documentation. For migration guidance, see Bing Maps Migration Overview.
Occasionally you may run into a situation where you need to perform additional calculations against the tile information to generate the required tile URL. This can be done by passing a callback function to the uriConstructor property. When this callback function is triggered, it receives a PyramidTileId object that contains additional information about the tile that is being requested. You can then use this information to create the required tile URL and return it from the callback function.
Constructor
PyramidTileId(x: number, y: number, zoom: number, width?: number, height?: number)
Properties
The following is a list of the properties in the PyramidTileId class.
| Name | Type | Description |
|---|---|---|
pixelHeight |
number | The height of the tile. |
pixelWidth |
number | The width of the tile. |
quadKey |
string | The quadkey ID of the tile. |
x |
number | The x tile coordinate. |
y |
number | The y tile coordinate. |
zoom |
number | The zoom level of the tile. |
Static Methods
| Name | Type | Description |
|---|---|---|
areEqual(tileId1: PyramidTileId, tileId2: PyramidTileId) |
boolean | Compares two PyramidTileId objects and returns a boolean indicating if the two PyramidTileId are equal. |
fromQuadKey(quadkey: string, width?: number, height?: number) |
PyramidTileId | Generates a PyramidTileId from a quadkey tile id string. |