Class Overlay

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

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'

getType

• getType(): number

• Returns number

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): Overlay

• 设置透明度

  Parameters

  • alpha: number

    取值范围[0,1]

  Returns Overlay

  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): Overlay

• 设置marker开始显示的地图缩放层级

  Parameters

  • startLevel: number

  Returns Overlay

  Since

  1.0.0

getStartLevel

• getStartLevel(): number

• 获取marker开始显示的地图缩放层级

  Returns number

  Since

  1.0.0

setStartLevel

• setStartLevel(startLevel): void

• 设置marker开始显示的地图缩放层级

  Parameters

  • startLevel: number

  Returns void

  Since

  1.0.0

endLevel

• endLevel(endLevel): Overlay

• 设置marker结束显示的地图缩放层级

  Parameters

  • endLevel: number

  Returns Overlay

  Since

  1.0.0

getEndLevel

• getEndLevel(): number

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

  Returns number

  Since

  1.0.0

setEndLevel

• setEndLevel(endLevel): void

• 设置marker结束显示的地图缩放层级

  Parameters

  • endLevel: number

  Returns void

  Since

  1.0.0

clickable

• clickable(isClickable): Overlay

• 设置是否可点击

  Parameters

  • isClickable: boolean

  Returns Overlay

  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

update

• update(): void

• Returns void

remove

• remove(noUpdate?): void

• 移除覆盖物

  Parameters

  • Optional noUpdate: boolean

  Returns void

  Since

  1.0.0

isRemoved

• isRemoved(): boolean

• 获取是否移除状态

  Returns boolean

  Since

  1.0.0

destroy

• destroy(): void

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

  Returns void

toBundle

• toBundle(overlayMgr?): Promise<default>

• Parameters

  • Optional overlayMgr: default

  Returns Promise<default>

toString

• toString(): string

• Returns string