@azure-rest/maps-render package

Gränssnitt

CircularPath

Ange en cirkulär sökväg.
CircularPathOptions

De alternativ som ändrar formatmallen för en cirkulär sökväg.
CopyrightCaptionOutput

Det här objektet returneras från ett lyckat upphovsrättsanrop
CopyrightOutput

Det här objektet returneras från en lyckad upphovsrättsbegäran
ErrorAdditionalInfoOutput

Ytterligare information om resurshanteringsfelet.
ErrorDetailOutput

Felinformationen.
ErrorResponseOutput

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
GetCopyrightCaption
GetCopyrightForTile
GetCopyrightForWorld
GetCopyrightFromBoundingBox
GetMapAttribution
GetMapStateTile
GetMapStaticImage
GetMapTile
GetMapTileset
MapAttributionOutput

Upphovsrättstilldelning för det begärda avsnittet i en paneluppsättning.
MapTilesetOutput

Metadata för en paneluppsättning i TileJSON-format.
MapsRenderClientOptions

Valfria parametrar för klienten
Pin

Ange hur pin-kodens position och etiketttext ska placeras.
PinOptions

Fästalternativen för standard-/ingen-bildformat..
PinSet
PolygonalPath

Ange en polygonal sökväg.
PolygonalPathOptions

De alternativ som ändrar formatmallen för en polygonal sökväg.
RegionCopyrightsCountryOutput

Landegenskap
RegionCopyrightsOutput
RenderGetCopyrightCaption200Response

Get Copyright Caption-API:et är en HTTP GET-begäran som utformats för att hantera upphovsrättsinformation som ska användas med paneler som begärs från renderningstjänsten. Förutom en grundläggande upphovsrätt för hela kartan kan den tjäna specifika grupper av upphovsrätter för vissa länder/regioner.

Som ett alternativ till upphovsrätt för kartbegäran kan den också returnera bildtexter för att visa providerinformation på kartan.
RenderGetCopyrightCaptionDefaultResponse

Get Copyright Caption-API:et är en HTTP GET-begäran som utformats för att hantera upphovsrättsinformation som ska användas med paneler som begärs från renderningstjänsten. Förutom en grundläggande upphovsrätt för hela kartan kan den tjäna specifika grupper av upphovsrätter för vissa länder/regioner.

Som ett alternativ till upphovsrätt för kartbegäran kan den också returnera bildtexter för att visa providerinformation på kartan.
RenderGetCopyrightForTile200Response

För att få upphovsrättsinformation för en viss panel bör begäran ange panelens zoomnivå och x- och y-koordinater. Mer information finns i Zoomnivåer och Panelrutnät.

API:et för upphovsrätt är utformat för att tillhandahålla upphovsrättsinformation för Render-tjänsten. Förutom grundläggande upphovsrätt för hela kartan betjänar API specifika grupper av upphovsrätter för vissa länder/regioner.
RenderGetCopyrightForTileDefaultResponse

För att få upphovsrättsinformation för en viss panel bör begäran ange panelens zoomnivå och x- och y-koordinater. Mer information finns i Zoomnivåer och Panelrutnät.

API:et för upphovsrätt är utformat för att tillhandahålla upphovsrättsinformation för Render-tjänsten. Förutom grundläggande upphovsrätt för hela kartan betjänar API specifika grupper av upphovsrätter för vissa länder/regioner.
RenderGetCopyrightForTileQueryParam
RenderGetCopyrightForTileQueryParamProperties
RenderGetCopyrightForWorld200Response

Returnerar upphovsrättsinformationen för världen. Om du vill hämta standardinformationen om upphovsrätt för hela världen ska du inte ange en panel eller avgränsningsruta.

API:et för upphovsrätt är utformat för att tillhandahålla upphovsrättsinformation för Render-tjänsten. Förutom grundläggande upphovsrätt för hela kartan betjänar API specifika grupper av upphovsrätter för vissa länder/regioner.
RenderGetCopyrightForWorldDefaultResponse

Returnerar upphovsrättsinformationen för världen. Om du vill hämta standardinformationen om upphovsrätt för hela världen ska du inte ange en panel eller avgränsningsruta.

API:et för upphovsrätt är utformat för att tillhandahålla upphovsrättsinformation för Render-tjänsten. Förutom grundläggande upphovsrätt för hela kartan betjänar API specifika grupper av upphovsrätter för vissa länder/regioner.
RenderGetCopyrightForWorldQueryParam
RenderGetCopyrightForWorldQueryParamProperties
RenderGetCopyrightFromBoundingBox200Response

Returnerar copyrightinformation för en viss avgränsningsruta. Begäranden om avgränsningsrutor ska ange koordinaterna för minsta och högsta longitud och latitud (EPSG-3857)
RenderGetCopyrightFromBoundingBoxDefaultResponse

Returnerar copyrightinformation för en viss avgränsningsruta. Begäranden om avgränsningsrutor ska ange koordinaterna för minsta och högsta longitud och latitud (EPSG-3857)
RenderGetCopyrightFromBoundingBoxQueryParam
RenderGetCopyrightFromBoundingBoxQueryParamProperties
RenderGetMapAttribution200Response

Med api:et Get Map Attribution kan användare begära mappningsinformation om upphovsrättstilldelning för ett avsnitt i en paneluppsättning.
RenderGetMapAttributionDefaultResponse

Med api:et Get Map Attribution kan användare begära mappningsinformation om upphovsrättstilldelning för ett avsnitt i en paneluppsättning.
RenderGetMapAttributionQueryParam
RenderGetMapAttributionQueryParamProperties
RenderGetMapStateTile200Headers
RenderGetMapStateTile200Response

Hämtar tillståndspaneler i vektorformat som vanligtvis ska integreras i modulen inomhuskartor för kartkontroll eller SDK. Kartkontrollen anropar det här API:et när användaren har aktiverat dynamisk formatering. Mer information finns i Zoomnivåer och Panelrutnät.
RenderGetMapStateTileDefaultResponse

Hämtar tillståndspaneler i vektorformat som vanligtvis ska integreras i modulen inomhuskartor för kartkontroll eller SDK. Kartkontrollen anropar det här API:et när användaren har aktiverat dynamisk formatering. Mer information finns i Zoomnivåer och Panelrutnät.
RenderGetMapStateTileQueryParam
RenderGetMapStateTileQueryParamProperties
RenderGetMapStaticImage200Headers
RenderGetMapStaticImage200Response

Det här renderings-API:et genererar statiska, rastrerade kartvyer för ett användardefinierat område. Den är lämplig för lätta webbprogram, när den önskade användarupplevelsen inte kräver interaktiva kartkontroller eller när bandbredden är begränsad. Det här API:et är också användbart för att bädda in kartor i program utanför webbläsaren, i serverdelstjänster, rapportgenerering eller skrivbordsprogram.

Det här API:et innehåller parametrar för grundläggande datavisualisering:

  • Märkta pushpins i flera format.
  • Rendera cirkel-, sökvägs- och polygongeometrityper.

Mer information och detaljerade exempel finns i Rendera anpassade data på en rasterkarta.

Måtten för bbox-parametern är begränsade, beroende på zoomningsnivån. Detta säkerställer att den resulterande bilden har en lämplig detaljnivå.

Zoomnivå Min Lon-intervall Max Lon-intervall Minsta svarstid Maximalt svarstidsintervall
0 56.25 360.0 30.1105585173 180.0
1 28.125 360.0 14.87468995 180.0
2 14.063 351.5625 7.4130741851 137.9576312246
3 7.03125 175.78125 3.7034501005 73.6354071932
4 3.515625 87.890625 1.8513375155 35.4776115315
5 1.7578125 43.9453125 0.925620264 17.4589959239
6 0.87890625 21.97265625 0.4628040687 8.6907788223
7 0.439453125 10.986328125 0.2314012764 4.3404320789
8 0.2197265625 5.4931640625 0.1157005434 2.1695927024
9 0.1098632812 2.7465820312 0.0578502599 1.0847183194
10 0.0549316406 1.3732910156 0.0289251285 0.5423494021
11 0.0274658203 0.6866455078 0.014462564 0.2711734813
12 0.0137329102 0.3433227539 0.007231282 0.1355865882
13 0.0068664551 0.171661377 0.003615641 0.067793275
14 0.0034332275 0.0858306885 0.0018078205 0.0338966351
15 0.0017166138 0.0429153442 0.0009039102 0.0169483173
16 0.0008583069 0.0214576721 0.0004519551 0.0084741586
17 0.0004291534 0.0107288361 0.0002259776 0.0042370793
18 0.0002145767 0.005364418 0.0001129888 0.0021185396
19 0.0001072884 0.002682209 5.64944E-05 0.0010592698
20 5.36442E-05 0.0013411045 2.82472E-05 0.0005296349

Obs: Parametern center eller bbox måste anges till API:et.
RenderGetMapStaticImageDefaultResponse

Det här renderings-API:et genererar statiska, rastrerade kartvyer för ett användardefinierat område. Den är lämplig för lätta webbprogram, när den önskade användarupplevelsen inte kräver interaktiva kartkontroller eller när bandbredden är begränsad. Det här API:et är också användbart för att bädda in kartor i program utanför webbläsaren, i serverdelstjänster, rapportgenerering eller skrivbordsprogram.

Det här API:et innehåller parametrar för grundläggande datavisualisering:

  • Märkta pushpins i flera format.
  • Rendera cirkel-, sökvägs- och polygongeometrityper.

Mer information och detaljerade exempel finns i Rendera anpassade data på en rasterkarta.

Måtten för bbox-parametern är begränsade, beroende på zoomningsnivån. Detta säkerställer att den resulterande bilden har en lämplig detaljnivå.

Zoomnivå Min Lon-intervall Max Lon-intervall Minsta svarstid Maximalt svarstidsintervall
0 56.25 360.0 30.1105585173 180.0
1 28.125 360.0 14.87468995 180.0
2 14.063 351.5625 7.4130741851 137.9576312246
3 7.03125 175.78125 3.7034501005 73.6354071932
4 3.515625 87.890625 1.8513375155 35.4776115315
5 1.7578125 43.9453125 0.925620264 17.4589959239
6 0.87890625 21.97265625 0.4628040687 8.6907788223
7 0.439453125 10.986328125 0.2314012764 4.3404320789
8 0.2197265625 5.4931640625 0.1157005434 2.1695927024
9 0.1098632812 2.7465820312 0.0578502599 1.0847183194
10 0.0549316406 1.3732910156 0.0289251285 0.5423494021
11 0.0274658203 0.6866455078 0.014462564 0.2711734813
12 0.0137329102 0.3433227539 0.007231282 0.1355865882
13 0.0068664551 0.171661377 0.003615641 0.067793275
14 0.0034332275 0.0858306885 0.0018078205 0.0338966351
15 0.0017166138 0.0429153442 0.0009039102 0.0169483173
16 0.0008583069 0.0214576721 0.0004519551 0.0084741586
17 0.0004291534 0.0107288361 0.0002259776 0.0042370793
18 0.0002145767 0.005364418 0.0001129888 0.0021185396
19 0.0001072884 0.002682209 5.64944E-05 0.0010592698
20 5.36442E-05 0.0013411045 2.82472E-05 0.0005296349

Obs: Parametern center eller bbox måste anges till API:et.
RenderGetMapStaticImageQueryParam
RenderGetMapStaticImageQueryParamProperties
RenderGetMapTile200Headers
RenderGetMapTile200Response

Get Map Tiles-API:et i en HTTP GET-begäran som gör det möjligt för användare att begära kartpaneler i vektor- eller rasterformat som vanligtvis integreras i en kartkontroll eller SDK. Några exempelpaneler som kan begäras är Azure Maps-vägpaneler, väderradarpaneler i realtid eller kartpaneler som skapats med hjälp av Azure Maps Creator. Som standard använder Azure Maps vektorpaneler för webbkartkontrollen (Web SDK) och Android SDK.
RenderGetMapTileDefaultResponse

Get Map Tiles-API:et i en HTTP GET-begäran som gör det möjligt för användare att begära kartpaneler i vektor- eller rasterformat som vanligtvis integreras i en kartkontroll eller SDK. Några exempelpaneler som kan begäras är Azure Maps-vägpaneler, väderradarpaneler i realtid eller kartpaneler som skapats med hjälp av Azure Maps Creator. Som standard använder Azure Maps vektorpaneler för webbkartkontrollen (Web SDK) och Android SDK.
RenderGetMapTileQueryParam
RenderGetMapTileQueryParamProperties
RenderGetMapTileset200Response

API:et Hämta kartpaneler gör det möjligt för användare att begära metadata för en paneluppsättning.
RenderGetMapTilesetDefaultResponse

API:et Hämta kartpaneler gör det möjligt för användare att begära metadata för en paneluppsättning.
RenderGetMapTilesetQueryParam
RenderGetMapTilesetQueryParamProperties
Routes

Typalias

MapsRenderClient
RenderGetCopyrightCaptionParameters
RenderGetCopyrightForTileParameters
RenderGetCopyrightForWorldParameters
RenderGetCopyrightFromBoundingBoxParameters
RenderGetMapAttributionParameters
RenderGetMapStateTileParameters
RenderGetMapStaticImageParameters
RenderGetMapTileParameters
RenderGetMapTilesetParameters

Funktioner

createPathQuery((PolygonalPath | CircularPath)[])

Skapa en sökvägsfrågesträng för hämta en statisk mappningsbild begäran.

Exempel

import { DefaultAzureCredential } from "@azure/identity";
import MapsRender, { CircularPath, PolygonalPath, createPathQuery } from "@azure-rest/maps-render";
import { createWriteStream } from "node:fs";

const credential = new DefaultAzureCredential();
const client = MapsRender(credential, "<maps-account-client-id>");

const circularPath: CircularPath = {
  center: [52.4559, 13.228],
  radiusInMeters: 10000,
  options: {
    lineColor: "000000",
    lineOpacity: 0.9,
    lineWidthInPixels: 2,
  },
};

const linearPath: PolygonalPath = {
  coordinates: [
    [52.577, 13.35],
    [52.6, 13.2988],
    [52.32, 13.2988],
  ],
  options: {
    lineColor: "000000",
    lineOpacity: 0.9,
    lineWidthInPixels: 2,
  },
};

const polygonPath: PolygonalPath = {
  coordinates: [
    [52.577, 13.35],
    [52.6, 13.2988],
    [52.32, 13.2988],
    [52.577, 13.35],
  ],
  options: {
    lineColor: "000000",
    lineOpacity: 0.9,
    lineWidthInPixels: 2,
    fillColor: "FFFFFF",
    fillOpacity: 0.8,
  },
};

const path = createPathQuery([circularPath, linearPath, polygonPath]);
// Send the request
const response = await client
  .path("/map/static")
  .get({
    queryParameters: {
      bbox: [13.228, 52.4559, 13.5794, 52.629],
      path,
    },
  })
  .asNodeStream();

// Handle the error.
if (!response.body) {
  throw Error("No response body");
}

response.body.pipe(createWriteStream("path.png"));
createPinsQuery(PinSet[])

Skapa en pin-frågesträng för hämta statisk kartbild

Exempel

import { DefaultAzureCredential } from "@azure/identity";
import MapsRender, { PinSet, createPinsQuery } from "@azure-rest/maps-render";
import { createWriteStream } from "node:fs";

const credential = new DefaultAzureCredential();
const client = MapsRender(credential, "<maps-account-client-id>");

const pins: PinSet[] = [
  {
    pins: [
      { coordinate: [52.577, 13.35], label: "Label start" },
      { coordinate: [52.6, 13.2988], label: "Label end" },
    ],
    pinImage: "default",
    options: {
      scale: 0.9,
      pinColor: "FF0000",
      labelColor: "0000FF",
      labelSizeInPixels: 18,
    },
  },
];

const path = createPinsQuery(pins);

const response = await client
  .path("/map/static")
  .get({
    queryParameters: {
      bbox: [13.228, 52.4559, 13.5794, 52.62],
      zoom: 10,
      path,
    },
    skipUrlEncoding: true,
  })
  .asNodeStream();

// Handle the error.
if (!response.body) {
  throw Error("No response body");
}

response.body.pipe(createWriteStream("pin.png"));
default(AzureKeyCredential, ClientOptions)

Skapar en instans av MapsRenderClient från en prenumerationsnyckel.

Exempel

import { AzureKeyCredential } from "@azure/core-auth";
import MapsRender from "@azure-rest/maps-render";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRender(credential);
default(TokenCredential, string, ClientOptions)

Skapar en instans av MapsRender från en Azure Identity-TokenCredential.

Exempel

import { DefaultAzureCredential } from "@azure/identity";
import MapsRender from "@azure-rest/maps-render";

const credential = new DefaultAzureCredential();
const client = MapsRender(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

Skapar en instans av MapsRender från en Azure Identity-AzureSASCredential.

Exempel

import { AzureSASCredential } from "@azure/core-auth";
import MapsRender from "@azure-rest/maps-render";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRender(credential);
isUnexpected(RenderGetMapTile200Response | RenderGetMapTileDefaultResponse)
isUnexpected(RenderGetMapTileset200Response | RenderGetMapTilesetDefaultResponse)
isUnexpected(RenderGetMapAttribution200Response | RenderGetMapAttributionDefaultResponse)
isUnexpected(RenderGetMapStateTile200Response | RenderGetMapStateTileDefaultResponse)
isUnexpected(RenderGetCopyrightCaption200Response | RenderGetCopyrightCaptionDefaultResponse)
isUnexpected(RenderGetMapStaticImage200Response | RenderGetMapStaticImageDefaultResponse)
isUnexpected(RenderGetCopyrightFromBoundingBox200Response | RenderGetCopyrightFromBoundingBoxDefaultResponse)
isUnexpected(RenderGetCopyrightForTile200Response | RenderGetCopyrightForTileDefaultResponse)
isUnexpected(RenderGetCopyrightForWorld200Response | RenderGetCopyrightForWorldDefaultResponse)
positionToTileXY(LatLon, number, "256" | "512")

Beräknar XY-panelens koordinater som en koordinat hamnar i för en specifik zoomnivå. Referens: https://learn.microsoft.com/en-us/azure/azure-maps/zoom-levels-and-tile-grid?tabs=typescript#tile-math-source-code

Exempel

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"));

Funktionsinformation

createPathQuery((PolygonalPath | CircularPath)[])

Skapa en sökvägsfrågesträng för hämta en statisk mappningsbild begäran.

Exempel

import { DefaultAzureCredential } from "@azure/identity";
import MapsRender, { CircularPath, PolygonalPath, createPathQuery } from "@azure-rest/maps-render";
import { createWriteStream } from "node:fs";

const credential = new DefaultAzureCredential();
const client = MapsRender(credential, "<maps-account-client-id>");

const circularPath: CircularPath = {
  center: [52.4559, 13.228],
  radiusInMeters: 10000,
  options: {
    lineColor: "000000",
    lineOpacity: 0.9,
    lineWidthInPixels: 2,
  },
};

const linearPath: PolygonalPath = {
  coordinates: [
    [52.577, 13.35],
    [52.6, 13.2988],
    [52.32, 13.2988],
  ],
  options: {
    lineColor: "000000",
    lineOpacity: 0.9,
    lineWidthInPixels: 2,
  },
};

const polygonPath: PolygonalPath = {
  coordinates: [
    [52.577, 13.35],
    [52.6, 13.2988],
    [52.32, 13.2988],
    [52.577, 13.35],
  ],
  options: {
    lineColor: "000000",
    lineOpacity: 0.9,
    lineWidthInPixels: 2,
    fillColor: "FFFFFF",
    fillOpacity: 0.8,
  },
};

const path = createPathQuery([circularPath, linearPath, polygonPath]);
// Send the request
const response = await client
  .path("/map/static")
  .get({
    queryParameters: {
      bbox: [13.228, 52.4559, 13.5794, 52.629],
      path,
    },
  })
  .asNodeStream();

// Handle the error.
if (!response.body) {
  throw Error("No response body");
}

response.body.pipe(createWriteStream("path.png"));

function createPathQuery(paths: (PolygonalPath | CircularPath)[]): string

Parametrar

paths

(PolygonalPath | CircularPath)[]

En samling PolygonalPath- och CircularPath- som du vill rita på bilden.

Returer

string

createPinsQuery(PinSet[])

Skapa en pin-frågesträng för hämta statisk kartbild

Exempel

import { DefaultAzureCredential } from "@azure/identity";
import MapsRender, { PinSet, createPinsQuery } from "@azure-rest/maps-render";
import { createWriteStream } from "node:fs";

const credential = new DefaultAzureCredential();
const client = MapsRender(credential, "<maps-account-client-id>");

const pins: PinSet[] = [
  {
    pins: [
      { coordinate: [52.577, 13.35], label: "Label start" },
      { coordinate: [52.6, 13.2988], label: "Label end" },
    ],
    pinImage: "default",
    options: {
      scale: 0.9,
      pinColor: "FF0000",
      labelColor: "0000FF",
      labelSizeInPixels: 18,
    },
  },
];

const path = createPinsQuery(pins);

const response = await client
  .path("/map/static")
  .get({
    queryParameters: {
      bbox: [13.228, 52.4559, 13.5794, 52.62],
      zoom: 10,
      path,
    },
    skipUrlEncoding: true,
  })
  .asNodeStream();

// Handle the error.
if (!response.body) {
  throw Error("No response body");
}

response.body.pipe(createWriteStream("pin.png"));

function createPinsQuery(pinSets: PinSet[]): string

Parametrar

pinSets

PinSet[]

Returer

string

  • Den sammansatta frågesträngen.

default(AzureKeyCredential, ClientOptions)

Skapar en instans av MapsRenderClient från en prenumerationsnyckel.

Exempel

import { AzureKeyCredential } from "@azure/core-auth";
import MapsRender from "@azure-rest/maps-render";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRender(credential);

function default(credential: AzureKeyCredential, options?: ClientOptions): MapsRenderClient

Parametrar

credential
AzureKeyCredential

En AzureKeyCredential-instans som används för att autentisera begäranden till tjänsten

options
ClientOptions

Alternativ som används för att konfigurera återgivningsklienten

Returer

MapsRenderClient

default(TokenCredential, string, ClientOptions)

Skapar en instans av MapsRender från en Azure Identity-TokenCredential.

Exempel

import { DefaultAzureCredential } from "@azure/identity";
import MapsRender from "@azure-rest/maps-render";

const credential = new DefaultAzureCredential();
const client = MapsRender(credential, "<maps-account-client-id>");

function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRenderClient

Parametrar

credential
TokenCredential

En TokenCredential-instans som används för att autentisera begäranden till tjänsten

mapsAccountClientId

string

Azure Maps-klient-ID för en specifik kartresurs

options
ClientOptions

Alternativ som används för att konfigurera återgivningsklienten

Returer

MapsRenderClient

default(AzureSASCredential, ClientOptions)

Skapar en instans av MapsRender från en Azure Identity-AzureSASCredential.

Exempel

import { AzureSASCredential } from "@azure/core-auth";
import MapsRender from "@azure-rest/maps-render";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRender(credential);

function default(credential: AzureSASCredential, options?: ClientOptions): MapsRenderClient

Parametrar

credential
AzureSASCredential

En AzureSASCredential-instans som används för att autentisera begäranden till tjänsten

options
ClientOptions

Alternativ som används för att konfigurera återgivningsklienten

Returer

MapsRenderClient

isUnexpected(RenderGetMapTile200Response | RenderGetMapTileDefaultResponse) 

function isUnexpected(response: RenderGetMapTile200Response | RenderGetMapTileDefaultResponse): response

Parametrar

response

RenderGetMapTile200Response | RenderGetMapTileDefaultResponse

Returer

response

isUnexpected(RenderGetMapTileset200Response | RenderGetMapTilesetDefaultResponse) 

function isUnexpected(response: RenderGetMapTileset200Response | RenderGetMapTilesetDefaultResponse): response

Parametrar

response

RenderGetMapTileset200Response | RenderGetMapTilesetDefaultResponse

Returer

response

isUnexpected(RenderGetMapAttribution200Response | RenderGetMapAttributionDefaultResponse) 

function isUnexpected(response: RenderGetMapAttribution200Response | RenderGetMapAttributionDefaultResponse): response

Parametrar

response

RenderGetMapAttribution200Response | RenderGetMapAttributionDefaultResponse

Returer

response

isUnexpected(RenderGetMapStateTile200Response | RenderGetMapStateTileDefaultResponse) 

function isUnexpected(response: RenderGetMapStateTile200Response | RenderGetMapStateTileDefaultResponse): response

Parametrar

response

RenderGetMapStateTile200Response | RenderGetMapStateTileDefaultResponse

Returer

response

isUnexpected(RenderGetCopyrightCaption200Response | RenderGetCopyrightCaptionDefaultResponse) 

function isUnexpected(response: RenderGetCopyrightCaption200Response | RenderGetCopyrightCaptionDefaultResponse): response

Parametrar

response

RenderGetCopyrightCaption200Response | RenderGetCopyrightCaptionDefaultResponse

Returer

response

isUnexpected(RenderGetMapStaticImage200Response | RenderGetMapStaticImageDefaultResponse) 

function isUnexpected(response: RenderGetMapStaticImage200Response | RenderGetMapStaticImageDefaultResponse): response

Parametrar

response

RenderGetMapStaticImage200Response | RenderGetMapStaticImageDefaultResponse

Returer

response

isUnexpected(RenderGetCopyrightFromBoundingBox200Response | RenderGetCopyrightFromBoundingBoxDefaultResponse) 

function isUnexpected(response: RenderGetCopyrightFromBoundingBox200Response | RenderGetCopyrightFromBoundingBoxDefaultResponse): response

Parametrar

response

RenderGetCopyrightFromBoundingBox200Response | RenderGetCopyrightFromBoundingBoxDefaultResponse

Returer

response

isUnexpected(RenderGetCopyrightForTile200Response | RenderGetCopyrightForTileDefaultResponse) 

function isUnexpected(response: RenderGetCopyrightForTile200Response | RenderGetCopyrightForTileDefaultResponse): response

Parametrar

response

RenderGetCopyrightForTile200Response | RenderGetCopyrightForTileDefaultResponse

Returer

response

isUnexpected(RenderGetCopyrightForWorld200Response | RenderGetCopyrightForWorldDefaultResponse) 

function isUnexpected(response: RenderGetCopyrightForWorld200Response | RenderGetCopyrightForWorldDefaultResponse): response

Parametrar

response

RenderGetCopyrightForWorld200Response | RenderGetCopyrightForWorldDefaultResponse

Returer

response

positionToTileXY(LatLon, number, "256" | "512")

Beräknar XY-panelens koordinater som en koordinat hamnar i för en specifik zoomnivå. Referens: https://learn.microsoft.com/en-us/azure/azure-maps/zoom-levels-and-tile-grid?tabs=typescript#tile-math-source-code

Exempel

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"));

function positionToTileXY(position: LatLon, zoom: number, tileSize: "256" | "512"): { x: number, y: number }

Parametrar

position
LatLon

Placera koordinaten i formatet [latitud, longitud].

zoom

number

Zoomnivå.

tileSize

"256" | "512"

Storleken på panelerna i panelpyramid.

Returer

{ x: number, y: number }

XY-koordinater för panel.