TextOptions interface

指定如果文本与其他符号相撞，则文本是否可见。 如果为 true，即使文本与其他以前绘制的符号相撞，文本也会可见。 默认为 false。

allowOverlap?: boolean

属性值

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

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

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

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

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

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

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

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

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

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

anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

属性值

文本的颜色。 默认为 "#000000"。

color?: string | DataDrivenPropertyValueSpecification<string>

属性值

用于显示文本的字体堆栈。 可能的值："SegoeFrutigerHelveticaMYingHei-Bold"、、"SegoeFrutigerHelveticaMYingHei-Medium"、"SegoeFrutigerHelveticaMYingHei-Regular"、 "StandardFontCondensed-Regular""StandardFontCondensed-Light""SegoeUi-Bold""SegoeUi-Light""SegoeUi-Regular""SegoeUi-SemiBold""SegoeUi-SemiLight""SegoeUi-SymbolRegular""StandardCondensedSegoeUi-Black""StandardCondensedSegoeUi-Bold""StandardCondensedSegoeUi-Light""StandardCondensedSegoeUi-Regular""StandardFont-Black""StandardFont-Bold""StandardFont-Light""StandardFont-Regular""StandardFontCondensed-Black""StandardFontCondensed-Bold" 默认为 ["StandardFont-Regular"]。

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

属性值

光环向外部的淡出距离（以像素为单位）。 必须是大于或等于 0 的数字。 默认为 0。

haloBlur?: number | DataDrivenPropertyValueSpecification<number>

属性值

文本光环的颜色，这有助于它从背景中脱颖而出。 默认为 "rgba(0,0,0,0)"。

haloColor?: string | DataDrivenPropertyValueSpecification<string>

属性值

光环到字体轮廓的距离（以像素为单位）。 必须是大于或等于 0 的数字。 最大文本光环宽度为字号的 1/4。 默认为 0。

haloWidth?: number | DataDrivenPropertyValueSpecification<number>

属性值

指定是否允许其他符号与文本相撞。 如果为 true，即使它们与文本相撞，其他符号也可以可见。 默认为 false。

ignorePlacement?: boolean

属性值

文本对齐选项。

“”auto“：文本与定位点位置对齐。

“left”：文本与左侧对齐。

“”center“：文本居中。

“right”：文本与右侧对齐。 默认为“center”。

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

属性值

指定图标与其在 ems 中的定位点之间的偏移距离。 正值表示左右，负值表示左和向上。 默认为 [0, 0]。

offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>

属性值

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

opacity?: number | DataDrivenPropertyValueSpecification<number>

属性值

指定如果文本被另一个符号重叠，则是否隐藏文本。 如果为 true，则当文本与其他符号相撞且图标不相撞时，图标将不显示相应的文本。 默认为 false。

optional?: boolean

属性值

用于检测符号冲突的文本边界框周围的附加区域的大小。 默认为 2。

padding?: number | PropertyValueSpecification<number>

属性值

指定在倾斜地图时文本的方向。

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

“map”：文本与地图平面对齐。

“视区”：文本与视区平面对齐。

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

属性值

文本的径向偏移量，以符号定位点的方向排列。 与 结合使用 variableAnchor时非常有用，如果存在，则默认使用二维 offset 。 默认：0

radialOffset?: number | DataDrivenPropertyValueSpecification<number>

属性值

以度为单位旋转文本的量。 默认 0

rotation?: number | DataDrivenPropertyValueSpecification<number>

属性值

结合属性SymbolLayerOptions，placement指定构成文本的单个字形的旋转行为。

“”auto“：当”placement“设置为”point“时，这相当于”“map”。 当“placement”设置为“line”时，这等效于“map”。

“”map“：当”placement“设置为”point“时，将文本向东对齐。 当“placement”设置为“line”时，将文本 x 轴与线条对齐。

“”视区“：生成标志符号，其 x 轴与视区 x 轴对齐，而不考虑”放置“的值。

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

属性值

字体的大小（以像素为单位）。 必须是大于或等于 0 的数字。 默认为 16。

size?: number | DataDrivenPropertyValueSpecification<number>

属性值

指定要用于文本标签的功能的属性的名称。

textField?: string | DataDrivenPropertyValueSpecification<string>

属性值

潜在的定位点位置列表，以提高在地图上放置高优先级标签的可能性。 呈现器将尝试将标签按顺序放置在每个位置，然后再转到下一个标签。 用于 justify: "auto" 根据定位点位置选择文本对齐。 若要应用偏移量， radialOffset 请使用或二维 offset 选项。

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

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

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

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

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

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

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

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

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

variableAnchor?: PositionAnchor[]

属性值