# Class: Polyline

创建多段线.

# Hierarchy

# Table of contents

# Constructors

# Properties

# Methods

# Constructors

# constructor

+ new Polyline(options: PolylineOptions): Polyline

# Parameters
Name Type
options PolylineOptions

Returns: Polyline

Overrides: OverlayLayerBase

# Properties

# _map

Optional _map: Map

Inherited from: OverlayLayerBase._map


# layerId

Optional layerId: string

Inherited from: OverlayLayerBase.layerId


# options

options: PolylineOptions


# 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


# getLayerId

getLayerId(): undefined | string

获取图层ID

Returns: undefined | string

Inherited from: OverlayLayerBase


# getLayerStyle

getLayerStyle(): LayerSpecification

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

Returns: LayerSpecification

Inherited from: OverlayLayerBase


# getLineBlur

getLineBlur(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>


# getLineCap

getLineCap(): DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">


# getLineColor

getLineColor(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>


# getLineDasharray

getLineDasharray(): DataDrivenPropertyValueSpecification<number[]>

Returns: DataDrivenPropertyValueSpecification<number[]>


# getLineGapWidth

getLineGapWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>


# getLineGradient

getLineGradient(): ExpressionSpecificationEx

Returns: ExpressionSpecificationEx


# getLineJoin

getLineJoin(): DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">


# getLineMiterMimit

getLineMiterMimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>


# getLineOffset

getLineOffset(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>


# getLineOpacity

getLineOpacity(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>


# getLinePattern

getLinePattern(): DataDrivenPropertyValueSpecification<string>

Returns: DataDrivenPropertyValueSpecification<string>


# getLineRoundLimit

getLineRoundLimit(): PropertyValueSpecificationEx<number>

Returns: PropertyValueSpecificationEx<number>


# getLineSortKey

getLineSortKey(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>


# getLineTranslate

getLineTranslate(): PropertyValueSpecificationEx<[number, number]>

Returns: PropertyValueSpecificationEx<[number, number]>


# getLineTranslateAnchor

getLineTranslateAnchor(): PropertyValueSpecificationEx<"map" | "viewport">

Returns: PropertyValueSpecificationEx<"map" | "viewport">


# getLineWidth

getLineWidth(): DataDrivenPropertyValueSpecification<number>

Returns: DataDrivenPropertyValueSpecification<number>


# getSourceId

getSourceId(): undefined | string

获取数据源ID

Returns: undefined | string

Inherited from: OverlayLayerBase


# 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


# setLayerStyle

setLayerStyle(style: any): void

设置图层样式

# Parameters
Name Type
style any

Returns: void

Inherited from: OverlayLayerBase


# setLineBlur

setLineBlur(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline


# setLineCap

setLineCap(value: DataDrivenPropertyValueSpecification<"butt" | "round" | "square">): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"butt" | "round" | "square">

Returns: Polyline


# setLineColor

setLineColor(value: DataDrivenPropertyValueSpecification<string>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polyline


# setLineDasharray

setLineDasharray(value: DataDrivenPropertyValueSpecification<number[]>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number[]>

Returns: Polyline


# setLineGapWidth

setLineGapWidth(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline


# setLineGradient

setLineGradient(value: ExpressionSpecificationEx): Polyline

# Parameters
Name Type
value ExpressionSpecificationEx

Returns: Polyline


# setLineJoin

setLineJoin(value: DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<"round" | "bevel" | "miter">

Returns: Polyline


# setLineMiterMimit

setLineMiterMimit(value: PropertyValueSpecificationEx<number>): Polyline

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Polyline


# setLineOffset

setLineOffset(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline


# setLineOpacity

setLineOpacity(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline


# setLinePattern

setLinePattern(value: DataDrivenPropertyValueSpecification<string>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<string>

Returns: Polyline


# setLineRoundLimit

setLineRoundLimit(value: PropertyValueSpecificationEx<number>): Polyline

# Parameters
Name Type
value PropertyValueSpecificationEx<number>

Returns: Polyline


# setLineSortKey

setLineSortKey(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline


# setLineTranslate

setLineTranslate(value: PropertyValueSpecificationEx<[number, number]>): Polyline

# Parameters
Name Type
value PropertyValueSpecificationEx<[number, number]>

Returns: Polyline


# setLineTranslateAnchor

setLineTranslateAnchor(value: PropertyValueSpecificationEx<"map" | "viewport">): Polyline

# Parameters
Name Type
value PropertyValueSpecificationEx<"map" | "viewport">

Returns: Polyline


# setLineWidth

setLineWidth(value: DataDrivenPropertyValueSpecification<number>): Polyline

# Parameters
Name Type
value DataDrivenPropertyValueSpecification<number>

Returns: Polyline


# 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


# 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

vjmap / Exports / PolylineArrow