你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

IconOptions interface

包:

azure-maps-control

用于自定义 SymbolLayer 中的图标的选项

Extends

Options

属性

allowOverlap	指定符号图标是否可以覆盖地图上的其他符号。 如果该 true 图标与以前绘制的其他符号相撞，该图标也会可见。 提示：如果对符号进行动画处理以确保平滑呈现，请将此值设置为 true。 默认为 false。
anchor	指定图标的哪个部分放置在最靠近地图上的图标定位点位置的位置。 “”center“：图标的中心放置在最靠近定位点的位置。 “left”：图标左侧放置在最靠近定位点的位置。 “right”：图标的右侧放置在最靠近定位点的位置。 “top”：图标的顶部放置在最靠近定位点的位置。 “bottom”：图标底部放置在最靠近定位点的位置。 “左上角”：图标的左上角放置在最靠近定位点的位置。 “”右上角“：图标的右上角放置在最靠近定位点的位置。 “左下角”：图标的左下角放置在最靠近定位点的位置。 “右下角”：图标的右下角放置在最靠近定位点的位置。 默认为“bottom”。
ignorePlacement	指定其他符号是否可以重叠此符号。 如果为 true，即使它们与图标相撞，其他符号也可以可见。 默认为 false。
image	地图图像子画面中用于绘制图标的图像的名称。 可用的内置映像包括：marker-black、、marker-darkbluemarker-blue、marker-red、marker-yellowpin-blue、pin-darkblue、pin-red、、 pin-round-darkbluepin-round-redpin-round-blue 默认为 "marker-blue"。
offset	指定图标与其定位点之间的偏移距离（以像素为单位）。 正值表示左右，负值表示左和向上。 每个组件乘以大小值以获取最终偏移量（以像素为单位）。 当与旋转结合使用时，偏移量将如同旋转方向向上一样。 默认为 [0, 0]。
opacity	一个介于 0 和 1 之间的数字，指示将绘制图标的不透明度。 默认为 1。
optional	指定是否可以隐藏符号图标，但如果它与其他符号重叠，则显示其文本。 如果为 true，则当图标与其他符号相撞且文本不会发生冲突时，文本将不显示相应的图标。 默认为 false。
padding	用于检测符号冲突的图标边界框周围其他区域的大小。 默认为 2。
pitchAlignment	指定地图倾斜时图标的方向。 “”auto“：自动匹配”rotationAlignment“的值。 “map”：图标与地图的平面对齐。 “视区”：图标与视区平面对齐 默认“自动”
rotation	以度默认值 0为单位顺时针旋转图标的量。
rotationAlignment	结合 SymbolLayerOptions 的放置属性，可确定图标的旋转行为。 “”auto“：当放置为”point“时，这等效于”视区”。 当放置为“line”时，这等效于“map”。 “”map“：当放置为”point“时，图标在东西方向对齐。 当放置为“line”时，图标的 x 轴与线条对齐。 '“视区”'：图标' x 轴将与视口的 x 轴对齐。 默认为“auto”。
size	按提供的因素缩放图标的原始大小。 必须大于或等于 0。 默认为 1。

属性详细信息

allowOverlap

指定符号图标是否可以覆盖地图上的其他符号。 如果该 true 图标与以前绘制的其他符号相撞，该图标也会可见。 提示：如果对符号进行动画处理以确保平滑呈现，请将此值设置为 true。 默认为 false。

allowOverlap?: boolean

属性值

boolean

anchor

指定图标的哪个部分放置在最靠近地图上的图标定位点位置的位置。

“”center“：图标的中心放置在最靠近定位点的位置。

“left”：图标左侧放置在最靠近定位点的位置。

“right”：图标的右侧放置在最靠近定位点的位置。

“top”：图标的顶部放置在最靠近定位点的位置。

“bottom”：图标底部放置在最靠近定位点的位置。

“左上角”：图标的左上角放置在最靠近定位点的位置。

“”右上角“：图标的右上角放置在最靠近定位点的位置。

“左下角”：图标的左下角放置在最靠近定位点的位置。

“右下角”：图标的右下角放置在最靠近定位点的位置。

默认为“bottom”。

anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

属性值

PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

ignorePlacement

指定其他符号是否可以重叠此符号。 如果为 true，即使它们与图标相撞，其他符号也可以可见。 默认为 false。

ignorePlacement?: boolean

属性值

boolean

image

地图图像子画面中用于绘制图标的图像的名称。 可用的内置映像包括：marker-black、、marker-darkbluemarker-blue、marker-red、marker-yellowpin-blue、pin-darkblue、pin-red、、 pin-round-darkbluepin-round-redpin-round-blue 默认为 "marker-blue"。

image?: string | DataDrivenPropertyValueSpecification<string>

属性值

string | DataDrivenPropertyValueSpecification<string>

offset

指定图标与其定位点之间的偏移距离（以像素为单位）。 正值表示左右，负值表示左和向上。 每个组件乘以大小值以获取最终偏移量（以像素为单位）。 当与旋转结合使用时，偏移量将如同旋转方向向上一样。 默认为 [0, 0]。

offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>

属性值

Pixel | DataDrivenPropertyValueSpecification<Pixel>

opacity

一个介于 0 和 1 之间的数字，指示将绘制图标的不透明度。 默认为 1。

opacity?: number | DataDrivenPropertyValueSpecification<number>

属性值

number | DataDrivenPropertyValueSpecification<number>

optional

指定是否可以隐藏符号图标，但如果它与其他符号重叠，则显示其文本。 如果为 true，则当图标与其他符号相撞且文本不会发生冲突时，文本将不显示相应的图标。 默认为 false。

optional?: boolean

属性值

boolean

padding

用于检测符号冲突的图标边界框周围其他区域的大小。 默认为 2。

padding?: number | DataDrivenPropertyValueSpecification<number>

属性值

number | DataDrivenPropertyValueSpecification<number>

pitchAlignment

指定地图倾斜时图标的方向。

“”auto“：自动匹配”rotationAlignment“的值。

“map”：图标与地图的平面对齐。

“视区”：图标与视区平面对齐

默认“自动”

pitchAlignment?: "auto" | "map" | "viewport"

属性值

"auto" | "map" | "viewport"

rotation

以度默认值 0为单位顺时针旋转图标的量。

rotation?: number | DataDrivenPropertyValueSpecification<number>

属性值

number | DataDrivenPropertyValueSpecification<number>

rotationAlignment

结合 SymbolLayerOptions 的放置属性，可确定图标的旋转行为。

“”auto“：当放置为”point“时，这等效于”视区”。 当放置为“line”时，这等效于“map”。

“”map“：当放置为”point“时，图标在东西方向对齐。 当放置为“line”时，图标的 x 轴与线条对齐。

'“视区”'：图标' x 轴将与视口的 x 轴对齐。

默认为“auto”。

rotationAlignment?: "auto" | "map" | "viewport"

属性值

"auto" | "map" | "viewport"

size

按提供的因素缩放图标的原始大小。 必须大于或等于 0。 默认为 1。

size?: number | DataDrivenPropertyValueSpecification<number>

属性值

number | DataDrivenPropertyValueSpecification<number>