Class TextPathMarker

constructor

• new TextPathMarker(textPathMarkerOption): TextPathMarker

• Parameters

  • textPathMarkerOption: ITextPathMarkerOption

  Returns TextPathMarker

uuid

type

eventListener

isDestroyed

typeName

• get typeName(): string

• Returns string

visible

• get visible(): boolean

• 获取显示状态

  Returns boolean

  Since

  1.0.0

• set visible(val): void

• 设置显示状态

  Parameters

  • val: boolean

  Returns void

  Since

  1.0.0

zIndex

• get zIndex(): number

• 获取覆盖物显示层级

  Returns number

  Since

  1.0.0

• set zIndex(val): void

• 设置覆盖物显示层级

  Parameters

  • val: number

  Returns void

  Since

  1.0.0

Static putPointsInfoIntoBundle

• putPointsInfoIntoBundle(points, b): void

• Parameters

  • points: LatLng[]
  • b: undefined

  Returns void

addEventListener

• addEventListener(model, fun): void

• Parameters

  • model: OverlayEvent
  • fun: Function

  Returns void

  Since

  1.0.1

  History

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

removeEventListener

• removeEventListener(model, fun): void

• Parameters

  • model: OverlayEvent
  • fun: Function

  Returns void

  Since

  1.0.1

  History

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

addDragListener

• addDragListener(listener): void

• 添加拖拽监听器，当前仅支持Marker、Label

  Parameters

  • listener: OverlayDragListener

  Returns void

  Since

  2.0.3

removeDragListener

• removeDragListener(): void

• 移除拖拽监听器

  Returns void

  Since

  2.0.3

getDragListener

• getDragListener(): Maybe<OverlayDragListener>

• 获取拖拽监听器

  Returns Maybe<OverlayDragListener>

  Since

  2.0.3

fireEvent

• fireEvent(model, content): void

• Parameters

  • model: OverlayEvent
  • content: EventOverlayBundle

  Returns void

getType

• getType(): default

• Returns default

setAnimation

• setAnimation(animation): void

• Parameters

  • animation: Animation

  Returns void

getAnimation

• getAnimation(): Maybe<Animation>

• Returns Maybe<Animation>

setVisible

• setVisible(val): void

• 设置显示状态

  Parameters

  • val: boolean

  Returns void

  Since

  1.0.0

getVisible

• getVisible(): boolean

• 获取显示状态

  Returns boolean

  Since

  1.0.0

alpha

• alpha(alpha): TextPathMarker

• 设置透明度

  Parameters

  • alpha: number

    取值范围[0,1]

  Returns TextPathMarker

  Since

  1.0.0

getAlpha

• getAlpha(): number

• 获取透明度

  Returns number

  Since

  1.0.0

setAlpha

• setAlpha(alpha): void

• 设置透明度

  Parameters

  • alpha: number

    取值范围[0,1]

  Returns void

  Since

  1.0.0

startLevel

• startLevel(startLevel): TextPathMarker

• 设置覆盖物开始显示的地图缩放层级

  Parameters

  • startLevel: number

  Returns TextPathMarker

  Since

  1.0.0

getStartLevel

• getStartLevel(): number

• 获取覆盖物开始显示的地图缩放层级

  Returns number

  Since

  1.0.0

setStartLevel

• setStartLevel(startLevel): void

• 设置覆盖物开始显示的地图缩放层级

  Parameters

  • startLevel: number

  Returns void

  Since

  1.0.0

endLevel

• endLevel(endLevel): TextPathMarker

• 设置覆盖物结束显示的地图缩放层级

  Parameters

  • endLevel: number

  Returns TextPathMarker

  Since

  1.0.0

showLevel

• showLevel(from, to): void

• Parameters

  • from: number
  • to: number

  Returns void

getEndLevel

• getEndLevel(): number

• 获取marker结束显示的地图缩放层级

  Returns number

  Since

  1.0.0

setShowLevel

• setShowLevel(from, to): void

• Parameters

  • from: number
  • to: number

  Returns void

setEndLevel

• setEndLevel(endLevel): void

• 设置覆盖物结束显示的地图缩放层级

  Parameters

  • endLevel: number

  Returns void

  Since

  1.0.0

clickable

• clickable(isClickable): TextPathMarker

• 设置是否可点击

  Parameters

  • isClickable: boolean

  Returns TextPathMarker

  Since

  1.0.0

getClickable

• getClickable(): boolean

• 获取是否可点击状态

  Returns boolean

  Since

  1.0.0

setClickable

• setClickable(isClickable): void

• 设置是否可点击

  Parameters

  • isClickable: boolean

  Returns void

  Since

  1.0.0

setZIndex

• setZIndex(val): void

• 设置覆盖物显示层级

  Parameters

  • val: number

  Returns void

  Since

  1.0.0

getZIndex

• getZIndex(): number

• 获取覆盖物显示层级

  Returns number

  Since

  1.0.0

setExtraInfo

• setExtraInfo(extraInfo): void

• 设置覆盖物属性数据

  Parameters

  • extraInfo: AnyObject

  Returns void

  Since

  1.0.0

getExtraInfo

• getExtraInfo(): AnyObject

• 获取覆盖物属性数据

  Returns AnyObject

  Since

  1.0.0

getBmDrawItem

• getBmDrawItem(): undefined | default

• Returns undefined | default

update

• update(): void

• Returns void

remove

• remove(noUpdate?): void

• 移除覆盖物

  Parameters

  • Optional noUpdate: boolean

  Returns void

  Since

  1.0.0

isRemoved

• isRemoved(): undefined | boolean

• 获取是否移除状态

  Returns undefined | boolean

  Since

  1.0.0

destroy

• destroy(): void

• 仅适用用户主动触发的销毁

  Returns void

setText

• setText(text): void

• 设置路名

  Parameters

  • text: string

    路名字符串

  Returns void

setTextColor

• setTextColor(argb): void

• 设置文字颜色（ARGB 格式）

  Parameters

  • argb: ColorString

    颜色值（如 0xFF0000FF 表示蓝色）

  Returns void

getTextColor

• getTextColor(): number

• 获取文字颜色

  Returns number

  文字颜色（ARGB 格式）

setTextSize

• setTextSize(size): void

• 设置文字大小

  Parameters

  • size: number

    文字大小（单位：px）

  Returns void

getTextSize

• getTextSize(): number

• 获取文字大小

  Returns number

  文字大小（px）

setTextBorderColor

• setTextBorderColor(argb): void

• 设置文字描边颜色

  Parameters

  • argb: ColorString

    描边颜色（ARGB 格式）

  Returns void

getTextBorderColor

• getTextBorderColor(): number

• 获取文字描边颜色

  Returns number

  描边颜色（ARGB 格式）

setTextBorderWidth

• setTextBorderWidth(width): void

• 设置文字描边宽度

  Parameters

  • width: number

    描边宽度（px）

  Returns void

getTextBorderWidth

• getTextBorderWidth(): number

• 获取文字描边宽度

  Returns number

  描边宽度（px）

setTextFontOption

• setTextFontOption(option): void

• 设置字体格式

  Parameters

  • option: number

  Returns void

getTextFontOption

• getTextFontOption(): number

• 获取字体格式

  Returns number

  number

getText

• getText(): string

• 获取路名

  Returns string

  路名字符串

setPoints

• setPoints(points): void

• 设置展示路名的道路坐标点（需至少 2 个点）

  Parameters

  • points: LatLng[]

    经纬度坐标列表

  Returns void

getPoints

• getPoints(): null | LatLng[]

• 获取道路坐标点列表

  Returns null | LatLng[]

  经纬度坐标列表（可能为 null）

toDrawItem

• toDrawItem(): null | default

• 转换为绘制项（BmDrawItem）

  Returns null | default

  绘制项（null 表示无效）

toString

• toString(): string

• Returns string

  Since

  2.0.0