@azure-rest/maps-render/dist/commonjs/positionToTileXY.d.ts

A generated SDK for MapsRenderClient.

import type { LatLon } from "@azure/maps-common";
/**
 * Calculates the XY tile coordinates that a coordinate falls into for a specific zoom level.
 * Reference: https://learn.microsoft.com/en-us/azure/azure-maps/zoom-levels-and-tile-grid?tabs=typescript#tile-math-source-code
 *
 * @example
 * ```ts snippet:ReadmeSampleRequestMapTiles
 * import { DefaultAzureCredential } from "@azure/identity";
 * import MapsRender, { positionToTileXY } from "@azure-rest/maps-render";
 * import { createWriteStream } from "node:fs";
 *
 * const credential = new DefaultAzureCredential();
 * const client = MapsRender(credential, "<maps-account-client-id>");
 *
 * const zoom = 6;
 * // Use the helper function `positionToTileXY` to get the tile index from the coordinate.
 * const { x, y } = positionToTileXY([47.61559, -122.33817], 6, "256");
 * const response = await client
 *   .path("/map/tile")
 *   .get({
 *     queryParameters: {
 *       tilesetId: "microsoft.base.road",
 *       zoom,
 *       x,
 *       y,
 *     },
 *   })
 *   .asNodeStream();
 *
 * // Handle the error.
 * if (!response.body) {
 *   throw Error("No response body");
 * }
 *
 * response.body.pipe(createWriteStream("tile.png"));
 * ```
 *
 * @param position - Position coordinate in the format [latitude, longitude].
 * @param zoom - Zoom level.
 * @param tileSize - The size of the tiles in the tile pyramid.
 * @returns Tile XY coordinates.
 */
export declare function positionToTileXY(position: LatLon, zoom: number, tileSize: "512" | "256"): {
    x: number;
    y: number;
};
//# sourceMappingURL=positionToTileXY.d.ts.map