Class OverlayLayer

覆盖物图层

Abstract

由地图内部创建生成，提供覆盖物图层操作方法

Since

1.0.0

Author

dongshuifeng

Package

@bdmap/map

Hierarchy

  • default
    • OverlayLayer

Accessors

visible

Methods

setName getName getLayerId update setData getData addOverlay removeOverlay removeOverlays getOverlays layerCommit getCommitStatus pauseCommit resumeCommit setVisible clear hasOverlay destroy

Accessors

visible

  • get visible(): boolean

  • 获取图层当前状态

    Returns boolean

    Since

    1.0.0

  • set visible(val): void

  • 设置图层当前状态

    Parameters

    • val: boolean

    Returns void

    Since

    1.0.0

Methods

setName

  • setName(name): void

  • Parameters

    • name: string

    Returns void

getName

  • getName(): string

  • Returns string

getLayerId

  • getLayerId(): number

  • Returns number

update

  • update(): void

  • 主动调用绘制一次图层数据

    Returns void

setData

  • setData(strJson): void

  • Parameters

    • strJson: string

    Returns void

getData

  • getData(): string

  • Returns string

addOverlay

  • addOverlay(o): void

  • 添加地图覆盖物

    Parameters

    Returns void

    Since

    1.0.0

removeOverlay

  • removeOverlay(overlay, noCommit?): void

  • 移除地图覆盖物

    Parameters

    • overlay: Overlay

      覆盖物对象

    • Optional noCommit: boolean

    Returns void

    Since

    1.0.0

removeOverlays

  • removeOverlays(type?): void

  • 按类型移除地图覆盖物

    Parameters

    Returns void

    Since

    1.0.0

getOverlays

  • getOverlays(type?): Overlay[]

  • 获取图层覆盖物集合

    Parameters

    Returns Overlay[]

    Since

    2.0.3

layerCommit

  • layerCommit(): void

  • 更新图层数据渲染

    Returns void

    Since

    1.2.3

getCommitStatus

  • getCommitStatus(): boolean

  • 获取可主动更新数据渲染的状态

    Returns boolean

    Since

    1.2.3

pauseCommit

  • pauseCommit(): void

  • 暂停主动提交数据渲染更新的状态

    Returns void

    Since

    1.2.3

resumeCommit

  • resumeCommit(): void

  • 恢复主动提交数据渲染更新的状态，并主动触发一次layerCommit

    Returns void

    Since

    1.2.3

setVisible

  • setVisible(visible): void

  • 设置图层当前状态

    Parameters

    • visible: boolean

    Returns void

    Since

    1.0.0

clear

  • clear(model?, o?, noUpdate?): void

  • Parameters

    Returns void

hasOverlay

  • hasOverlay(o): boolean

  • Parameters

    Returns boolean

destroy

  • destroy(): void

  • Returns void

Settings

Theme

On This Page

visiblesetNamegetNamegetLayerIdupdatesetDatagetDataaddOverlayremoveOverlayremoveOverlaysgetOverlayslayerCommitgetCommitStatuspauseCommitresumeCommitsetVisibleclearhasOverlaydestroy