Class Polyline

Polyline覆盖物

Abstract

提供Polyline覆盖物创建、操作方法

Since

1.0.0

Package

@bdmap/map

Hierarchy (view full)

Overlay
- Polyline

Index

Constructors

constructor

new Polyline(opts?): Polyline

构造函数，默认参数

{
points: [],
width: 20;
textures: [],
join: SysEnum.LineJoinType.BEVEL,
cap: SysEnum.LineCapType.BUTT,
isGeodesic: false,
directionCross180: SysEnum.LineDirectionCross.NONE;,
fillcolor: 'rgba(255, 235, 59 ,0.7)',
isThined: false,
dottedline: false,
dottedlineType: SysEnum.PolylineDottedLineType.DOTTED_LINE_SQUARE
}

Parameters

Optional opts: Nullable<IPolylineOption>

Returns Polyline

Properties

uuid

uuid: string

type

type: default

eventListener

eventListener: TOverlayListener = {}

isDestroyed

isDestroyed: boolean = false

Accessors

visible

get visible(): boolean
获取显示状态

Returns boolean
Since
1.0.0

Inherited from Overlay.visible
set visible(val): void
设置显示状态
Parameters
- val: boolean
Returns void
Since
1.0.0

Inherited from Overlay.visible

zIndex

get zIndex(): number
获取覆盖物显示层级

Returns number
Since
1.0.0

Inherited from Overlay.zIndex
set zIndex(val): void
设置覆盖物显示层级
Parameters
- val: number
Returns void
Since
1.0.0

Inherited from Overlay.zIndex

typeName

get typeName(): string
Returns string
Overrides Overlay.typeName

Methods

`Static` putPointsInfoIntoBundle

putPointsInfoIntoBundle(points, b): void
Parameters
- points: LatLng[]
- b: undefined
Returns void
Inherited from Overlay.putPointsInfoIntoBundle

addEventListener

addEventListener(model, fun): void
Parameters
- model: OverlayEvent
- fun: Function
Returns void
Since
1.0.1

History
包1.0.0 版本中 model:string , 取值范围 'CLICK'、'TOUCH'

Inherited from Overlay.addEventListener

removeEventListener

removeEventListener(model, fun): void
Parameters
- model: OverlayEvent
- fun: Function
Returns void
Since
1.0.1

History
包1.0.0 版本中 model:string , 取值范围 'CLICK'、'TOUCH'

Inherited from Overlay.removeEventListener

addDragListener

addDragListener(listener): void
添加拖拽监听器，当前仅支持Marker、Label
Parameters
- listener: OverlayDragListener
Returns void
Since
2.0.3

Inherited from Overlay.addDragListener

removeDragListener

removeDragListener(): void
移除拖拽监听器

Returns void
Since
2.0.3

Inherited from Overlay.removeDragListener

getDragListener

getDragListener(): Maybe<OverlayDragListener>
获取拖拽监听器

Returns Maybe<OverlayDragListener>
Since
2.0.3

Inherited from Overlay.getDragListener

fireEvent

fireEvent(model, content): void
Parameters
- model: OverlayEvent
- content: EventOverlayBundle
Returns void
Inherited from Overlay.fireEvent

getType

getType(): default
Returns default
Inherited from Overlay.getType

setAnimation

setAnimation(animation): void
Parameters
- animation: Animation
Returns void
Inherited from Overlay.setAnimation

getAnimation

getAnimation(): Maybe<Animation>
Returns Maybe<Animation>
Inherited from Overlay.getAnimation

setVisible

setVisible(val): void
设置显示状态
Parameters
- val: boolean
Returns void
Since
1.0.0

Inherited from Overlay.setVisible

getVisible

getVisible(): boolean
获取显示状态

Returns boolean
Since
1.0.0

Inherited from Overlay.getVisible

alpha

alpha(alpha): Polyline
设置透明度
Parameters
- alpha: number
  取值范围[0,1]
Returns Polyline
Since
1.0.0

Inherited from Overlay.alpha

getAlpha

getAlpha(): number
获取透明度

Returns number
Since
1.0.0

Inherited from Overlay.getAlpha

setAlpha

setAlpha(alpha): void
设置透明度
Parameters
- alpha: number
  取值范围[0,1]
Returns void
Since
1.0.0

Inherited from Overlay.setAlpha

startLevel

startLevel(startLevel): Polyline
设置覆盖物开始显示的地图缩放层级
Parameters
- startLevel: number
Returns Polyline
Since
1.0.0

Inherited from Overlay.startLevel

getStartLevel

getStartLevel(): number
获取覆盖物开始显示的地图缩放层级

Returns number
Since
1.0.0

Inherited from Overlay.getStartLevel

setStartLevel

setStartLevel(startLevel): void
设置覆盖物开始显示的地图缩放层级
Parameters
- startLevel: number
Returns void
Since
1.0.0

Inherited from Overlay.setStartLevel

endLevel

endLevel(endLevel): Polyline
设置覆盖物结束显示的地图缩放层级
Parameters
- endLevel: number
Returns Polyline
Since
1.0.0

Inherited from Overlay.endLevel

showLevel

showLevel(from, to): void
Parameters
- from: number
- to: number
Returns void
Inherited from Overlay.showLevel

getEndLevel

getEndLevel(): number
获取marker结束显示的地图缩放层级

Returns number
Since
1.0.0

Inherited from Overlay.getEndLevel

setShowLevel

setShowLevel(from, to): void
Parameters
- from: number
- to: number
Returns void
Inherited from Overlay.setShowLevel

setEndLevel

setEndLevel(endLevel): void
设置覆盖物结束显示的地图缩放层级
Parameters
- endLevel: number
Returns void
Since
1.0.0

Inherited from Overlay.setEndLevel

clickable

clickable(isClickable): Polyline
设置是否可点击
Parameters
- isClickable: boolean
Returns Polyline
Since
1.0.0

Inherited from Overlay.clickable

getClickable

getClickable(): boolean
获取是否可点击状态

Returns boolean
Since
1.0.0

Inherited from Overlay.getClickable

setClickable

setClickable(isClickable): void
设置是否可点击
Parameters
- isClickable: boolean
Returns void
Since
1.0.0

Inherited from Overlay.setClickable

setZIndex

setZIndex(val): void
设置覆盖物显示层级
Parameters
- val: number
Returns void
Since
1.0.0

Inherited from Overlay.setZIndex

getZIndex

getZIndex(): number
获取覆盖物显示层级

Returns number
Since
1.0.0

Inherited from Overlay.getZIndex

setExtraInfo

setExtraInfo(extraInfo): void
设置覆盖物属性数据
Parameters
- extraInfo: AnyObject
Returns void
Since
1.0.0

Inherited from Overlay.setExtraInfo

getExtraInfo

getExtraInfo(): AnyObject
获取覆盖物属性数据

Returns AnyObject
Since
1.0.0

Inherited from Overlay.getExtraInfo

getBmDrawItem

getBmDrawItem(): undefined | default
Returns undefined | default
Inherited from Overlay.getBmDrawItem

update

update(): void
Returns void
Inherited from Overlay.update

remove

remove(noUpdate?): void
移除覆盖物
Parameters
- Optional noUpdate: boolean
Returns void
Since
1.0.0

Inherited from Overlay.remove

isRemoved

isRemoved(): undefined | boolean
获取是否移除状态

Returns undefined | boolean
Since
1.0.0

Inherited from Overlay.isRemoved

destroy

destroy(): void
仅适用用户主动触发的销毁

Returns void
Inherited from Overlay.destroy

setTrackForwardStyle

setTrackForwardStyle(forwardStyle): void
PolyLine有trackAnimation时，还未执行的进度，当前点前方的样式注：不适用于多纹理/多颜色线段绘制
Parameters
- forwardStyle: LineStyle
Returns void

setTrackBackwardStyle

setTrackBackwardStyle(backwardStyle): void
PolyLine有TrackAnimation时，已执行过的进度，当前点后方的样式注：不适用于多纹理/多颜色线段绘制
Parameters
- backwardStyle: LineStyle
Returns void

setTrackForwardStyles

setTrackForwardStyles(forwardStyles): void
PolyLine有trackAnimation时，还未执行的进度，当前点前方的样式注：仅适用于多纹理/多颜色的polyline，数组长度必须和纹理/颜色数组的长度相等
Parameters
- forwardStyles: LineStyle[]
Returns void

setTrackBackwardStyles

setTrackBackwardStyles(backwardStyles): void
PolyLine有trackAnimation时，还未执行的进度，当前点前方的样式注：仅适用于多纹理/多颜色的polyline，数组长度必须和纹理/颜色数组的长度相等
Parameters
- backwardStyles: LineStyle[]
Returns void

textureOption

textureOption(val): Polyline
设置纹理填充样式
Parameters
- val: TextureOption
Returns Polyline
Since
1.2.0

setTextureOption

setTextureOption(val): void
设置纹理填充样式
Parameters
- val: TextureOption
Returns void
Since
1.2.0

getTextureOption

getTextureOption(): TextureOption
获取纹理填充样式

Returns TextureOption
Since
1.2.0

getColor

getColor(): string
获取线颜色

Returns string
Since
1.0.0

color

color(color): Polyline
设置线颜色
Parameters
- color: ColorString
Returns Polyline
Since
1.0.0

setColor

setColor(color): void
设置线颜色
Parameters
- color: ColorString
Returns void
Since
1.0.0

getPoints

getPoints(): LatLng[]
获取线图形坐标点串

Returns LatLng[]
Since
1.0.0

points

points(points): Polyline
设置线图形坐标点串
Parameters
- points: LatLng[]
Returns Polyline
Since
1.0.0

setPoints

setPoints(points): void
设置线图形坐标点串
Parameters
- points: LatLng[]
Returns void
Since
1.0.0

getWidth

getWidth(): number
获取线宽

Returns number
Since
1.0.0

width

width(width): Polyline
设置线宽
Parameters
- width: number
Returns Polyline
Since
1.0.0

setWidth

setWidth(width): void
设置线宽
Parameters
- width: number
Returns void
Since
1.0.0

getStrokeWidth

getStrokeWidth(): number
获取描边线宽

Returns number
Since
1.2.0

strokeWidth

strokeWidth(width): Polyline
设置描边线宽
Parameters
- width: number
Returns Polyline
Since
1.2.0

setStrokeWidth

setStrokeWidth(width): void
设置描边线宽
Parameters
- width: number
Returns void
Since
1.2.0

getStrokeColor

getStrokeColor(): string
获取描边线颜色

Returns string
Since
1.2.0

strokeColor

strokeColor(color): Polyline
设置描边线颜色
Parameters
- color: ColorString
Returns Polyline
Since
1.2.0

setStrokeColor

setStrokeColor(color): void
设置描边线颜色
Parameters
- color: ColorString
Returns void
Since
1.2.0

getJoinType

getJoinType(): LineJoinType
获取线拐点类型

Returns LineJoinType
Since
1.0.0

joinType

joinType(type): Polyline
设置线拐点类型
Parameters
- type: LineJoinType
Returns Polyline
Since
1.0.0

setJoinType

setJoinType(type): void
设置线拐点类型
Parameters
- type: LineJoinType
Returns void
Since
1.0.0

getCapType

getCapType(): LineCapType
获取线端点样式类型

Returns LineCapType
Since
1.0.0

capType

capType(type): Polyline
设置线端点样式类型
Parameters
- type: LineCapType
Returns Polyline
Since
1.0.0

setCapType

setCapType(type): void
设置线端点样式类型
Parameters
- type: LineCapType
Returns void
Since
1.0.0

startCap

startCap(val): Polyline
Parameters
- val: LineCapType
Returns Polyline

setStartCap

setStartCap(val): void
Parameters
- val: LineCapType
Returns void

getStartCap

getStartCap(): LineCapType
Returns LineCapType

endCap

endCap(val): Polyline
Parameters
- val: LineCapType
Returns Polyline

setEndCap

setEndCap(val): void
Parameters
- val: LineCapType
Returns void

getEndCap

getEndCap(): LineCapType
Returns LineCapType

getIsThined

getIsThined(): boolean
获取是否启用抽稀

Returns boolean
Since
1.0.0

isThined

isThined(isThined): undefined | Polyline
设置是否启用抽稀
Parameters
- isThined: boolean
Returns undefined | Polyline
Since
1.0.0

setIsThined

setIsThined(isThined): void
设置是否启用抽稀
Parameters
- isThined: boolean
Returns void
Since
1.0.0

thinFactor

thinFactor(val): Polyline
设置抽稀容差值
Parameters
- val: number
Returns Polyline
Since
1.2.0

setThinFactor

setThinFactor(val): void
设置抽稀容差值
Parameters
- val: number
Returns void
Since
1.2.0

getThinFactor

getThinFactor(): number
获取抽稀容差值

Returns number
Since
1.2.0

collisionBehavior

collisionBehavior(behave): Polyline
Parameters
- behave: CollisionBehavior
Returns Polyline

setCollisionBehavior

setCollisionBehavior(behave): void
Parameters
- behave: CollisionBehavior
Returns void

getCollisionBehavior

getCollisionBehavior(): CollisionBehavior
Returns CollisionBehavior

getDirectionCross180

getDirectionCross180(): LineDirectionCross
获取是否启用跨越180度

Returns LineDirectionCross
Since
1.0.0

directionCross180

directionCross180(cross): Polyline
设置是否启用跨越180度
Parameters
- cross: LineDirectionCross
Returns Polyline
Since
1.0.0

setDirectionCross180

setDirectionCross180(cross): void
设置是否启用跨越180度
Parameters
- cross: LineDirectionCross
Returns void
Since
1.0.0

getGeodesic

getGeodesic(): boolean
获取是否启用绘制大地线

Returns boolean
Since
1.0.0

isGeodesic

isGeodesic(geodesic): Polyline
设置是否启用绘制大地线
Parameters
- geodesic: boolean
Returns Polyline
Since
1.0.0

setGeodesic

setGeodesic(geodesic): void
设置是否启用绘制大地线
Parameters
- geodesic: boolean
Returns void
Since
1.0.0

getIsDotted

getIsDotted(): boolean
获取是否启用虚线样式

Returns boolean
Since
1.0.0

isDottedline

isDottedline(dotted): undefined | Polyline
设置是否启用虚线样式
Parameters
- dotted: boolean
Returns undefined | Polyline
Since
1.0.0

setIsDottedline

setIsDottedline(dotted): void
设置是否启用虚线样式
Parameters
- dotted: boolean
Returns void
Since
1.0.0

getDottedLineType

getDottedLineType(): PolylineDottedLineType
获取虚线样式

Returns PolylineDottedLineType
Since
1.0.0

dottedLineType

dottedLineType(val): Polyline
设置虚线样式
Parameters
- val: PolylineDottedLineType
Returns Polyline
Since
1.0.0

setDottedLineType

setDottedLineType(val): void
设置虚线样式
Parameters
- val: PolylineDottedLineType
Returns void
Since
1.0.0

textures

textures(textures): Polyline
设置填充纹理
Parameters
- textures: ImageEntity[]
Returns Polyline
Since
1.0.0

getTextures

getTextures(): ImageEntity[]
获取填充纹理

Returns ImageEntity[]
Since
1.0.0

setTexture

setTexture(texture): void
设置填充纹理
Parameters
- texture: ImageEntity
Returns void
Since
1.0.0

setTextures

setTextures(textures): void
设置填充纹理
Parameters
- textures: ImageEntity[]
Returns void
Since
1.0.0

colorList

colorList(cList): undefined | Polyline
设置填充颜色列表
Parameters
- cList: ColorString[]
Returns undefined | Polyline
Since
1.1.0

setColorList

setColorList(cList): void
设置填充颜色列表
Parameters
- cList: ColorString[]
Returns void
Since
1.1.0

getColorList

getColorList(): string[]
获取填充颜色列表

Returns string[]
Since
1.1.0

indexList

indexList(iList): Polyline
设置多纹理的索引
Parameters
- iList: number[]
Returns Polyline
Since
1.1.0

setIndexList

setIndexList(iList): void
设置多纹理的索引
Parameters
- iList: number[]
Returns void
Since
1.1.0

getIndexList

getIndexList(): number[]
获取多纹理的索引

Returns number[]
Since
1.1.0

isGradient

isGradient(enable): undefined | Polyline
设置是否是渐变线
Parameters
- enable: boolean
Returns undefined | Polyline
Since
1.1.0

setIsGradient

setIsGradient(enable): void
设置是否是渐变线
Parameters
- enable: boolean
Returns void
Since
1.1.0

getIsGradient

getIsGradient(): boolean
是否是渐变线

Returns boolean
Since
1.1.0

lineBloomType

lineBloomType(type): Polyline
设置发光样式
Parameters
- type: ELineBloomType
Returns Polyline
Since
1.1.0

setLineBloomType

setLineBloomType(type): void
设置发光样式
Parameters
- type: ELineBloomType
Returns void
Since
1.1.0

getLineBloomType

getLineBloomType(): ELineBloomType
获取发光样式

Returns ELineBloomType
Since
1.1.0

lineBloomWidth

lineBloomWidth(bloomWidth): Polyline
设置发光线段的宽度宽度 >0
Parameters
- bloomWidth: number
Returns Polyline
Since
1.1.0

setLineBloomWidth

setLineBloomWidth(bloomWidth): void
设置发光线段的宽度宽度 >0
Parameters
- bloomWidth: number
Returns void
Since
1.1.0

getLineBloomWidth

getLineBloomWidth(): number
获取发光线段的宽度

Returns number
Since
1.1.0

lineBloomAlpha

lineBloomAlpha(bloomAlpha): void
设置发光线段的透明度
Parameters
- bloomAlpha: number
  取值范围0～1
Returns void
Since
1.1.0

setLineBloomAlpha

setLineBloomAlpha(bloomAlpha): void
设置发光线段的透明度
Parameters
- bloomAlpha: number
  取值范围0～1
Returns void
Since
1.1.0

getLineBloomAlpha

getLineBloomAlpha(): number
获取发光线段的透明度

Returns number
Since
1.1.0

lineBloomGradientASPeed

lineBloomGradientASPeed(speed): Polyline
设置透明度渐变发光效果的渐变速率
Parameters
- speed: number
  取值范围1.0 ~ 10.0
Returns Polyline
Since
1.1.0

setLineBloomGradientASPeed

setLineBloomGradientASPeed(speed): void
设置透明度渐变发光效果的渐变速率
Parameters
- speed: number
  取值范围1.0 ~ 10.0
Returns void
Since
1.1.0

getLineBloomGradientASPeed

getLineBloomGradientASPeed(): number
获取透明度渐变发光效果的渐变速率

Returns number
Since
1.1.0

lineBloomBlurTimes

lineBloomBlurTimes(times): Polyline
设置模糊发光效果的模糊次数
Parameters
- times: number
  取值范围 1~10
Returns Polyline
Since
1.1.0

setLineBloomBlurTimes

setLineBloomBlurTimes(times): void
设置模糊发光效果的模糊次数
Parameters
- times: number
  取值范围 1~10
Returns void
Since
1.1.0

getLineBloomBlurTimes

getLineBloomBlurTimes(): number
模糊发光效果的模糊次数

Returns number
Since
1.1.0

smooth

smooth(val): Polyline
设置平滑类型
Parameters
- val: SmoothType
Returns Polyline
Since
1.2.0

setSmooth

setSmooth(val): void
设置平滑类型
Parameters
- val: SmoothType
Returns void
Since
1.2.0

getSmooth

getSmooth(): ((val) => Polyline)
获取平滑类型

Returns ((val) => Polyline)
- - (val): Polyline
  - 设置平滑类型
    Parameters
    - val: SmoothType
    Returns Polyline
    Since
    1.2.0
Since
1.2.0

smoothFactor

smoothFactor(val): Polyline
设置平滑控制值
Parameters
- val: number
Returns Polyline
Since
1.2.0

setSmoothFactor

setSmoothFactor(val): void
设置平滑控制值
Parameters
- val: number
Returns void
Since
1.2.0

getSmoothFactor

getSmoothFactor(): number
获取平滑控制值

Returns number
Since
1.2.0

toString

toString(): string
Returns string
Since
1.0.1

Overrides Overlay.toString

Class Polyline

Abstract

Since

Package

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Polyline

Properties

uuid

type

eventListener

isDestroyed

Accessors

visible

Returns boolean

Since

Parameters

Returns void

Since

zIndex

Returns number

Since

Parameters

Returns void

Since

typeName

Returns string

Methods

Static putPointsInfoIntoBundle

Parameters

Returns void

addEventListener

Parameters

Returns void

Since

History

removeEventListener

Parameters

Returns void

Since

History

addDragListener

Parameters

Returns void

Since

removeDragListener

Returns void

Since

getDragListener

Returns Maybe<OverlayDragListener>

Since

fireEvent

Parameters

Returns void

getType

Returns default

setAnimation

Parameters

Returns void

getAnimation

Returns Maybe<Animation>

setVisible

Parameters

Returns void

Since

getVisible

Returns boolean

Since

alpha

Parameters

Returns Polyline

Since

getAlpha

`Static` putPointsInfoIntoBundle