---
title: Class: Polyline
source: https://vjmap.com/doc/Class_Polyline.html
---

# Class: Polyline

创建多段线.

### Hierarchy

- [*OverlayLayerBase*](#classesdefaultoverlaylayerbasemd)

  ↳ **Polyline**

### Table of contents

#### Constructors

- [constructor](#constructor)

#### Properties

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

#### Methods

- [addTo](#addto)
- [clickLayer](#clicklayer)
- [clickPopup](#clickpopup)
- [getData](#getdata)
- [getLayerId](#getlayerid)
- [getLayerStyle](#getlayerstyle)
- [getLineBlur](#getlineblur)
- [getLineCap](#getlinecap)
- [getLineColor](#getlinecolor)
- [getLineDasharray](#getlinedasharray)
- [getLineGapWidth](#getlinegapwidth)
- [getLineGradient](#getlinegradient)
- [getLineJoin](#getlinejoin)
- [getLineMiterMimit](#getlinemitermimit)
- [getLineOffset](#getlineoffset)
- [getLineOpacity](#getlineopacity)
- [getLinePattern](#getlinepattern)
- [getLineRoundLimit](#getlineroundlimit)
- [getLineSortKey](#getlinesortkey)
- [getLineTranslate](#getlinetranslate)
- [getLineTranslateAnchor](#getlinetranslateanchor)
- [getLineWidth](#getlinewidth)
- [getSourceId](#getsourceid)
- [hide](#hide)
- [hoverFeatureState](#hoverfeaturestate)
- [hoverLayer](#hoverlayer)
- [hoverPointer](#hoverpointer)
- [hoverPopup](#hoverpopup)
- [remove](#remove)
- [setData](#setdata)
- [setFilter](#setfilter)
- [setLayerStyle](#setlayerstyle)
- [setLineBlur](#setlineblur)
- [setLineCap](#setlinecap)
- [setLineColor](#setlinecolor)
- [setLineDasharray](#setlinedasharray)
- [setLineGapWidth](#setlinegapwidth)
- [setLineGradient](#setlinegradient)
- [setLineJoin](#setlinejoin)
- [setLineMiterMimit](#setlinemitermimit)
- [setLineOffset](#setlineoffset)
- [setLineOpacity](#setlineopacity)
- [setLinePattern](#setlinepattern)
- [setLineRoundLimit](#setlineroundlimit)
- [setLineSortKey](#setlinesortkey)
- [setLineTranslate](#setlinetranslate)
- [setLineTranslateAnchor](#setlinetranslateanchor)
- [setLineWidth](#setlinewidth)
- [setProperty](#setproperty)
- [show](#show)
- [toggle](#toggle)

### Constructors

#### constructor

\+ **new Polyline**(`options`: [*PolylineOptions*](#interfacesdefaultpolylineoptionsmd)): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `options` | [*PolylineOptions*](#interfacesdefaultpolylineoptionsmd) |

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

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**: [*PolylineOptions*](#interfacesdefaultpolylineoptionsmd)

___

#### 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)

___

#### getLayerId

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

获取图层ID

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

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### getLayerStyle

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

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

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

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### getLineBlur

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

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

___

#### getLineCap

▸ **getLineCap**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"butt"`` \| ``"round"`` \| ``"square"``\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"butt"`` \| ``"round"`` \| ``"square"``\>

___

#### getLineColor

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

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

___

#### getLineDasharray

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

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

___

#### getLineGapWidth

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

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

___

#### getLineGradient

▸ **getLineGradient**(): [*ExpressionSpecificationEx*](#expressionspecificationex)

**Returns:** [*ExpressionSpecificationEx*](#expressionspecificationex)

___

#### getLineJoin

▸ **getLineJoin**(): [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"round"`` \| ``"bevel"`` \| ``"miter"``\>

**Returns:** [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"round"`` \| ``"bevel"`` \| ``"miter"``\>

___

#### getLineMiterMimit

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

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

___

#### getLineOffset

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

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

___

#### getLineOpacity

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

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

___

#### getLinePattern

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

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

___

#### getLineRoundLimit

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

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

___

#### getLineSortKey

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

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

___

#### getLineTranslate

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

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

___

#### getLineTranslateAnchor

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

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

___

#### getLineWidth

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

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

___

#### getSourceId

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

获取数据源ID

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

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### 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)

___

#### setLayerStyle

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

设置图层样式

##### Parameters

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

**Returns:** *void*

Inherited from: [OverlayLayerBase](#classesdefaultoverlaylayerbasemd)

___

#### setLineBlur

▸ **setLineBlur**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineCap

▸ **setLineCap**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"butt"`` \| ``"round"`` \| ``"square"``\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"butt"`` \| ``"round"`` \| ``"square"``\> |

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineColor

▸ **setLineColor**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineDasharray

▸ **setLineDasharray**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number[]\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineGapWidth

▸ **setLineGapWidth**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineGradient

▸ **setLineGradient**(`value`: [*ExpressionSpecificationEx*](#expressionspecificationex)): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*ExpressionSpecificationEx*](#expressionspecificationex) |

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineJoin

▸ **setLineJoin**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"round"`` \| ``"bevel"`` \| ``"miter"``\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<``"round"`` \| ``"bevel"`` \| ``"miter"``\> |

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineMiterMimit

▸ **setLineMiterMimit**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineOffset

▸ **setLineOffset**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineOpacity

▸ **setLineOpacity**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLinePattern

▸ **setLinePattern**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<string\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineRoundLimit

▸ **setLineRoundLimit**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<number\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineSortKey

▸ **setLineSortKey**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineTranslate

▸ **setLineTranslate**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<[*number*, *number*]\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineTranslateAnchor

▸ **setLineTranslateAnchor**(`value`: [*PropertyValueSpecificationEx*](#propertyvaluespecificationex)<``"map"`` \| ``"viewport"``\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### setLineWidth

▸ **setLineWidth**(`value`: [*DataDrivenPropertyValueSpecification*](#datadrivenpropertyvaluespecification)<number\>): [*Polyline*](#classesdefaultpolylinemd)

##### Parameters

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

**Returns:** [*Polyline*](#classesdefaultpolylinemd)

___

#### 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)

___

#### 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="classespolylinearrowmd"></a>

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