TextOptions interface

套件:

azure-maps-control

用來自訂 SymbolLayer 中文字的選項

Extends

Options

屬性

allowOverlap	指定如果文字與其他符號衝突，是否會顯示文字。 如果為 true，即使文字與其他先前繪製的符號相衝突，仍會顯示文字。 預設 false。
anchor	指定圖示的哪個部分會放置在地圖上最接近圖示錨點位置的位置。 '「center」'：圖示的中心放置在最接近錨點的位置。 '「left」'：圖示左側放置於最接近錨點的位置。 '「right」'：圖示右側放置於最接近錨點的位置。 '「top」'：圖示頂端放置於最接近錨點的位置。 '「bottom」'：圖示底部放置於最接近錨點的位置。 '「top-left」'：圖示的左上角會放置在最接近錨點的位置。 '「top-right」'：圖示的右上角會放置在最接近錨點的位置。 '「bottom-left」'：圖示的左下角會放置在最接近錨點的位置。 '「bottom-right」'：圖示的右下角會放置在最接近錨點的位置。 預設 '「center」'。
color	文字的色彩。 預設 "#000000"。
font	要用於顯示文字的字型堆疊。 可能的值： "SegoeFrutigerHelveticaMYingHei-Bold" 、 "SegoeFrutigerHelveticaMYingHei-Medium" 、 "StandardFontCondensed-Light""StandardFont-Bold""SegoeUi-Light""StandardFont-Light""StandardFontCondensed-Bold""StandardFont-Black""StandardFontCondensed-Regular""StandardFontCondensed-Black""StandardFont-Regular""StandardCondensedSegoeUi-Regular""StandardCondensedSegoeUi-Light""StandardCondensedSegoeUi-Bold""StandardCondensedSegoeUi-Black""SegoeUi-SemiLight""SegoeUi-Regular""SegoeUi-SymbolRegular""SegoeFrutigerHelveticaMYingHei-Regular""SegoeUi-Bold""SegoeUi-SemiBold" 。 預設 ["StandardFont-Regular"]。
haloBlur	光暈的淡出距離會以圖元為單位向外。 必須是大於或等於 0 的數位。 預設 0。
haloColor	文字光暈的色彩，可協助它從背景中脫穎而出。 預設 "rgba(0,0,0,0)"。
haloWidth	光暈與字型外框的距離，以圖元為單位。 必須是大於或等於 0 的數位。 文字光暈寬度上限為字型大小的 1/4。 預設 0。
ignorePlacement	指定是否允許其他符號與文字碰撞。 如果為 true，即使其他符號與文字衝突，也可以看見。 預設 false。
justify	文字對齊選項。 '「auto」'：文字對齊錨點位置。 '「left」'：文字靠左對齊。 '「center」'：文字置中。 '「right」'：文字靠右對齊。 預設 '「center」'。
offset	在 ems 中指定圖示與其錨點的位移距離。 正值表示向右和向下，而負值則表示左和上。 預設 [0, 0]。
opacity	介於 0 和 1 之間的數位，表示要繪製文字的不透明度。 預設 1。
optional	指定如果文字可以由另一個符號重迭，則為隱藏文字。 如果為 true，當文字碰撞時，圖示不會顯示其對應的文字，而且圖示不會發生。 預設 false。
padding	用於偵測符號衝突之文字周框方塊周圍其他區域的大小。 預設 2。
pitchAlignment	指定地圖傾斜時文字的方向。 '「auto」'：自動符合 'rotationAlignment' 的值。 '「map」'：文字對齊地圖的平面。 '「viewport」'：文字會對齊檢視區的平面。 預設值：'「auto」'
radialOffset	文字的星形位移，以符號錨點的方向。 搭配 variableAnchor 使用 時很有用，如果存在，則預設為使用二維 offset 。 預設： 0
rotation	以度為單位順時針旋轉文字的數量。 預設 0
rotationAlignment	結合 placement 的 SymbolLayerOptions 屬性，指定形成文字之個別圖像的旋轉行為。 '「auto」'：當 'placement' 設定為 '「point」'時，這相當於 '「map」'。 當 'placement' 設定為 '「line」' 時，這相當於 '「map」'。 '「map」'：當 'placement' 設定為 '「point」'時，會將文字對齊東部-西部。 當 'placement' 設定為 '「line」'時，會將文字 X 軸與線條對齊。 '「viewport」'：產生 X 軸與檢視區 X 軸對齊的字元，不論 'placement' 的值為何。 預設值：'「auto」'
size	以圖元為單位的字型大小。 必須是大於或等於 0 的數位。 預設 16。
textField	指定要用於文字標籤之功能上的屬性名稱。
variableAnchor	潛在錨點位置清單，以增加在地圖上放置高優先順序標籤的機會。 轉譯器會先嘗試將標籤放在每個位置，再移至下一個標籤。 使用 justify: "auto" 根據錨點位置選擇文字對齊。 若要套用位移， radialOffset 請使用 或二維 offset 選項。 '「center」'：圖示的中心放置在最接近錨點的位置。 '「left」'：圖示左側放置於最接近錨點的位置。 '「right」'：圖示右側放置於最接近錨點的位置。 '「top」'：圖示頂端放置於最接近錨點的位置。 '「bottom」'：圖示底部放置於最接近錨點的位置。 '「top-left」'：圖示的左上角會放置在最接近錨點的位置。 '「top-right」'：圖示的右上角會放置在最接近錨點的位置。 '「bottom-left」'：圖示的左下角會放置在最接近錨點的位置。 '「bottom-right」'：圖示的右下角會放置在最接近錨點的位置。 預設值：'undefined'

屬性詳細資料

allowOverlap

指定如果文字與其他符號衝突，是否會顯示文字。 如果為 true，即使文字與其他先前繪製的符號相衝突，仍會顯示文字。 預設 false。

allowOverlap?: boolean

屬性值

boolean

anchor

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

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

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

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

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

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

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

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

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

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

預設 '「center」'。

anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

屬性值

PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

color

文字的色彩。 預設 "#000000"。

color?: string | DataDrivenPropertyValueSpecification<string>

屬性值

string | DataDrivenPropertyValueSpecification<string>

font

要用於顯示文字的字型堆疊。 可能的值： "SegoeFrutigerHelveticaMYingHei-Bold" 、 "SegoeFrutigerHelveticaMYingHei-Medium" 、 "StandardFontCondensed-Light""StandardFont-Bold""SegoeUi-Light""StandardFont-Light""StandardFontCondensed-Bold""StandardFont-Black""StandardFontCondensed-Regular""StandardFontCondensed-Black""StandardFont-Regular""StandardCondensedSegoeUi-Regular""StandardCondensedSegoeUi-Light""StandardCondensedSegoeUi-Bold""StandardCondensedSegoeUi-Black""SegoeUi-SemiLight""SegoeUi-Regular""SegoeUi-SymbolRegular""SegoeFrutigerHelveticaMYingHei-Regular""SegoeUi-Bold""SegoeUi-SemiBold" 。 預設 ["StandardFont-Regular"]。

font?: string[] | DataDrivenPropertyValueSpecification<string[]>

屬性值

string[] | DataDrivenPropertyValueSpecification<string[]>

haloBlur

光暈的淡出距離會以圖元為單位向外。 必須是大於或等於 0 的數位。 預設 0。

haloBlur?: number | DataDrivenPropertyValueSpecification<number>

屬性值

number | DataDrivenPropertyValueSpecification<number>

haloColor

文字光暈的色彩，可協助它從背景中脫穎而出。 預設 "rgba(0,0,0,0)"。

haloColor?: string | DataDrivenPropertyValueSpecification<string>

屬性值

string | DataDrivenPropertyValueSpecification<string>

haloWidth

光暈與字型外框的距離，以圖元為單位。 必須是大於或等於 0 的數位。 文字光暈寬度上限為字型大小的 1/4。 預設 0。

haloWidth?: number | DataDrivenPropertyValueSpecification<number>

屬性值

number | DataDrivenPropertyValueSpecification<number>

ignorePlacement

指定是否允許其他符號與文字碰撞。 如果為 true，即使其他符號與文字衝突，也可以看見。 預設 false。

ignorePlacement?: boolean

屬性值

boolean

justify

文字對齊選項。

'「auto」'：文字對齊錨點位置。

'「left」'：文字靠左對齊。

'「center」'：文字置中。

'「right」'：文字靠右對齊。 預設 '「center」'。

justify?: "auto" | "left" | "center" | "right"

屬性值

"auto" | "left" | "center" | "right"

offset

在 ems 中指定圖示與其錨點的位移距離。 正值表示向右和向下，而負值則表示左和上。 預設 [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 | PropertyValueSpecification<number>

屬性值

number | PropertyValueSpecification<number>

pitchAlignment

指定地圖傾斜時文字的方向。

'「auto」'：自動符合 'rotationAlignment' 的值。

'「map」'：文字對齊地圖的平面。

'「viewport」'：文字會對齊檢視區的平面。

預設值：'「auto」'

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

屬性值

"auto" | "map" | "viewport"

radialOffset

文字的星形位移，以符號錨點的方向。 搭配 variableAnchor 使用 時很有用，如果存在，則預設為使用二維 offset 。 預設： 0

radialOffset?: number | DataDrivenPropertyValueSpecification<number>

屬性值

number | DataDrivenPropertyValueSpecification<number>

rotation

以度為單位順時針旋轉文字的數量。 預設 0

rotation?: number | DataDrivenPropertyValueSpecification<number>

屬性值

number | DataDrivenPropertyValueSpecification<number>

rotationAlignment

結合 placement 的 SymbolLayerOptions 屬性，指定形成文字之個別圖像的旋轉行為。

'「auto」'：當 'placement' 設定為 '「point」'時，這相當於 '「map」'。 當 'placement' 設定為 '「line」' 時，這相當於 '「map」'。

'「map」'：當 'placement' 設定為 '「point」'時，會將文字對齊東部-西部。 當 'placement' 設定為 '「line」'時，會將文字 X 軸與線條對齊。

'「viewport」'：產生 X 軸與檢視區 X 軸對齊的字元，不論 'placement' 的值為何。

預設值：'「auto」'

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

屬性值

"auto" | "map" | "viewport"

size

以圖元為單位的字型大小。 必須是大於或等於 0 的數位。 預設 16。

size?: number | DataDrivenPropertyValueSpecification<number>

屬性值

number | DataDrivenPropertyValueSpecification<number>

textField

指定要用於文字標籤之功能上的屬性名稱。

textField?: string | DataDrivenPropertyValueSpecification<string>

屬性值

string | DataDrivenPropertyValueSpecification<string>

variableAnchor

潛在錨點位置清單，以增加在地圖上放置高優先順序標籤的機會。 轉譯器會先嘗試將標籤放在每個位置，再移至下一個標籤。 使用 justify: "auto" 根據錨點位置選擇文字對齊。 若要套用位移， radialOffset 請使用 或二維 offset 選項。

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

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

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

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

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

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

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

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

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

預設值：'undefined'

variableAnchor?: PositionAnchor[]

屬性值

PositionAnchor[]