# Class: Symbol
创建符号图层.
# Hierarchy
-
↳ Symbol
# Table of contents
# Constructors
# Properties
# Methods
- addTo
- clickLayer
- clickPopup
- getData
- getIconAllowOverlap
- getIconAnchor
- getIconColor
- getIconHaloBlur
- getIconHaloColor
- getIconHaloWidth
- getIconIgnorePlacement
- getIconImage
- getIconKeepUpright
- getIconOffset
- getIconOpacity
- getIconOptional
- getIconPadding
- getIconPitchAlignment
- getIconRotate
- getIconRotationAlignment
- getIconSize
- getIconTextFit
- getIconTextFitPadding
- getIconTranslate
- getIconTranslateAnchor
- getLayerId
- getLayerStyle
- getSourceId
- getSymbolAvoidEdges
- getSymbolPlacement
- getSymbolSortKey
- getSymbolSpacing
- getSymbolZOrder
- getTextAllowOverlap
- getTextAnchor
- getTextColor
- getTextField
- getTextFont
- getTextHaloBlur
- getTextHaloColor
- getTextHaloWidth
- getTextIgnorePlacement
- getTextJustify
- getTextKeepUpright
- getTextLetterSpacing
- getTextLineHeight
- getTextMaxAngle
- getTextMaxWidth
- getTextOffset
- getTextOpacity
- getTextOptional
- getTextPadding
- getTextPitchAlignment
- getTextRadialOffset
- getTextRotate
- getTextRotationAlignment
- getTextSize
- getTextTransform
- getTextTranslate
- getTextTranslateAnchor
- getTextVariableAnchor
- getTextWritingMode
- hide
- hoverFeatureState
- hoverLayer
- hoverPointer
- hoverPopup
- remove
- setData
- setFilter
- setIconAllowOverlap
- setIconAnchor
- setIconColor
- setIconHaloBlur
- setIconHaloColor
- setIconHaloWidth
- setIconIgnorePlacement
- setIconImage
- setIconKeepUpright
- setIconOffset
- setIconOpacity
- setIconOptional
- setIconPadding
- setIconPitchAlignment
- setIconRotate
- setIconRotationAlignment
- setIconSize
- setIconTextFit
- setIconTextFitPadding
- setIconTranslate
- setIconTranslateAnchor
- setLayerStyle
- setProperty
- setSymbolAvoidEdges
- setSymbolPlacement
- setSymbolSortKey
- setSymbolSpacing
- setSymbolZOrder
- setTextAllowOverlap
- setTextAnchor
- setTextColor
- setTextField
- setTextFont
- setTextHaloBlur
- setTextHaloColor
- setTextHaloWidth
- setTextIgnorePlacement
- setTextJustify
- setTextKeepUpright
- setTextLetterSpacing
- setTextLineHeight
- setTextMaxAngle
- setTextMaxWidth
- setTextOffset
- setTextOpacity
- setTextOptional
- setTextPadding
- setTextPitchAlignment
- setTextRadialOffset
- setTextRotate
- setTextRotationAlignment
- setTextSize
- setTextTransform
- setTextTranslate
- setTextTranslateAnchor
- setTextVariableAnchor
- setTextWritingMode
- show
- toggle
# Constructors
# constructor
+ new Symbol(options: SymbolOptions): Symbol
# Parameters
| Name | Type |
|---|---|
options | SymbolOptions |
Returns: Symbol
Overrides: OverlayLayerBase
# Properties
# _map
• Optional _map: Map
Inherited from: OverlayLayerBase._map
# layerId
• Optional layerId: string
Inherited from: OverlayLayerBase.layerId
# options
• options: SymbolOptions
# sourceId
• Optional sourceId: string
Inherited from: OverlayLayerBase.sourceId
# Methods
# addTo
▸ addTo(map: Map, beforeId?: string): void
# Parameters
| Name | Type |
|---|---|
map | Map |
beforeId? | string |
Returns: void
Overrides: OverlayLayerBase
# clickLayer
▸ clickLayer(cb: any): any
每当单击这些图层中的要素时都会触发回调。
# Parameters
| Name | Type | Description |
|---|---|---|
cb | any | Callback that receives event with .features property |
Returns: any
A function that removes the handler.
Inherited from: OverlayLayerBase
# clickPopup
▸ clickPopup(htmlFunc: (arg0: {}) => void, popupOptions?: PopupOptions): any
每当单击这些图层中的要素时都会显示一个弹出窗口。
example clickPopup(f => <h3>${f.properties.Name}</h3> ${f.properties.Description}, { maxWidth: 500 });
# Parameters
| Name | Type | Description |
|---|---|---|
htmlFunc | (arg0: {}) => void | Function that receives feature and popup, returns HTML. |
popupOptions? | PopupOptions | Options passed to Popup() to customise popup. |
Returns: any
A function that removes the handler.
Inherited from: OverlayLayerBase
# getData
▸ getData(): undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection
获取数据源的数据
Returns: undefined | Feature<Geometry | GeometryCollection, Properties> | FeatureCollection<Geometry | GeometryCollection, Properties> | Geometry | GeometryCollection
Inherited from: OverlayLayerBase
# getIconAllowOverlap
▸ getIconAllowOverlap(): PropertyValueSpecificationEx<boolean>
Returns: PropertyValueSpecificationEx<boolean>
# getIconAnchor
▸ getIconAnchor(): DataDrivenPropertyValueSpecification<Anchor>
Returns: DataDrivenPropertyValueSpecification<Anchor>
# getIconColor
▸ getIconColor(): DataDrivenPropertyValueSpecification<string>
Returns: DataDrivenPropertyValueSpecification<string>
# getIconHaloBlur
▸ getIconHaloBlur(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getIconHaloColor
▸ getIconHaloColor(): DataDrivenPropertyValueSpecification<string>
Returns: DataDrivenPropertyValueSpecification<string>
# getIconHaloWidth
▸ getIconHaloWidth(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getIconIgnorePlacement
▸ getIconIgnorePlacement(): PropertyValueSpecificationEx<boolean>
Returns: PropertyValueSpecificationEx<boolean>
# getIconImage
▸ getIconImage(): DataDrivenPropertyValueSpecification<string>
Returns: DataDrivenPropertyValueSpecification<string>
# getIconKeepUpright
▸ getIconKeepUpright(): PropertyValueSpecificationEx<boolean>
Returns: PropertyValueSpecificationEx<boolean>
# getIconOffset
▸ getIconOffset(): DataDrivenPropertyValueSpecification<[number, number]>
Returns: DataDrivenPropertyValueSpecification<[number, number]>
# getIconOpacity
▸ getIconOpacity(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getIconOptional
▸ getIconOptional(): PropertyValueSpecificationEx<boolean>
Returns: PropertyValueSpecificationEx<boolean>
# getIconPadding
▸ getIconPadding(): PropertyValueSpecificationEx<number>
Returns: PropertyValueSpecificationEx<number>
# getIconPitchAlignment
▸ getIconPitchAlignment(): PropertyValueSpecificationEx<"map" | "viewport" | "auto">
Returns: PropertyValueSpecificationEx<"map" | "viewport" | "auto">
# getIconRotate
▸ getIconRotate(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getIconRotationAlignment
▸ getIconRotationAlignment(): PropertyValueSpecificationEx<"map" | "viewport" | "auto">
Returns: PropertyValueSpecificationEx<"map" | "viewport" | "auto">
# getIconSize
▸ getIconSize(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getIconTextFit
▸ getIconTextFit(): PropertyValueSpecificationEx<"none" | "width" | "height" | "both">
Returns: PropertyValueSpecificationEx<"none" | "width" | "height" | "both">
# getIconTextFitPadding
▸ getIconTextFitPadding(): PropertyValueSpecificationEx<[number, number, number, number]>
Returns: PropertyValueSpecificationEx<[number, number, number, number]>
# getIconTranslate
▸ getIconTranslate(): PropertyValueSpecificationEx<[number, number]>
Returns: PropertyValueSpecificationEx<[number, number]>
# getIconTranslateAnchor
▸ getIconTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">
Returns: PropertyValueSpecificationEx<"map" | "viewport">
# getLayerId
▸ getLayerId(): undefined | string
获取图层ID
Returns: undefined | string
Inherited from: OverlayLayerBase
# getLayerStyle
▸ getLayerStyle(): LayerSpecification
根据样式规范，获取给定图层 ID 的图层定义。
Returns: LayerSpecification
Inherited from: OverlayLayerBase
# getSourceId
▸ getSourceId(): undefined | string
获取数据源ID
Returns: undefined | string
Inherited from: OverlayLayerBase
# getSymbolAvoidEdges
▸ getSymbolAvoidEdges(): PropertyValueSpecificationEx<boolean>
Returns: PropertyValueSpecificationEx<boolean>
# getSymbolPlacement
▸ getSymbolPlacement(): PropertyValueSpecificationEx<"line" | "point" | "line-center">
Returns: PropertyValueSpecificationEx<"line" | "point" | "line-center">
# getSymbolSortKey
▸ getSymbolSortKey(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getSymbolSpacing
▸ getSymbolSpacing(): PropertyValueSpecificationEx<number>
Returns: PropertyValueSpecificationEx<number>
# getSymbolZOrder
▸ getSymbolZOrder(): PropertyValueSpecificationEx<"source" | "auto" | "viewport-y">
Returns: PropertyValueSpecificationEx<"source" | "auto" | "viewport-y">
# getTextAllowOverlap
▸ getTextAllowOverlap(): PropertyValueSpecificationEx<boolean>
Returns: PropertyValueSpecificationEx<boolean>
# getTextAnchor
▸ getTextAnchor(): DataDrivenPropertyValueSpecification<Anchor>
Returns: DataDrivenPropertyValueSpecification<Anchor>
# getTextColor
▸ getTextColor(): DataDrivenPropertyValueSpecification<string>
Returns: DataDrivenPropertyValueSpecification<string>
# getTextField
▸ getTextField(): DataDrivenPropertyValueSpecification<string>
Returns: DataDrivenPropertyValueSpecification<string>
# getTextFont
▸ getTextFont(): DataDrivenPropertyValueSpecification<string[]>
Returns: DataDrivenPropertyValueSpecification<string[]>
# getTextHaloBlur
▸ getTextHaloBlur(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getTextHaloColor
▸ getTextHaloColor(): DataDrivenPropertyValueSpecification<string>
Returns: DataDrivenPropertyValueSpecification<string>
# getTextHaloWidth
▸ getTextHaloWidth(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getTextIgnorePlacement
▸ getTextIgnorePlacement(): PropertyValueSpecificationEx<boolean>
Returns: PropertyValueSpecificationEx<boolean>
# getTextJustify
▸ getTextJustify(): DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "auto">
Returns: DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "auto">
# getTextKeepUpright
▸ getTextKeepUpright(): PropertyValueSpecificationEx<boolean>
Returns: PropertyValueSpecificationEx<boolean>
# getTextLetterSpacing
▸ getTextLetterSpacing(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getTextLineHeight
▸ getTextLineHeight(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getTextMaxAngle
▸ getTextMaxAngle(): PropertyValueSpecificationEx<number>
Returns: PropertyValueSpecificationEx<number>
# getTextMaxWidth
▸ getTextMaxWidth(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getTextOffset
▸ getTextOffset(): DataDrivenPropertyValueSpecification<[number, number]>
Returns: DataDrivenPropertyValueSpecification<[number, number]>
# getTextOpacity
▸ getTextOpacity(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getTextOptional
▸ getTextOptional(): PropertyValueSpecificationEx<boolean>
Returns: PropertyValueSpecificationEx<boolean>
# getTextPadding
▸ getTextPadding(): PropertyValueSpecificationEx<number>
Returns: PropertyValueSpecificationEx<number>
# getTextPitchAlignment
▸ getTextPitchAlignment(): PropertyValueSpecificationEx<"map" | "viewport" | "auto">
Returns: PropertyValueSpecificationEx<"map" | "viewport" | "auto">
# getTextRadialOffset
▸ getTextRadialOffset(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getTextRotate
▸ getTextRotate(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getTextRotationAlignment
▸ getTextRotationAlignment(): PropertyValueSpecificationEx<"map" | "viewport" | "auto">
Returns: PropertyValueSpecificationEx<"map" | "viewport" | "auto">
# getTextSize
▸ getTextSize(): DataDrivenPropertyValueSpecification<number>
Returns: DataDrivenPropertyValueSpecification<number>
# getTextTransform
▸ getTextTransform(): DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">
Returns: DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">
# getTextTranslate
▸ getTextTranslate(): PropertyValueSpecificationEx<[number, number]>
Returns: PropertyValueSpecificationEx<[number, number]>
# getTextTranslateAnchor
▸ getTextTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">
Returns: PropertyValueSpecificationEx<"map" | "viewport">
# getTextVariableAnchor
▸ getTextVariableAnchor(): PropertyValueSpecificationEx<Anchor[]>
Returns: PropertyValueSpecificationEx<Anchor[]>
# getTextWritingMode
▸ getTextWritingMode(): PropertyValueSpecificationEx<("vertical" | "horizontal")[]>
Returns: PropertyValueSpecificationEx<("vertical" | "horizontal")[]>
# hide
▸ hide(): void
使给定的图层不可见。
Returns: void
Inherited from: OverlayLayerBase
# hoverFeatureState
▸ hoverFeatureState(enterCb?: (arg0: {}) => void, leaveCb?: (arg0: {}) => void): void
每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。
# Parameters
| Name | Type |
|---|---|
enterCb? | (arg0: {}) => void |
leaveCb? | (arg0: {}) => void |
Returns: void
Inherited from: OverlayLayerBase
# hoverLayer
▸ hoverLayer(cb: any): any
当鼠标悬停在这些图层中的要素上时触发回调。
# Parameters
| Name | Type |
|---|---|
cb | any |
Returns: any
A function to remove the handler.
Inherited from: OverlayLayerBase
# hoverPointer
▸ hoverPointer(): void
每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。
Returns: void
A function to remove the handler.
Inherited from: OverlayLayerBase
# hoverPopup
▸ hoverPopup(htmlFunc: any, popupOptions?: PopupOptions): any
将鼠标悬停在这些图层中的某个要素上时，会显示一个弹出窗口。
example hoverPopup(f => <h3>${f.properties.Name}</h3> ${f.properties.Description}, { anchor: 'left' });
# Parameters
| Name | Type | Description |
|---|---|---|
htmlFunc | any | Function that receives feature and popup, returns HTML. |
popupOptions? | PopupOptions | Options passed to Popup() to customise popup. |
Returns: any
Inherited from: OverlayLayerBase
# remove
▸ remove(): void
Returns: void
Inherited from: OverlayLayerBase
# setData
▸ setData(data: any): void
替换 GeoJSON 图层的当前数据。
# Parameters
| Name | Type |
|---|---|
data | any |
Returns: void
# setFilter
▸ setFilter(filter: FilterSpecification): void
替换一个图层的过滤器。
example setFilter(['==','level','0']]);
# Parameters
| Name | Type | Description |
|---|---|---|
filter | FilterSpecification | New filter to set. |
Returns: void
Inherited from: OverlayLayerBase
# setIconAllowOverlap
▸ setIconAllowOverlap(value: PropertyValueSpecificationEx<boolean>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<boolean> |
Returns: Symbol
# setIconAnchor
▸ setIconAnchor(value: DataDrivenPropertyValueSpecification<Anchor>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<Anchor> |
Returns: Symbol
# setIconColor
▸ setIconColor(value: DataDrivenPropertyValueSpecification<string>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<string> |
Returns: Symbol
# setIconHaloBlur
▸ setIconHaloBlur(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setIconHaloColor
▸ setIconHaloColor(value: DataDrivenPropertyValueSpecification<string>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<string> |
Returns: Symbol
# setIconHaloWidth
▸ setIconHaloWidth(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setIconIgnorePlacement
▸ setIconIgnorePlacement(value: PropertyValueSpecificationEx<boolean>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<boolean> |
Returns: Symbol
# setIconImage
▸ setIconImage(value: DataDrivenPropertyValueSpecification<string>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<string> |
Returns: Symbol
# setIconKeepUpright
▸ setIconKeepUpright(value: PropertyValueSpecificationEx<boolean>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<boolean> |
Returns: Symbol
# setIconOffset
▸ setIconOffset(value: DataDrivenPropertyValueSpecification<[number, number]>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<[number, number]> |
Returns: Symbol
# setIconOpacity
▸ setIconOpacity(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setIconOptional
▸ setIconOptional(value: PropertyValueSpecificationEx<boolean>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<boolean> |
Returns: Symbol
# setIconPadding
▸ setIconPadding(value: PropertyValueSpecificationEx<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<number> |
Returns: Symbol
# setIconPitchAlignment
▸ setIconPitchAlignment(value: PropertyValueSpecificationEx<"map" | "viewport" | "auto">): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<"map" | "viewport" | "auto"> |
Returns: Symbol
# setIconRotate
▸ setIconRotate(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setIconRotationAlignment
▸ setIconRotationAlignment(value: PropertyValueSpecificationEx<"map" | "viewport" | "auto">): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<"map" | "viewport" | "auto"> |
Returns: Symbol
# setIconSize
▸ setIconSize(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setIconTextFit
▸ setIconTextFit(value: PropertyValueSpecificationEx<"none" | "width" | "height" | "both">): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<"none" | "width" | "height" | "both"> |
Returns: Symbol
# setIconTextFitPadding
▸ setIconTextFitPadding(value: PropertyValueSpecificationEx<[number, number, number, number]>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<[number, number, number, number]> |
Returns: Symbol
# setIconTranslate
▸ setIconTranslate(value: PropertyValueSpecificationEx<[number, number]>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<[number, number]> |
Returns: Symbol
# setIconTranslateAnchor
▸ setIconTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<"map" | "viewport"> |
Returns: Symbol
# setLayerStyle
▸ setLayerStyle(style: any): void
设置图层样式
# Parameters
| Name | Type |
|---|---|
style | any |
Returns: void
Inherited from: OverlayLayerBase
# setProperty
▸ setProperty(prop: string | object, value?: any): void
在一个或多个图层上设置绘制或布局属性。
example setProperty('fillOpacity', 0.5)
# Parameters
| Name | Type |
|---|---|
prop | string | object |
value? | any |
Returns: void
Inherited from: OverlayLayerBase
# setSymbolAvoidEdges
▸ setSymbolAvoidEdges(value: PropertyValueSpecificationEx<boolean>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<boolean> |
Returns: Symbol
# setSymbolPlacement
▸ setSymbolPlacement(value: PropertyValueSpecificationEx<"line" | "point" | "line-center">): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<"line" | "point" | "line-center"> |
Returns: Symbol
# setSymbolSortKey
▸ setSymbolSortKey(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setSymbolSpacing
▸ setSymbolSpacing(value: PropertyValueSpecificationEx<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<number> |
Returns: Symbol
# setSymbolZOrder
▸ setSymbolZOrder(value: PropertyValueSpecificationEx<"source" | "auto" | "viewport-y">): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<"source" | "auto" | "viewport-y"> |
Returns: Symbol
# setTextAllowOverlap
▸ setTextAllowOverlap(value: PropertyValueSpecificationEx<boolean>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<boolean> |
Returns: Symbol
# setTextAnchor
▸ setTextAnchor(value: DataDrivenPropertyValueSpecification<Anchor>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<Anchor> |
Returns: Symbol
# setTextColor
▸ setTextColor(value: DataDrivenPropertyValueSpecification<string>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<string> |
Returns: Symbol
# setTextField
▸ setTextField(value: DataDrivenPropertyValueSpecification<string>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<string> |
Returns: Symbol
# setTextFont
▸ setTextFont(value: DataDrivenPropertyValueSpecification<string[]>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<string[]> |
Returns: Symbol
# setTextHaloBlur
▸ setTextHaloBlur(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setTextHaloColor
▸ setTextHaloColor(value: DataDrivenPropertyValueSpecification<string>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<string> |
Returns: Symbol
# setTextHaloWidth
▸ setTextHaloWidth(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setTextIgnorePlacement
▸ setTextIgnorePlacement(value: PropertyValueSpecificationEx<boolean>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<boolean> |
Returns: Symbol
# setTextJustify
▸ setTextJustify(value: DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "auto">): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<"center" | "left" | "right" | "auto"> |
Returns: Symbol
# setTextKeepUpright
▸ setTextKeepUpright(value: PropertyValueSpecificationEx<boolean>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<boolean> |
Returns: Symbol
# setTextLetterSpacing
▸ setTextLetterSpacing(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setTextLineHeight
▸ setTextLineHeight(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setTextMaxAngle
▸ setTextMaxAngle(value: PropertyValueSpecificationEx<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<number> |
Returns: Symbol
# setTextMaxWidth
▸ setTextMaxWidth(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setTextOffset
▸ setTextOffset(value: DataDrivenPropertyValueSpecification<[number, number]>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<[number, number]> |
Returns: Symbol
# setTextOpacity
▸ setTextOpacity(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setTextOptional
▸ setTextOptional(value: PropertyValueSpecificationEx<boolean>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<boolean> |
Returns: Symbol
# setTextPadding
▸ setTextPadding(value: PropertyValueSpecificationEx<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<number> |
Returns: Symbol
# setTextPitchAlignment
▸ setTextPitchAlignment(value: PropertyValueSpecificationEx<"map" | "viewport" | "auto">): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<"map" | "viewport" | "auto"> |
Returns: Symbol
# setTextRadialOffset
▸ setTextRadialOffset(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setTextRotate
▸ setTextRotate(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setTextRotationAlignment
▸ setTextRotationAlignment(value: PropertyValueSpecificationEx<"map" | "viewport" | "auto">): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<"map" | "viewport" | "auto"> |
Returns: Symbol
# setTextSize
▸ setTextSize(value: DataDrivenPropertyValueSpecification<number>): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<number> |
Returns: Symbol
# setTextTransform
▸ setTextTransform(value: DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase">): Symbol
# Parameters
| Name | Type |
|---|---|
value | DataDrivenPropertyValueSpecification<"none" | "uppercase" | "lowercase"> |
Returns: Symbol
# setTextTranslate
▸ setTextTranslate(value: PropertyValueSpecificationEx<[number, number]>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<[number, number]> |
Returns: Symbol
# setTextTranslateAnchor
▸ setTextTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<"map" | "viewport"> |
Returns: Symbol
# setTextVariableAnchor
▸ setTextVariableAnchor(value: PropertyValueSpecificationEx<Anchor[]>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<Anchor[]> |
Returns: Symbol
# setTextWritingMode
▸ setTextWritingMode(value: PropertyValueSpecificationEx<("vertical" | "horizontal")[]>): Symbol
# Parameters
| Name | Type |
|---|---|
value | PropertyValueSpecificationEx<("vertical" | "horizontal")[]> |
Returns: Symbol
# show
▸ show(): void
使给定的图层可见。
Returns: void
Inherited from: OverlayLayerBase
# toggle
▸ toggle(state: boolean): boolean
根据参数使给定的图层隐藏或可见。
# Parameters
| Name | Type | Description |
|---|---|---|
state | boolean | True for visible, false for hidden. |
Returns: boolean
Inherited from: OverlayLayerBase