---
title: Class: Symbol
source: https://vjmap.com/doc/Class_Symbol.html
---

# Class: Symbol

创建符号图层.

### Hierarchy

- [*OverlayLayerBase*](#classesdefaultoverlaylayerbasemd)

  ↳ **Symbol**

### Table of contents

#### Constructors

- [constructor](#constructor)

#### Properties

- [\_map](#_map)
- [layerId](#layerid)
- [options](#options)
- [sourceId](#sourceid)

#### Methods

- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getData](#getdata)
- [getIconAllowOverlap](#geticonallowoverlap)
- [getIconAnchor](#geticonanchor)
- [getIconColor](#geticoncolor)
- [getIconHaloBlur](#geticonhaloblur)
- [getIconHaloColor](#geticonhalocolor)
- [getIconHaloWidth](#geticonhalowidth)
- [getIconIgnorePlacement](#geticonignoreplacement)
- [getIconImage](#geticonimage)
- [getIconKeepUpright](#geticonkeepupright)
- [getIconOffset](#geticonoffset)
- [getIconOpacity](#geticonopacity)
- [getIconOptional](#geticonoptional)
- [getIconPadding](#geticonpadding)
- [getIconPitchAlignment](#geticonpitchalignment)
- [getIconRotate](#geticonrotate)
- [getIconRotationAlignment](#geticonrotationalignment)
- [getIconSize](#geticonsize)
- [getIconTextFit](#geticontextfit)
- [getIconTextFitPadding](#geticontextfitpadding)
- [getIconTranslate](#geticontranslate)
- [getIconTranslateAnchor](#geticontranslateanchor)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getSourceId](#getsourceid)
- [getSymbolAvoidEdges](#getsymbolavoidedges)
- [getSymbolPlacement](#getsymbolplacement)
- [getSymbolSortKey](#getsymbolsortkey)
- [getSymbolSpacing](#getsymbolspacing)
- [getSymbolZOrder](#getsymbolzorder)
- [getTextAllowOverlap](#gettextallowoverlap)
- [getTextAnchor](#gettextanchor)
- [getTextColor](#gettextcolor)
- [getTextField](#gettextfield)
- [getTextFont](#gettextfont)
- [getTextHaloBlur](#gettexthaloblur)
- [getTextHaloColor](#gettexthalocolor)
- [getTextHaloWidth](#gettexthalowidth)
- [getTextIgnorePlacement](#gettextignoreplacement)
- [getTextJustify](#gettextjustify)
- [getTextKeepUpright](#gettextkeepupright)
- [getTextLetterSpacing](#gettextletterspacing)
- [getTextLineHeight](#gettextlineheight)
- [getTextMaxAngle](#gettextmaxangle)
- [getTextMaxWidth](#gettextmaxwidth)
- [getTextOffset](#gettextoffset)
- [getTextOpacity](#gettextopacity)
- [getTextOptional](#gettextoptional)
- [getTextPadding](#gettextpadding)
- [getTextPitchAlignment](#gettextpitchalignment)
- [getTextRadialOffset](#gettextradialoffset)
- [getTextRotate](#gettextrotate)
- [getTextRotationAlignment](#gettextrotationalignment)
- [getTextSize](#gettextsize)
- [getTextTransform](#gettexttransform)
- [getTextTranslate](#gettexttranslate)
- [getTextTranslateAnchor](#gettexttranslateanchor)
- [getTextVariableAnchor](#gettextvariableanchor)
- [getTextWritingMode](#gettextwritingmode)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setData](#setdata)
- [setFilter](#setfilter)
- [setIconAllowOverlap](#seticonallowoverlap)
- [setIconAnchor](#seticonanchor)
- [setIconColor](#seticoncolor)
- [setIconHaloBlur](#seticonhaloblur)
- [setIconHaloColor](#seticonhalocolor)
- [setIconHaloWidth](#seticonhalowidth)
- [setIconIgnorePlacement](#seticonignoreplacement)
- [setIconImage](#seticonimage)
- [setIconKeepUpright](#seticonkeepupright)
- [setIconOffset](#seticonoffset)
- [setIconOpacity](#seticonopacity)
- [setIconOptional](#seticonoptional)
- [setIconPadding](#seticonpadding)
- [setIconPitchAlignment](#seticonpitchalignment)
- [setIconRotate](#seticonrotate)
- [setIconRotationAlignment](#seticonrotationalignment)
- [setIconSize](#seticonsize)
- [setIconTextFit](#seticontextfit)
- [setIconTextFitPadding](#seticontextfitpadding)
- [setIconTranslate](#seticontranslate)
- [setIconTranslateAnchor](#seticontranslateanchor)
- [setLayerStyle](#setlayerstyle)
- [setProperty](#setproperty)
- [setSymbolAvoidEdges](#setsymbolavoidedges)
- [setSymbolPlacement](#setsymbolplacement)
- [setSymbolSortKey](#setsymbolsortkey)
- [setSymbolSpacing](#setsymbolspacing)
- [setSymbolZOrder](#setsymbolzorder)
- [setTextAllowOverlap](#settextallowoverlap)
- [setTextAnchor](#settextanchor)
- [setTextColor](#settextcolor)
- [setTextField](#settextfield)
- [setTextFont](#settextfont)
- [setTextHaloBlur](#settexthaloblur)
- [setTextHaloColor](#settexthalocolor)
- [setTextHaloWidth](#settexthalowidth)
- [setTextIgnorePlacement](#settextignoreplacement)
- [setTextJustify](#settextjustify)
- [setTextKeepUpright](#settextkeepupright)
- [setTextLetterSpacing](#settextletterspacing)
- [setTextLineHeight](#settextlineheight)
- [setTextMaxAngle](#settextmaxangle)
- [setTextMaxWidth](#settextmaxwidth)
- [setTextOffset](#settextoffset)
- [setTextOpacity](#settextopacity)
- [setTextOptional](#settextoptional)
- [setTextPadding](#settextpadding)
- [setTextPitchAlignment](#settextpitchalignment)
- [setTextRadialOffset](#settextradialoffset)
- [setTextRotate](#settextrotate)
- [setTextRotationAlignment](#settextrotationalignment)
- [setTextSize](#settextsize)
- [setTextTransform](#settexttransform)
- [setTextTranslate](#settexttranslate)
- [setTextTranslateAnchor](#settexttranslateanchor)
- [setTextVariableAnchor](#settextvariableanchor)
- [setTextWritingMode](#settextwritingmode)
- [show](#show)
- [toggle](#toggle)

### Constructors

#### constructor

\+ **new Symbol**(`options`: [*SymbolOptions*](#interfacesdefaultsymboloptionsmd)): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `options` | [*SymbolOptions*](#interfacesdefaultsymboloptionsmd) |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

Overrides: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

### Properties

#### \_map

• `Optional` **\_map**: *Map*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[_map](#_map)

___

#### layerId

• `Optional` **layerId**: *string*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[layerId](#layerid)

___

#### options

• **options**: [*SymbolOptions*](#interfacesdefaultsymboloptionsmd)

___

#### sourceId

• `Optional` **sourceId**: *string*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd).[sourceId](#sourceid)

### Methods

#### addTo

▸ **addTo**(`map`: *Map*, `beforeId?`: *string*): *void*

##### Parameters

| Name | Type |
| :------ | :------ |
| `map` | *Map* |
| `beforeId?` | *string* |

**Returns:** *void*

Overrides: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### 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](#classesdefaultoverlaylayerbasemd)

___

#### 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](#classesdefaultoverlaylayerbasemd)

___

#### 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](#classesdefaultoverlaylayerbasemd)

___

#### getIconAllowOverlap

▸ **getIconAllowOverlap**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

___

#### getIconAnchor

▸ **getIconAnchor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*Anchor*](#anchor)\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*Anchor*](#anchor)\>

___

#### getIconColor

▸ **getIconColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

___

#### getIconHaloBlur

▸ **getIconHaloBlur**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getIconHaloColor

▸ **getIconHaloColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

___

#### getIconHaloWidth

▸ **getIconHaloWidth**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getIconIgnorePlacement

▸ **getIconIgnorePlacement**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

___

#### getIconImage

▸ **getIconImage**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

___

#### getIconKeepUpright

▸ **getIconKeepUpright**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

___

#### getIconOffset

▸ **getIconOffset**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*number*, *number*]\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*number*, *number*]\>

___

#### getIconOpacity

▸ **getIconOpacity**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getIconOptional

▸ **getIconOptional**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

___

#### getIconPadding

▸ **getIconPadding**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>

___

#### getIconPitchAlignment

▸ **getIconPitchAlignment**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\>

___

#### getIconRotate

▸ **getIconRotate**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getIconRotationAlignment

▸ **getIconRotationAlignment**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\>

___

#### getIconSize

▸ **getIconSize**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getIconTextFit

▸ **getIconTextFit**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"none"`` \| ``"width"`` \| ``"height"`` \| ``"both"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"none"`` \| ``"width"`` \| ``"height"`` \| ``"both"``\>

___

#### getIconTextFitPadding

▸ **getIconTextFitPadding**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*, *number*, *number*]\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*, *number*, *number*]\>

___

#### getIconTranslate

▸ **getIconTranslate**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>

___

#### getIconTranslateAnchor

▸ **getIconTranslateAnchor**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>

___

#### getLayerId

▸ **getLayerId**(): *undefined* \| *string*

获取图层ID

**Returns:** *undefined* \| *string*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### getLayerStyle

▸ **getLayerStyle**(): [*LayerSpecification*](#layerspecification)

根据样式规范，获取给定图层 ID 的图层定义。

**Returns:** [*LayerSpecification*](#layerspecification)

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### getSourceId

▸ **getSourceId**(): *undefined* \| *string*

获取数据源ID

**Returns:** *undefined* \| *string*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### getSymbolAvoidEdges

▸ **getSymbolAvoidEdges**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

___

#### getSymbolPlacement

▸ **getSymbolPlacement**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"line"`` \| ``"point"`` \| ``"line-center"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"line"`` \| ``"point"`` \| ``"line-center"``\>

___

#### getSymbolSortKey

▸ **getSymbolSortKey**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getSymbolSpacing

▸ **getSymbolSpacing**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>

___

#### getSymbolZOrder

▸ **getSymbolZOrder**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"source"`` \| ``"auto"`` \| ``"viewport-y"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"source"`` \| ``"auto"`` \| ``"viewport-y"``\>

___

#### getTextAllowOverlap

▸ **getTextAllowOverlap**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

___

#### getTextAnchor

▸ **getTextAnchor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*Anchor*](#anchor)\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*Anchor*](#anchor)\>

___

#### getTextColor

▸ **getTextColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

___

#### getTextField

▸ **getTextField**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

___

#### getTextFont

▸ **getTextFont**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string[]\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string[]\>

___

#### getTextHaloBlur

▸ **getTextHaloBlur**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getTextHaloColor

▸ **getTextHaloColor**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>

___

#### getTextHaloWidth

▸ **getTextHaloWidth**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getTextIgnorePlacement

▸ **getTextIgnorePlacement**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

___

#### getTextJustify

▸ **getTextJustify**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"center"`` \| ``"left"`` \| ``"right"`` \| ``"auto"``\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"center"`` \| ``"left"`` \| ``"right"`` \| ``"auto"``\>

___

#### getTextKeepUpright

▸ **getTextKeepUpright**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

___

#### getTextLetterSpacing

▸ **getTextLetterSpacing**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getTextLineHeight

▸ **getTextLineHeight**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getTextMaxAngle

▸ **getTextMaxAngle**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>

___

#### getTextMaxWidth

▸ **getTextMaxWidth**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getTextOffset

▸ **getTextOffset**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*number*, *number*]\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*number*, *number*]\>

___

#### getTextOpacity

▸ **getTextOpacity**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getTextOptional

▸ **getTextOptional**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>

___

#### getTextPadding

▸ **getTextPadding**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>

___

#### getTextPitchAlignment

▸ **getTextPitchAlignment**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\>

___

#### getTextRadialOffset

▸ **getTextRadialOffset**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getTextRotate

▸ **getTextRotate**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getTextRotationAlignment

▸ **getTextRotationAlignment**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\>

___

#### getTextSize

▸ **getTextSize**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>

___

#### getTextTransform

▸ **getTextTransform**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"none"`` \| ``"uppercase"`` \| ``"lowercase"``\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"none"`` \| ``"uppercase"`` \| ``"lowercase"``\>

___

#### getTextTranslate

▸ **getTextTranslate**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>

___

#### getTextTranslateAnchor

▸ **getTextTranslateAnchor**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>

___

#### getTextVariableAnchor

▸ **getTextVariableAnchor**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*Anchor*](#anchor)[]\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*Anchor*](#anchor)[]\>

___

#### getTextWritingMode

▸ **getTextWritingMode**(): [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<(``"vertical"`` \| ``"horizontal"``)[]\>

**Returns:** [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<(``"vertical"`` \| ``"horizontal"``)[]\>

___

#### hide

▸ **hide**(): *void*

使给定的图层不可见。

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### hoverFeatureState

▸ **hoverFeatureState**(`enterCb?`: (`arg0`: {}) => *void*, `leaveCb?`: (`arg0`: {}) => *void*): *void*

每当将鼠标悬停在这些图层中的某个特征上时，更新连接源 [s] 中特征的特征状态。

##### Parameters

| Name | Type |
| :------ | :------ |
| `enterCb?` | (`arg0`: {}) => *void* |
| `leaveCb?` | (`arg0`: {}) => *void* |

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### hoverLayer

▸ **hoverLayer**(`cb`: *any*): *any*

当鼠标悬停在这些图层中的要素上时触发回调。

##### Parameters

| Name | Type |
| :------ | :------ |
| `cb` | *any* |

**Returns:** *any*

A function to remove the handler.

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### hoverPointer

▸ **hoverPointer**(): *void*

每当鼠标悬停在这些图层上时，将地图的光标设置为“指针”。

**Returns:** *void*

A function to remove the handler.

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### 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](#classesdefaultoverlaylayerbasemd)

___

#### remove

▸ **remove**(): *void*

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### setData

▸ **setData**(`data`: *any*): *void*

替换 GeoJSON 图层的当前数据。

##### Parameters

| Name | Type |
| :------ | :------ |
| `data` | *any* |

**Returns:** *void*

___

#### setFilter

▸ **setFilter**(`filter`: [*FilterSpecification*](#filterspecification)): *void*

替换一个图层的过滤器。

**`example`** setFilter(['==','level','0']]);

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `filter` | [*FilterSpecification*](#filterspecification) | New filter to set. |

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### setIconAllowOverlap

▸ **setIconAllowOverlap**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconAnchor

▸ **setIconAnchor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*Anchor*](#anchor)\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*Anchor*](#anchor)\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconColor

▸ **setIconColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconHaloBlur

▸ **setIconHaloBlur**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconHaloColor

▸ **setIconHaloColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconHaloWidth

▸ **setIconHaloWidth**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconIgnorePlacement

▸ **setIconIgnorePlacement**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconImage

▸ **setIconImage**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconKeepUpright

▸ **setIconKeepUpright**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconOffset

▸ **setIconOffset**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*number*, *number*]\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*number*, *number*]\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconOpacity

▸ **setIconOpacity**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconOptional

▸ **setIconOptional**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconPadding

▸ **setIconPadding**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconPitchAlignment

▸ **setIconPitchAlignment**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconRotate

▸ **setIconRotate**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconRotationAlignment

▸ **setIconRotationAlignment**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconSize

▸ **setIconSize**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconTextFit

▸ **setIconTextFit**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"none"`` \| ``"width"`` \| ``"height"`` \| ``"both"``\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"none"`` \| ``"width"`` \| ``"height"`` \| ``"both"``\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconTextFitPadding

▸ **setIconTextFitPadding**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*, *number*, *number*]\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*, *number*, *number*]\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconTranslate

▸ **setIconTranslate**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setIconTranslateAnchor

▸ **setIconTranslateAnchor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setLayerStyle

▸ **setLayerStyle**(`style`: *any*): *void*

设置图层样式

##### Parameters

| Name | Type |
| :------ | :------ |
| `style` | *any* |

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### 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](#classesdefaultoverlaylayerbasemd)

___

#### setSymbolAvoidEdges

▸ **setSymbolAvoidEdges**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setSymbolPlacement

▸ **setSymbolPlacement**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"line"`` \| ``"point"`` \| ``"line-center"``\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"line"`` \| ``"point"`` \| ``"line-center"``\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setSymbolSortKey

▸ **setSymbolSortKey**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setSymbolSpacing

▸ **setSymbolSpacing**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setSymbolZOrder

▸ **setSymbolZOrder**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"source"`` \| ``"auto"`` \| ``"viewport-y"``\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"source"`` \| ``"auto"`` \| ``"viewport-y"``\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextAllowOverlap

▸ **setTextAllowOverlap**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextAnchor

▸ **setTextAnchor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*Anchor*](#anchor)\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*Anchor*](#anchor)\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextColor

▸ **setTextColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextField

▸ **setTextField**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextFont

▸ **setTextFont**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string[]\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string[]\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextHaloBlur

▸ **setTextHaloBlur**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextHaloColor

▸ **setTextHaloColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextHaloWidth

▸ **setTextHaloWidth**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextIgnorePlacement

▸ **setTextIgnorePlacement**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextJustify

▸ **setTextJustify**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"center"`` \| ``"left"`` \| ``"right"`` \| ``"auto"``\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"center"`` \| ``"left"`` \| ``"right"`` \| ``"auto"``\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextKeepUpright

▸ **setTextKeepUpright**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextLetterSpacing

▸ **setTextLetterSpacing**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextLineHeight

▸ **setTextLineHeight**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextMaxAngle

▸ **setTextMaxAngle**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextMaxWidth

▸ **setTextMaxWidth**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextOffset

▸ **setTextOffset**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*number*, *number*]\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<[*number*, *number*]\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextOpacity

▸ **setTextOpacity**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextOptional

▸ **setTextOptional**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<boolean\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextPadding

▸ **setTextPadding**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextPitchAlignment

▸ **setTextPitchAlignment**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextRadialOffset

▸ **setTextRadialOffset**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextRotate

▸ **setTextRotate**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextRotationAlignment

▸ **setTextRotationAlignment**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"`` \| ``"auto"``\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextSize

▸ **setTextSize**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextTransform

▸ **setTextTransform**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"none"`` \| ``"uppercase"`` \| ``"lowercase"``\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"none"`` \| ``"uppercase"`` \| ``"lowercase"``\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextTranslate

▸ **setTextTranslate**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextTranslateAnchor

▸ **setTextTranslateAnchor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextVariableAnchor

▸ **setTextVariableAnchor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*Anchor*](#anchor)[]\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*Anchor*](#anchor)[]\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### setTextWritingMode

▸ **setTextWritingMode**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<(``"vertical"`` \| ``"horizontal"``)[]\>): [*Symbol*](#classesdefaultsymbolmd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<(``"vertical"`` \| ``"horizontal"``)[]\> |

**Returns:** [*Symbol*](#classesdefaultsymbolmd)

___

#### show

▸ **show**(): *void*

使给定的图层可见。

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### toggle

▸ **toggle**(`state`: *boolean*): *boolean*

根据参数使给定的图层隐藏或可见。

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `state` | *boolean* | True for visible, false for hidden. |

**Returns:** *boolean*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)


<a name="classestextmd"></a>

[vjmap](#readmemd) / [Exports](#modulesmd) / Text