مشاركة عبر

@azure-rest/maps-render package

الواجهات

CircularPath

حدد مسارا دائريا.
CircularPathOptions

الخيارات التي تعدل نمط مسار دائري.
CopyrightCaptionOutput

يتم إرجاع هذا الكائن من استدعاء ناجح لحقوق النشر
CopyrightOutput

يتم إرجاع هذا الكائن من طلب حقوق نشر ناجح
ErrorAdditionalInfoOutput

خطأ إدارة الموارد معلومات إضافية.
ErrorDetailOutput

تفاصيل الخطأ.
ErrorResponseOutput

استجابة الخطأ الشائعة لجميع واجهات برمجة تطبيقات Azure Resource Manager لإرجاع تفاصيل الخطأ للعمليات الفاشلة. (يتبع هذا أيضا تنسيق استجابة خطأ OData.).
GetCopyrightCaption
GetCopyrightForTile
GetCopyrightForWorld
GetCopyrightFromBoundingBox
GetMapAttribution
GetMapStateTile
GetMapStaticImage
GetMapTile
GetMapTileset
MapAttributionOutput

إسناد حقوق النشر للقسم المطلوب من مجموعة الإطارات المتجانبة.
MapTilesetOutput

بيانات التعريف لمجموعة تجانب بتنسيق TileJSON.
MapsRenderClientOptions

المعلمات الاختيارية للعميل
Pin

حدد كيفية وضع الدبوس ونص التسمية.
PinOptions

خيارات الدبوس لنمط الصورة الافتراضي/بلا.
PinSet
PolygonalPath

حدد مسارا مضلعا.
PolygonalPathOptions

الخيارات التي تعدل نمط مسار مضلع.
RegionCopyrightsCountryOutput

خاصية البلد
RegionCopyrightsOutput
RenderGetCopyrightCaption200Response

واجهة برمجة تطبيقات Get Copyright Caption هي طلب HTTP GET مصمم لخدمة معلومات حقوق النشر لاستخدامها مع الإطارات المتجانبة المطلوبة من خدمة Render. بالإضافة إلى حقوق النشر الأساسية للخريطة بأكملها، يمكن أن تخدم مجموعات محددة من حقوق النشر لبعض البلدان/المناطق.

كبديل لحقوق النشر لطلب الخريطة، يمكنه أيضا إرجاع تسميات توضيحية لعرض معلومات الموفر على الخريطة.
RenderGetCopyrightCaptionDefaultResponse

واجهة برمجة تطبيقات Get Copyright Caption هي طلب HTTP GET مصمم لخدمة معلومات حقوق النشر لاستخدامها مع الإطارات المتجانبة المطلوبة من خدمة Render. بالإضافة إلى حقوق النشر الأساسية للخريطة بأكملها، يمكن أن تخدم مجموعات محددة من حقوق النشر لبعض البلدان/المناطق.

كبديل لحقوق النشر لطلب الخريطة، يمكنه أيضا إرجاع تسميات توضيحية لعرض معلومات الموفر على الخريطة.
RenderGetCopyrightForTile200Response

للحصول على معلومات حقوق النشر للوحة معينة، يجب أن يحدد الطلب مستوى التكبير/التصغير وإحداثيات x وy الخاصة باللوحة. لمزيد من المعلومات، راجع مستويات التكبير/التصغير وشبكة التجانب.

تم تصميم واجهة برمجة تطبيقات حقوق النشر لخدمة معلومات حقوق النشر لخدمة Render. بالإضافة إلى حقوق النشر الأساسية للخريطة بأكملها، تخدم واجهة برمجة التطبيقات مجموعات محددة من حقوق النشر لبعض البلدان/المناطق.
RenderGetCopyrightForTileDefaultResponse

للحصول على معلومات حقوق النشر للوحة معينة، يجب أن يحدد الطلب مستوى التكبير/التصغير وإحداثيات x وy الخاصة باللوحة. لمزيد من المعلومات، راجع مستويات التكبير/التصغير وشبكة التجانب.

تم تصميم واجهة برمجة تطبيقات حقوق النشر لخدمة معلومات حقوق النشر لخدمة Render. بالإضافة إلى حقوق النشر الأساسية للخريطة بأكملها، تخدم واجهة برمجة التطبيقات مجموعات محددة من حقوق النشر لبعض البلدان/المناطق.
RenderGetCopyrightForTileQueryParam
RenderGetCopyrightForTileQueryParamProperties
RenderGetCopyrightForWorld200Response

إرجاع معلومات حقوق النشر للعالم. للحصول على معلومات حقوق النشر الافتراضية للعالم بأسره، لا تحدد مربعا أو مربع إحاطة.

تم تصميم واجهة برمجة تطبيقات حقوق النشر لخدمة معلومات حقوق النشر لخدمة Render. بالإضافة إلى حقوق النشر الأساسية للخريطة بأكملها، تخدم واجهة برمجة التطبيقات مجموعات محددة من حقوق النشر لبعض البلدان/المناطق.
RenderGetCopyrightForWorldDefaultResponse

إرجاع معلومات حقوق النشر للعالم. للحصول على معلومات حقوق النشر الافتراضية للعالم بأسره، لا تحدد مربعا أو مربع إحاطة.

تم تصميم واجهة برمجة تطبيقات حقوق النشر لخدمة معلومات حقوق النشر لخدمة Render. بالإضافة إلى حقوق النشر الأساسية للخريطة بأكملها، تخدم واجهة برمجة التطبيقات مجموعات محددة من حقوق النشر لبعض البلدان/المناطق.
RenderGetCopyrightForWorldQueryParam
RenderGetCopyrightForWorldQueryParamProperties
RenderGetCopyrightFromBoundingBox200Response

إرجاع معلومات حقوق النشر لمربع إحاطة معين. يجب أن تحدد طلبات المربع المحيط إحداثيات خط الطول والعرض (EPSG-3857) الحد الأدنى والحد الأقصى
RenderGetCopyrightFromBoundingBoxDefaultResponse

إرجاع معلومات حقوق النشر لمربع إحاطة معين. يجب أن تحدد طلبات المربع المحيط إحداثيات خط الطول والعرض (EPSG-3857) الحد الأدنى والحد الأقصى
RenderGetCopyrightFromBoundingBoxQueryParam
RenderGetCopyrightFromBoundingBoxQueryParamProperties
RenderGetMapAttribution200Response

تسمح واجهة برمجة تطبيقات Get Map Attribution للمستخدمين بطلب تعيين معلومات إسناد حقوق النشر لقسم من مجموعة الإطارات المتجانبة.
RenderGetMapAttributionDefaultResponse

تسمح واجهة برمجة تطبيقات Get Map Attribution للمستخدمين بطلب تعيين معلومات إسناد حقوق النشر لقسم من مجموعة الإطارات المتجانبة.
RenderGetMapAttributionQueryParam
RenderGetMapAttributionQueryParamProperties
RenderGetMapStateTile200Headers
RenderGetMapStateTile200Response

إحضار تجانبات الحالة بتنسيق متجه عادة ليتم دمجها في وحدة الخرائط الداخلية للتحكم في الخريطة أو SDK. سيقوم عنصر تحكم الخريطة باستدعاء واجهة برمجة التطبيقات هذه بعد تشغيل المستخدم على التصميم الديناميكي. لمزيد من المعلومات، راجع مستويات التكبير/التصغير وشبكة التجانب.
RenderGetMapStateTileDefaultResponse

إحضار تجانبات الحالة بتنسيق متجه عادة ليتم دمجها في وحدة الخرائط الداخلية للتحكم في الخريطة أو SDK. سيقوم عنصر تحكم الخريطة باستدعاء واجهة برمجة التطبيقات هذه بعد تشغيل المستخدم على التصميم الديناميكي. لمزيد من المعلومات، راجع مستويات التكبير/التصغير وشبكة التجانب.
RenderGetMapStateTileQueryParam
RenderGetMapStateTileQueryParamProperties
RenderGetMapStaticImage200Headers
RenderGetMapStaticImage200Response

تنتج واجهة برمجة تطبيقات العرض هذه طرق عرض خريطة ثابتة ومشعة لمنطقة معرفة من قبل المستخدم. إنها مناسبة لتطبيقات الويب الخفيفة، عندما لا تتطلب تجربة المستخدم المطلوبة عناصر تحكم خريطة تفاعلية، أو عندما يكون النطاق الترددي محدودا. تعد واجهة برمجة التطبيقات هذه مفيدة أيضا لتضمين الخرائط في التطبيقات خارج المستعرض أو في خدمات الواجهة الخلفية أو إنشاء التقارير أو تطبيقات سطح المكتب.

تتضمن واجهة برمجة التطبيقات هذه معلمات لتصور البيانات الأساسية:

  • دبابيس التثبيت المسماة في أنماط متعددة.
  • عرض أنواع هندسة الدائرة والمسار والمضلع.

لمزيد من المعلومات والأمثلة التفصيلية، راجع تقديم بيانات مخصصة على خريطة نقطية.

أبعاد معلمة bbox مقيدة، اعتمادا على مستوى التكبير/التصغير. وهذا يضمن أن الصورة الناتجة لديها مستوى مناسب من التفاصيل.

مستوى التكبير/التصغير الحد الأدنى لنطاق Lon الحد الأقصى لنطاق Lon الحد الأدنى لنطاق اللات الحد الأقصى لنطاق Lat
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

ملاحظة : يجب توفير معلمة center أو bbox إلى واجهة برمجة التطبيقات.
RenderGetMapStaticImageDefaultResponse

تنتج واجهة برمجة تطبيقات العرض هذه طرق عرض خريطة ثابتة ومشعة لمنطقة معرفة من قبل المستخدم. إنها مناسبة لتطبيقات الويب الخفيفة، عندما لا تتطلب تجربة المستخدم المطلوبة عناصر تحكم خريطة تفاعلية، أو عندما يكون النطاق الترددي محدودا. تعد واجهة برمجة التطبيقات هذه مفيدة أيضا لتضمين الخرائط في التطبيقات خارج المستعرض أو في خدمات الواجهة الخلفية أو إنشاء التقارير أو تطبيقات سطح المكتب.

تتضمن واجهة برمجة التطبيقات هذه معلمات لتصور البيانات الأساسية:

  • دبابيس التثبيت المسماة في أنماط متعددة.
  • عرض أنواع هندسة الدائرة والمسار والمضلع.

لمزيد من المعلومات والأمثلة التفصيلية، راجع تقديم بيانات مخصصة على خريطة نقطية.

أبعاد معلمة bbox مقيدة، اعتمادا على مستوى التكبير/التصغير. وهذا يضمن أن الصورة الناتجة لديها مستوى مناسب من التفاصيل.

مستوى التكبير/التصغير الحد الأدنى لنطاق Lon الحد الأقصى لنطاق Lon الحد الأدنى لنطاق اللات الحد الأقصى لنطاق Lat
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

ملاحظة : يجب توفير معلمة center أو bbox إلى واجهة برمجة التطبيقات.
RenderGetMapStaticImageQueryParam
RenderGetMapStaticImageQueryParamProperties
RenderGetMapTile200Headers
RenderGetMapTile200Response

واجهة برمجة تطبيقات Get Map Tiles في طلب HTTP GET الذي يسمح للمستخدمين بطلب تجانبات الخريطة بتنسيقات متجهة أو نقطية عادة ما يتم دمجها في عنصر تحكم الخريطة أو SDK. بعض الأمثلة على الإطارات المتجانبة التي يمكن طلبها هي تجانبات طرق خرائط Azure أو تجانبات Weather Radar في الوقت الحقيقي أو تجانبات الخريطة التي تم إنشاؤها باستخدام Azure Maps Creator. بشكل افتراضي، تستخدم خرائط Azure الإطارات المتجانبة المتجهة للتحكم في خريطة الويب الخاصة بها (Web SDK) Android SDK.
RenderGetMapTileDefaultResponse

واجهة برمجة تطبيقات Get Map Tiles في طلب HTTP GET الذي يسمح للمستخدمين بطلب تجانبات الخريطة بتنسيقات متجهة أو نقطية عادة ما يتم دمجها في عنصر تحكم الخريطة أو SDK. بعض الأمثلة على الإطارات المتجانبة التي يمكن طلبها هي تجانبات طرق خرائط Azure أو تجانبات Weather Radar في الوقت الحقيقي أو تجانبات الخريطة التي تم إنشاؤها باستخدام Azure Maps Creator. بشكل افتراضي، تستخدم خرائط Azure الإطارات المتجانبة المتجهة للتحكم في خريطة الويب الخاصة بها (Web SDK) Android SDK.
RenderGetMapTileQueryParam
RenderGetMapTileQueryParamProperties
RenderGetMapTileset200Response

تسمح واجهة برمجة تطبيقات Get Map Tileset للمستخدمين بطلب بيانات التعريف لمجموعة الإطارات المتجانبة.
RenderGetMapTilesetDefaultResponse

تسمح واجهة برمجة تطبيقات Get Map Tileset للمستخدمين بطلب بيانات التعريف لمجموعة الإطارات المتجانبة.
RenderGetMapTilesetQueryParam
RenderGetMapTilesetQueryParamProperties
Routes

النوع أسماء مستعارة

MapsRenderClient
RenderGetCopyrightCaptionParameters
RenderGetCopyrightForTileParameters
RenderGetCopyrightForWorldParameters
RenderGetCopyrightFromBoundingBoxParameters
RenderGetMapAttributionParameters
RenderGetMapStateTileParameters
RenderGetMapStaticImageParameters
RenderGetMapTileParameters
RenderGetMapTilesetParameters

الوظائف

createPathQuery((PolygonalPath | CircularPath)[])

إنشاء سلسلة استعلام مسار الحصول على طلب صورة ثابتة للخريطة.

المثال 

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[])

إنشاء سلسلة استعلام تثبيت الحصول على صورة ثابتة للخريطة

المثال 

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)

إنشاء مثيل MapsRenderClient من مفتاح اشتراك.

المثال 

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)

إنشاء مثيل MapsRender من Azure Identity TokenCredential.

المثال 

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)

إنشاء مثيل MapsRender من Azure Identity AzureSASCredential.

المثال 

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

حساب إحداثيات تجانب XY التي يقع فيها الإحداثيات لمستوى تكبير/تصغير معين. المرجع: https://learn.microsoft.com/en-us/azure/azure-maps/zoom-levels-and-tile-grid?tabs=typescript#tile-math-source-code

المثال 

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

تفاصيل الوظيفة

createPathQuery((PolygonalPath | CircularPath)[])

إنشاء سلسلة استعلام مسار الحصول على طلب صورة ثابتة للخريطة.

المثال 

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

المعلمات

paths

(PolygonalPath | CircularPath)[]

مجموعة من PolygonalPath تريد رسمها على الصورة.

المرتجعات

string

createPinsQuery(PinSet[])

إنشاء سلسلة استعلام تثبيت الحصول على صورة ثابتة للخريطة

المثال 

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

المعلمات

pinSets

PinSet[]

المرتجعات

string

  • سلسلة الاستعلام المركبة.

default(AzureKeyCredential, ClientOptions)

إنشاء مثيل MapsRenderClient من مفتاح اشتراك.

المثال 

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

المعلمات

credential
AzureKeyCredential

مثيل AzureKeyCredential يستخدم لمصادقة الطلبات إلى الخدمة

options
ClientOptions

الخيارات المستخدمة لتكوين عميل العرض

المرتجعات

MapsRenderClient

default(TokenCredential, string, ClientOptions)

إنشاء مثيل MapsRender من Azure Identity TokenCredential.

المثال 

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

المعلمات

credential
TokenCredential

مثيل TokenCredential يستخدم لمصادقة الطلبات إلى الخدمة

mapsAccountClientId

string

معرف عميل خرائط Azure لمورد خريطة معين

options
ClientOptions

الخيارات المستخدمة لتكوين عميل العرض

المرتجعات

MapsRenderClient

default(AzureSASCredential, ClientOptions)

إنشاء مثيل MapsRender من Azure Identity AzureSASCredential.

المثال 

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

المعلمات

credential
AzureSASCredential

مثيل AzureSASCredential يستخدم لمصادقة الطلبات إلى الخدمة

options
ClientOptions

الخيارات المستخدمة لتكوين عميل العرض

المرتجعات

MapsRenderClient

isUnexpected(RenderGetMapTile200Response | RenderGetMapTileDefaultResponse) 

function isUnexpected(response: RenderGetMapTile200Response | RenderGetMapTileDefaultResponse): response

المعلمات

response

RenderGetMapTile200Response | RenderGetMapTileDefaultResponse

المرتجعات

response

isUnexpected(RenderGetMapTileset200Response | RenderGetMapTilesetDefaultResponse) 

function isUnexpected(response: RenderGetMapTileset200Response | RenderGetMapTilesetDefaultResponse): response

المعلمات

response

RenderGetMapTileset200Response | RenderGetMapTilesetDefaultResponse

المرتجعات

response

isUnexpected(RenderGetMapAttribution200Response | RenderGetMapAttributionDefaultResponse) 

function isUnexpected(response: RenderGetMapAttribution200Response | RenderGetMapAttributionDefaultResponse): response

المعلمات

response

RenderGetMapAttribution200Response | RenderGetMapAttributionDefaultResponse

المرتجعات

response

isUnexpected(RenderGetMapStateTile200Response | RenderGetMapStateTileDefaultResponse) 

function isUnexpected(response: RenderGetMapStateTile200Response | RenderGetMapStateTileDefaultResponse): response

المعلمات

response

RenderGetMapStateTile200Response | RenderGetMapStateTileDefaultResponse

المرتجعات

response

isUnexpected(RenderGetCopyrightCaption200Response | RenderGetCopyrightCaptionDefaultResponse) 

function isUnexpected(response: RenderGetCopyrightCaption200Response | RenderGetCopyrightCaptionDefaultResponse): response

المعلمات

response

RenderGetCopyrightCaption200Response | RenderGetCopyrightCaptionDefaultResponse

المرتجعات

response

isUnexpected(RenderGetMapStaticImage200Response | RenderGetMapStaticImageDefaultResponse) 

function isUnexpected(response: RenderGetMapStaticImage200Response | RenderGetMapStaticImageDefaultResponse): response

المعلمات

response

RenderGetMapStaticImage200Response | RenderGetMapStaticImageDefaultResponse

المرتجعات

response

isUnexpected(RenderGetCopyrightFromBoundingBox200Response | RenderGetCopyrightFromBoundingBoxDefaultResponse) 

function isUnexpected(response: RenderGetCopyrightFromBoundingBox200Response | RenderGetCopyrightFromBoundingBoxDefaultResponse): response

المعلمات

response

RenderGetCopyrightFromBoundingBox200Response | RenderGetCopyrightFromBoundingBoxDefaultResponse

المرتجعات

response

isUnexpected(RenderGetCopyrightForTile200Response | RenderGetCopyrightForTileDefaultResponse) 

function isUnexpected(response: RenderGetCopyrightForTile200Response | RenderGetCopyrightForTileDefaultResponse): response

المعلمات

response

RenderGetCopyrightForTile200Response | RenderGetCopyrightForTileDefaultResponse

المرتجعات

response

isUnexpected(RenderGetCopyrightForWorld200Response | RenderGetCopyrightForWorldDefaultResponse) 

function isUnexpected(response: RenderGetCopyrightForWorld200Response | RenderGetCopyrightForWorldDefaultResponse): response

المعلمات

response

RenderGetCopyrightForWorld200Response | RenderGetCopyrightForWorldDefaultResponse

المرتجعات

response

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

حساب إحداثيات تجانب XY التي يقع فيها الإحداثيات لمستوى تكبير/تصغير معين. المرجع: https://learn.microsoft.com/en-us/azure/azure-maps/zoom-levels-and-tile-grid?tabs=typescript#tile-math-source-code

المثال 

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 }

المعلمات

position
LatLon

إحداثيات الموضع بالتنسيق [خط العرض، خط الطول].

zoom

number

مستوى التكبير/التصغير.

tileSize

"256" | "512"

حجم الإطارات المتجانبة في هرم الإطارات المتجانبة.

المرتجعات

{ x: number, y: number }

إحداثيات Tile XY.