IconOptions interface

套件:

azure-maps-control

用來自訂 SymbolLayer 中圖示的選項

Extends

Options

屬性

allowOverlap	指定符號圖示是否可以在地圖上重迭其他符號。 如果 true 圖示會看見，即使它與其他先前繪製的符號相衝突也一樣。 提示：如果以動畫顯示符號以確保呈現順暢，請將此設定為 true。 預設 false。
anchor	指定圖示的哪個部分放置在最接近地圖上圖示錨點位置的位置。 '「center」'：圖示的中心位於最接近錨點的位置。 '「left」'：圖示的左側會放置在最接近錨點的位置。 '「right」'：圖示右側放置於最接近錨點的位置。 '「top」'：圖示頂端放置在最接近錨點的位置。 '「bottom」'：圖示底部放置於最接近錨點的位置。 '「top-left」'：圖示的左上角會放置在最接近錨點的位置。 '「top-right」'：圖示的右上角會放置在最接近錨點的位置。 '「bottom-left」'：圖示的左下角會放置在最接近錨點的位置。 '「bottom-right」'：圖示的右下角會放置在最接近錨點的位置。 預設 '「bottom」'。
ignorePlacement	指定其他符號是否可以重迭此符號。 如果為 true，即使其他符號與圖示衝突，仍會顯示。 預設 false。
image	地圖影像 Sprite 中用於繪製圖示的影像名稱。 可用的內建映射包括：、、、、、、 pin-blue 。 pin-darkbluepin-round-redpin-round-darkbluepin-round-bluepin-redmarker-yellowmarker-redmarker-darkbluemarker-bluemarker-black 預設 "marker-blue"。
offset	指定圖示與其錨點的位移距離，以圖元為單位。 正值表示向右和向下，負值則表示左和上。 每個元件都會乘以大小值，以圖元為單位取得最終位移。 與旋轉結合時，位移會如同旋轉方向向上一樣。 預設 [0, 0]。
opacity	介於 0 和 1 之間的數位，表示繪製圖示的不透明度。 預設 1。
optional	指定是否可以隱藏符號圖示，但如果其與另一個符號重迭，則會顯示其文字。 如果為 true，則當圖示與其他符號衝突，且文字不會發生衝突時，文字不會顯示其對應的圖示。 預設 false。
padding	用於偵測符號衝突的圖示周框方塊周圍其他區域的大小。 預設 2。
pitchAlignment	指定地圖傾斜時圖示的方向。 '「auto」'：自動比對 'rotationAlignment' 的值。 '「map」'：圖示會對齊地圖的平面。 '「viewport」'：圖示對齊檢視區的平面 預設 '「auto」'
rotation	以度為單位順時針旋轉圖示的數量預設值 0 。
rotationAlignment	結合 SymbolLayerOptions 的 placement 屬性，這會決定圖示的旋轉行為。 '「auto」'：當放置為 「point」 時，這相當於 「viewport」。 當 placement 為 「line」 時，這相當於 「map」。 '「map」'：當放置為「點」時，會對齊圖示東部-西部。 當放置為「線條」時，圖示的 X 軸與線條對齊。 '「viewport」'： 圖示' X 軸會對齊檢視區的 X 軸。 預設 '「auto」'。
size	依提供的因素調整圖示的原始大小。 必須大於或等於 0。 預設 1。

屬性詳細資料

allowOverlap

指定符號圖示是否可以在地圖上重迭其他符號。 如果 true 圖示會看見，即使它與其他先前繪製的符號相衝突也一樣。 提示：如果以動畫顯示符號以確保呈現順暢，請將此設定為 true。 預設 false。

allowOverlap?: boolean

屬性值

boolean

anchor

指定圖示的哪個部分放置在最接近地圖上圖示錨點位置的位置。

'「center」'：圖示的中心位於最接近錨點的位置。

'「left」'：圖示的左側會放置在最接近錨點的位置。

'「right」'：圖示右側放置於最接近錨點的位置。

'「top」'：圖示頂端放置在最接近錨點的位置。

'「bottom」'：圖示底部放置於最接近錨點的位置。

'「top-left」'：圖示的左上角會放置在最接近錨點的位置。

'「top-right」'：圖示的右上角會放置在最接近錨點的位置。

'「bottom-left」'：圖示的左下角會放置在最接近錨點的位置。

'「bottom-right」'：圖示的右下角會放置在最接近錨點的位置。

預設 '「bottom」'。

anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

屬性值

PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

ignorePlacement

指定其他符號是否可以重迭此符號。 如果為 true，即使其他符號與圖示衝突，仍會顯示。 預設 false。

ignorePlacement?: boolean

屬性值

boolean

image

地圖影像 Sprite 中用於繪製圖示的影像名稱。 可用的內建映射包括：、、、、、、 pin-blue 。 pin-darkbluepin-round-redpin-round-darkbluepin-round-bluepin-redmarker-yellowmarker-redmarker-darkbluemarker-bluemarker-black 預設 "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」'：圖示會對齊地圖的平面。

'「viewport」'：圖示對齊檢視區的平面

預設 '「auto」'

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

屬性值

"auto" | "map" | "viewport"

rotation

以度為單位順時針旋轉圖示的數量預設值 0 。

rotation?: number | DataDrivenPropertyValueSpecification<number>

屬性值

number | DataDrivenPropertyValueSpecification<number>

rotationAlignment

結合 SymbolLayerOptions 的 placement 屬性，這會決定圖示的旋轉行為。

'「auto」'：當放置為 「point」 時，這相當於 「viewport」。 當 placement 為 「line」 時，這相當於 「map」。

'「map」'：當放置為「點」時，會對齊圖示東部-西部。 當放置為「線條」時，圖示的 X 軸與線條對齊。

'「viewport」'： 圖示' X 軸會對齊檢視區的 X 軸。

預設 '「auto」'。

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

屬性值

"auto" | "map" | "viewport"

size

依提供的因素調整圖示的原始大小。 必須大於或等於 0。 預設 1。

size?: number | DataDrivenPropertyValueSpecification<number>

屬性值

number | DataDrivenPropertyValueSpecification<number>