RenderGetMapStaticImageQueryParamProperties interface

包:

@azure-rest/maps-render

属性

bbox	边界框由两个纬度和两个经度定义，表示地球上矩形区域的四侧。 格式：“minLon、minLat、maxLon、maxLat”（双精度）。 注意：bbox 或中心是必需参数。 它们是相互排斥的。 bbox 不应与高度或宽度一起使用。 Lat 和 Lon 允许的最大范围和最小范围是为本页顶部表格中的每个缩放级别定义的。
center	中心点的坐标（以双精度为单位）。 格式：“lon，lat”。 经度范围：-180 到 180。 纬度范围：-90 到 90。 注意：中心或 bbox 是必需参数。 它们是相互排斥的。
height	生成的图像的高度（以像素为单位）。 范围为 80 到 1500。 默认值为 512。 它不应与 bbox 一起使用。
language	应返回搜索结果的语言。 应该是受支持的 IETF 语言标记之一，不区分大小写。 当指定语言中的数据不适用于特定字段时，将使用默认语言。 有关详细信息，请参阅 支持的语言。
path	路径样式和位置（以双精度为单位）。 使用此参数可以选择向图像添加线条、多边形或圆圈。 路径样式描述线条和填充的外观。 （请务必正确编码此参数的 URL 编码值，因为它将包含保留字符，如管道和标点符号。 从 S1 开始，Azure Maps 帐户 SKU 支持路径参数。 路径参数的多个实例允许使用其样式指定多个几何图形。 每个请求的参数数限制为 10，每个路径的位置数限制为 100。 若要使用默认样式呈现半径为 100 米且中心点为纬度 45°N 和经度 122°W 的圆圈，请添加 querystring 参数 path=ra100||-122 45 请注意，经度在纬度之前。 URL 编码后，如下所示 path=ra100%7C%7C-122+45 为了清楚起见，此处的所有示例都显示了没有 URL 编码的路径参数。 若要呈现一行，请使用管道字符分隔每个位置。 例如，使用 path=||-122 45|-119.5 43.2|-121.67 47.12 使用封闭路径指定多边形，其中第一个和最后一个点相等。 例如，使用 path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45 线条和多边形位置的经度值可以介于从 -360 到 360 之间，以允许呈现跨越反经线的几何图形。 样式修饰符 可以通过添加样式修饰符来修改路径的外观。 这些是在位置之前添加的。 样式修饰符各有两个字母名称。 这些缩写名称用于帮助减少 URL 的长度。 若要更改轮廓的颜色，请使用“lc”样式修饰符，并使用 HTML/CSS RGB 颜色格式指定颜色，该格式是六位数十六进制数字（不支持三位数形式）。 例如，若要使用深粉色（将在 CSS 中指定为 #FF1493），请使用 path=lcFF1493||-122 45|-119.5 43.2 可以组合多个样式修饰符来创建更复杂的视觉样式。 lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6 样式修饰符摘要 修饰语 描述 类型​​ 范围 立法会 线条颜色 string 000000 到 FFFFFF fc 填充颜色 string 000000 到 FFFFFF 洛杉矶 行 alpha （不透明度） float 0 到 1 发 填充 alpha （不透明度） float 0 到 1 lw 线条宽度 int32 (0, 50] ra 圆半径（米） float 大于 0
pins	图钉样式和实例。 使用此参数可以选择性地向图像添加图钉。 图钉样式描述图钉的外观，实例为每个图钉指定图钉（以双精度为单位）和可选标签的坐标。 （请务必正确编码此参数的 URL 编码值，因为它将包含保留字符，如管道和标点符号。 Azure Maps 帐户 S0 SKU 仅支持固定参数的单个实例，并且每个引脚的位置数限制为 5 个。 其他 SKU 最多允许 25 个引脚参数实例指定多个引脚样式，并且每个引脚的位置数限制为 50 个。 若要使用默认的内置图钉样式在纬度 45°N 和经度 122°W 处呈现图钉，请添加 querystring 参数 pins=default||-122 45 请注意，经度在纬度之前。 URL 编码后，如下所示 pins=default%7C%7C-122+45 为了清楚起见，此处的所有示例都显示了没有 URL 编码的引脚参数。 若要在多个位置呈现图钉，请使用管道字符分隔每个位置。 例如，使用 pins=default||-122 45|-119.5 43.2|-121.67 47.12 S0 Azure Maps 帐户 SKU 仅允许五个图钉。 其他帐户 SKU 没有此限制。 样式修饰符 可以通过添加样式修饰符来修改图钉的外观。 这些内容将添加到样式之后，但在位置和标签之前。 样式修饰符各有两个字母名称。 这些缩写名称用于帮助减少 URL 的长度。 若要更改图钉的颜色，请使用“co”样式修饰符，并使用 HTML/CSS RGB 颜色格式指定颜色，该格式是六位数十六进制数字（不支持三位数形式）。 例如，若要使用深粉色（将在 CSS 中指定为 #FF1493），请使用 pins=default|coFF1493||-122 45 图钉标签 若要将标签添加到图钉，请将标签放在坐标前的单引号中。 避免在标签中使用特殊字符，例如 | 或 ||。 例如，若要使用值“1”、“2”和“3”标记三个引脚，请使用 pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12 有一个名为“none”的内置图钉样式，不显示图钉图像。 如果要显示不带任何固定图像的标签，可以使用此功能。 例如 pins=none||'A'-122 45|'B'-119.5 43.2 若要更改图钉标签的颜色，请使用“lc”标签颜色样式修饰符。 例如，若要将粉红色图钉与黑色标签一起使用，请使用 pins=default|coFF1493|lc000000||-122 45 若要更改标签的大小，请使用“ls”标签大小样式修饰符。 标签大小表示标签文本的近似高度（以像素为单位）。 例如，若要将标签大小增加到 12，请使用 pins=default|ls12||'A'-122 45|'B'-119 43 标签居中位于图钉“标签定位点”。 定位点位置是内置图钉的预定义位置，位于自定义图钉的顶部中心（请参阅下文）。 若要重写标签定位点，请使用“la”样式修饰符并为定位点提供 X 和 Y 像素坐标。 这些坐标相对于图钉图像的左上角。 正 X 值将定位点移到右侧，正 Y 值将定位点向下移动。 例如，若要将标签定位点向右定位 10 像素，将 4 像素置于图钉图像左上角上方，请使用 pins=default|la10 -4||'A'-122 45|'B'-119 43 自定义图钉 若要使用自定义图钉图像，请使用“custom”一词作为固定样式名称，然后在位置和标签信息后面指定 URL。 自定义标签图像允许的最大大小为 65,536 像素。 使用两个管道字符指示你已完成指定位置并正在启动 URL。 例如 pins=custom||-122 45||http://contoso.com/pushpins/red.png URL 编码后，如下所示 pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png 默认情况下，自定义图钉图像以固定坐标居中绘制。 这通常并不理想，因为它掩盖了要突出显示的位置。 若要替代固定图像的定位点位置，请使用“an”样式修饰符。 这使用与“la”标签定位点样式修饰符相同的格式。 例如，如果自定义图钉图像具有图像左上角的图钉尖，则可以使用 将定位点设置为该位置 pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png 注意：如果将“co”颜色修饰符与自定义图钉图像一起使用，则指定的颜色将替换图像中像素的 RGB 通道，但会使 alpha（不透明度）通道保持不变。 这通常只能通过纯色自定义图像来完成。 缩放、旋转和不透明度 可以使用“sc”刻度样式修饰符使图钉及其标签更大或更小。 这是大于零的值。 值为 1 是标准刻度。 大于 1 的值会使引脚变大，小于 1 的值会使它们更小。 例如，若要绘制图钉 50% 大于正常，请使用 pins=default|sc1.5||-122 45 可以使用“ro”旋转样式修饰符旋转图钉及其标签。 这是一些顺时针旋转度。 使用负数逆时针旋转。 例如，若要顺时针旋转 90 度图钉并加倍其大小，请使用 pins=default|ro90|sc2||-122 45 可以通过指定“al”alpha 样式修饰符使图钉及其标签部分透明。 这是一个介于 0 和 1 之间的数字，指示图钉的不透明度。 零会使它们完全透明（且不可见），1 使它们完全不透明（这是默认值）。 例如，若要使图钉及其标签只有 67% 不透明，请使用 pins=default|al.67||-122 45 样式修饰符摘要 修饰语 描述 类型​​ 范围 铝 Alpha （不透明度） float 0 到 1 一 固定定位点 <int32、int32> * co 固定颜色 string 000000 到 FFFFFF 洛杉矶 标签定位点 <int32、int32> * 立法会 标签颜色 string 000000 到 FFFFFF ls 标签大小 float 大于 0 ro 旋转 float -360 到 360 sc 规模 float 大于 0 X 和 Y 坐标可以是固定图像中的任意位置，也可以是其周围的边距。 边距大小是引脚宽度和高度的最小值。
tilesetId	要返回的地图样式。 可能的值为 microsoft.base.road、microsoft.base.darkgrey 和 microsoft.imagery。 默认值设置为 microsoft.base.road。 有关详细信息，请参阅 Render TilesetId。
trafficLayer	可选值，指示图像结果上没有覆盖任何流量流。 可能的值为 microsoft.traffic.relative.main 和 none。 默认值为 none，表示未返回任何流量流。 如果提供了与流量相关的 tilesetId，则返回具有相应流量层的映射图像。 有关详细信息，请参阅 Render TilesetId。
view	View 参数（也称为“用户区域”参数）允许为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区具有此类区域的不同视图，并且 View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下，即使尚未在请求中定义该参数，View 参数也会设置为“Unified”。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数必须符合适用法律，包括地图、图像和其他数据以及你有权通过 Azure Maps 访问的国家/地区的地图、图像和其他数据和第三方内容。 示例：view=IN。 有关详细信息，请参阅 支持的视图，并查看可用的视图。
width	生成的图像的宽度（以像素为单位）。 范围为 80 到 2000。 默认值为 512。 它不应与 bbox 一起使用。
zoom	地图的所需缩放级别。 支持 tilesetId 为 microsoft.base.road 或 microsoft.base.darkgrey 的缩放值范围为 0-20（含）。 支持将 tilesetId 作为 microsoft.imagery 的缩放值范围为 0-19（含）。 默认值为 12。 有关详细信息，请参阅 缩放级别和磁贴网格。

属性详细信息

bbox

边界框由两个纬度和两个经度定义，表示地球上矩形区域的四侧。 格式：“minLon、minLat、maxLon、maxLat”（双精度）。

注意：bbox 或中心是必需参数。 它们是相互排斥的。 bbox 不应与高度或宽度一起使用。

Lat 和 Lon 允许的最大范围和最小范围是为本页顶部表格中的每个缩放级别定义的。

bbox?: number[]

属性值

number[]

center

中心点的坐标（以双精度为单位）。 格式：“lon，lat”。 经度范围：-180 到 180。 纬度范围：-90 到 90。

注意：中心或 bbox 是必需参数。 它们是相互排斥的。

center?: number[]

属性值

number[]

height

生成的图像的高度（以像素为单位）。 范围为 80 到 1500。 默认值为 512。 它不应与 bbox 一起使用。

height?: number

属性值

number

language

应返回搜索结果的语言。 应该是受支持的 IETF 语言标记之一，不区分大小写。 当指定语言中的数据不适用于特定字段时，将使用默认语言。

有关详细信息，请参阅 支持的语言。

language?: string

属性值

string

path

路径样式和位置（以双精度为单位）。 使用此参数可以选择向图像添加线条、多边形或圆圈。 路径样式描述线条和填充的外观。 （请务必正确编码此参数的 URL 编码值，因为它将包含保留字符，如管道和标点符号。

从 S1 开始，Azure Maps 帐户 SKU 支持路径参数。 路径参数的多个实例允许使用其样式指定多个几何图形。 每个请求的参数数限制为 10，每个路径的位置数限制为 100。

若要使用默认样式呈现半径为 100 米且中心点为纬度 45°N 和经度 122°W 的圆圈，请添加 querystring 参数

path=ra100||-122 45

请注意，经度在纬度之前。 URL 编码后，如下所示

path=ra100%7C%7C-122+45

为了清楚起见，此处的所有示例都显示了没有 URL 编码的路径参数。

若要呈现一行，请使用管道字符分隔每个位置。 例如，使用

path=||-122 45|-119.5 43.2|-121.67 47.12

使用封闭路径指定多边形，其中第一个和最后一个点相等。 例如，使用

path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45

线条和多边形位置的经度值可以介于从 -360 到 360 之间，以允许呈现跨越反经线的几何图形。

样式修饰符

可以通过添加样式修饰符来修改路径的外观。 这些是在位置之前添加的。 样式修饰符各有两个字母名称。 这些缩写名称用于帮助减少 URL 的长度。

若要更改轮廓的颜色，请使用“lc”样式修饰符，并使用 HTML/CSS RGB 颜色格式指定颜色，该格式是六位数十六进制数字（不支持三位数形式）。 例如，若要使用深粉色（将在 CSS 中指定为 #FF1493），请使用

path=lcFF1493||-122 45|-119.5 43.2

可以组合多个样式修饰符来创建更复杂的视觉样式。

lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6

样式修饰符摘要

修饰语	描述	类型​​	范围
立法会	线条颜色	string	000000 到 FFFFFF
fc	填充颜色	string	000000 到 FFFFFF
洛杉矶	行 alpha （不透明度）	float	0 到 1
发	填充 alpha （不透明度）	float	0 到 1
lw	线条宽度	int32	(0, 50]
ra	圆半径（米）	float	大于 0

path?: string

属性值

string

pins

图钉样式和实例。 使用此参数可以选择性地向图像添加图钉。 图钉样式描述图钉的外观，实例为每个图钉指定图钉（以双精度为单位）和可选标签的坐标。 （请务必正确编码此参数的 URL 编码值，因为它将包含保留字符，如管道和标点符号。

Azure Maps 帐户 S0 SKU 仅支持固定参数的单个实例，并且每个引脚的位置数限制为 5 个。 其他 SKU 最多允许 25 个引脚参数实例指定多个引脚样式，并且每个引脚的位置数限制为 50 个。

若要使用默认的内置图钉样式在纬度 45°N 和经度 122°W 处呈现图钉，请添加 querystring 参数

pins=default||-122 45

请注意，经度在纬度之前。 URL 编码后，如下所示

pins=default%7C%7C-122+45

为了清楚起见，此处的所有示例都显示了没有 URL 编码的引脚参数。

若要在多个位置呈现图钉，请使用管道字符分隔每个位置。 例如，使用

pins=default||-122 45|-119.5 43.2|-121.67 47.12

S0 Azure Maps 帐户 SKU 仅允许五个图钉。 其他帐户 SKU 没有此限制。

样式修饰符

可以通过添加样式修饰符来修改图钉的外观。 这些内容将添加到样式之后，但在位置和标签之前。 样式修饰符各有两个字母名称。 这些缩写名称用于帮助减少 URL 的长度。

若要更改图钉的颜色，请使用“co”样式修饰符，并使用 HTML/CSS RGB 颜色格式指定颜色，该格式是六位数十六进制数字（不支持三位数形式）。 例如，若要使用深粉色（将在 CSS 中指定为 #FF1493），请使用

pins=default|coFF1493||-122 45

图钉标签

若要将标签添加到图钉，请将标签放在坐标前的单引号中。 避免在标签中使用特殊字符，例如 | 或 ||。 例如，若要使用值“1”、“2”和“3”标记三个引脚，请使用

pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12

有一个名为“none”的内置图钉样式，不显示图钉图像。 如果要显示不带任何固定图像的标签，可以使用此功能。 例如

pins=none||'A'-122 45|'B'-119.5 43.2

若要更改图钉标签的颜色，请使用“lc”标签颜色样式修饰符。 例如，若要将粉红色图钉与黑色标签一起使用，请使用

pins=default|coFF1493|lc000000||-122 45

若要更改标签的大小，请使用“ls”标签大小样式修饰符。 标签大小表示标签文本的近似高度（以像素为单位）。 例如，若要将标签大小增加到 12，请使用

pins=default|ls12||'A'-122 45|'B'-119 43

标签居中位于图钉“标签定位点”。 定位点位置是内置图钉的预定义位置，位于自定义图钉的顶部中心（请参阅下文）。 若要重写标签定位点，请使用“la”样式修饰符并为定位点提供 X 和 Y 像素坐标。 这些坐标相对于图钉图像的左上角。 正 X 值将定位点移到右侧，正 Y 值将定位点向下移动。 例如，若要将标签定位点向右定位 10 像素，将 4 像素置于图钉图像左上角上方，请使用

pins=default|la10 -4||'A'-122 45|'B'-119 43

自定义图钉

若要使用自定义图钉图像，请使用“custom”一词作为固定样式名称，然后在位置和标签信息后面指定 URL。 自定义标签图像允许的最大大小为 65,536 像素。 使用两个管道字符指示你已完成指定位置并正在启动 URL。 例如

pins=custom||-122 45||http://contoso.com/pushpins/red.png

URL 编码后，如下所示

pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png

默认情况下，自定义图钉图像以固定坐标居中绘制。 这通常并不理想，因为它掩盖了要突出显示的位置。 若要替代固定图像的定位点位置，请使用“an”样式修饰符。 这使用与“la”标签定位点样式修饰符相同的格式。 例如，如果自定义图钉图像具有图像左上角的图钉尖，则可以使用 将定位点设置为该位置

pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png

注意：如果将“co”颜色修饰符与自定义图钉图像一起使用，则指定的颜色将替换图像中像素的 RGB 通道，但会使 alpha（不透明度）通道保持不变。 这通常只能通过纯色自定义图像来完成。

缩放、旋转和不透明度

可以使用“sc”刻度样式修饰符使图钉及其标签更大或更小。 这是大于零的值。 值为 1 是标准刻度。 大于 1 的值会使引脚变大，小于 1 的值会使它们更小。 例如，若要绘制图钉 50% 大于正常，请使用

pins=default|sc1.5||-122 45

可以使用“ro”旋转样式修饰符旋转图钉及其标签。 这是一些顺时针旋转度。 使用负数逆时针旋转。 例如，若要顺时针旋转 90 度图钉并加倍其大小，请使用

pins=default|ro90|sc2||-122 45

可以通过指定“al”alpha 样式修饰符使图钉及其标签部分透明。 这是一个介于 0 和 1 之间的数字，指示图钉的不透明度。 零会使它们完全透明（且不可见），1 使它们完全不透明（这是默认值）。 例如，若要使图钉及其标签只有 67% 不透明，请使用

pins=default|al.67||-122 45

样式修饰符摘要

修饰语	描述	类型​​	范围
铝	Alpha （不透明度）	float	0 到 1
一	固定定位点	<int32、int32>	*
co	固定颜色	string	000000 到 FFFFFF
洛杉矶	标签定位点	<int32、int32>	*
立法会	标签颜色	string	000000 到 FFFFFF
ls	标签大小	float	大于 0
ro	旋转	float	-360 到 360
sc	规模	float	大于 0

• X 和 Y 坐标可以是固定图像中的任意位置，也可以是其周围的边距。 边距大小是引脚宽度和高度的最小值。

pins?: string

属性值

string

tilesetId

要返回的地图样式。 可能的值为 microsoft.base.road、microsoft.base.darkgrey 和 microsoft.imagery。 默认值设置为 microsoft.base.road。 有关详细信息，请参阅 Render TilesetId。

tilesetId?: "microsoft.base" | "microsoft.base.labels" | "microsoft.base.hybrid" | "microsoft.terra.main" | "microsoft.base.road" | "microsoft.base.darkgrey" | "microsoft.base.labels.road" | "microsoft.base.labels.darkgrey" | "microsoft.base.hybrid.road" | "microsoft.base.hybrid.darkgrey" | "microsoft.imagery" | "microsoft.weather.radar.main" | "microsoft.weather.infrared.main" | "microsoft.traffic.absolute" | "microsoft.traffic.absolute.main" | "microsoft.traffic.relative" | "microsoft.traffic.relative.main" | "microsoft.traffic.relative.dark" | "microsoft.traffic.delay" | "microsoft.traffic.delay.main" | "microsoft.traffic.reduced.main" | "microsoft.traffic.incident"

属性值

"microsoft.base" | "microsoft.base.labels" | "microsoft.base.hybrid" | "microsoft.terra.main" | "microsoft.base.road" | "microsoft.base.darkgrey" | "microsoft.base.labels.road" | "microsoft.base.labels.darkgrey" | "microsoft.base.hybrid.road" | "microsoft.base.hybrid.darkgrey" | "microsoft.imagery" | "microsoft.weather.radar.main" | "microsoft.weather.infrared.main" | "microsoft.traffic.absolute" | "microsoft.traffic.absolute.main" | "microsoft.traffic.relative" | "microsoft.traffic.relative.main" | "microsoft.traffic.relative.dark" | "microsoft.traffic.delay" | "microsoft.traffic.delay.main" | "microsoft.traffic.reduced.main" | "microsoft.traffic.incident"

trafficLayer

可选值，指示图像结果上没有覆盖任何流量流。 可能的值为 microsoft.traffic.relative.main 和 none。 默认值为 none，表示未返回任何流量流。 如果提供了与流量相关的 tilesetId，则返回具有相应流量层的映射图像。 有关详细信息，请参阅 Render TilesetId。

trafficLayer?: "microsoft.traffic.relative.main" | "none"

属性值

"microsoft.traffic.relative.main" | "none"

view

View 参数（也称为“用户区域”参数）允许为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区具有此类区域的不同视图，并且 View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下，即使尚未在请求中定义该参数，View 参数也会设置为“Unified”。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数必须符合适用法律，包括地图、图像和其他数据以及你有权通过 Azure Maps 访问的国家/地区的地图、图像和其他数据和第三方内容。 示例：view=IN。

有关详细信息，请参阅 支持的视图，并查看可用的视图。

view?: "AE" | "AR" | "BH" | "IN" | "IQ" | "JO" | "KW" | "LB" | "MA" | "OM" | "PK" | "PS" | "QA" | "SA" | "SY" | "YE" | "Auto" | "Unified"

属性值

"AE" | "AR" | "BH" | "IN" | "IQ" | "JO" | "KW" | "LB" | "MA" | "OM" | "PK" | "PS" | "QA" | "SA" | "SY" | "YE" | "Auto" | "Unified"

width

生成的图像的宽度（以像素为单位）。 范围为 80 到 2000。 默认值为 512。 它不应与 bbox 一起使用。

width?: number

属性值

number

zoom

地图的所需缩放级别。 支持 tilesetId 为 microsoft.base.road 或 microsoft.base.darkgrey 的缩放值范围为 0-20（含）。 支持将 tilesetId 作为 microsoft.imagery 的缩放值范围为 0-19（含）。 默认值为 12。

有关详细信息，请参阅 缩放级别和磁贴网格。

zoom?: number

属性值

number