m-gis核心库 v0.4.4

---

m-gis核心库 / HtmlLayer

类: HtmlLayer

定义于: layer/HtmlLayer.ts:13

继承

• Layer

构造函数

构造函数

new HtmlLayer(options?): HtmlLayer

定义于: layer/HtmlLayer.ts:16

参数

options?

OPT = {}

返回

HtmlLayer

重写了

Layer.constructor

属性

_attr

_attr: any

定义于: layer/Layer.ts:19

继承自

Layer._attr

---

_cache

_cache: any

定义于: layer/Layer.ts:18

继承自

Layer._cache

---

_delegate

_delegate: any

定义于: layer/Layer.ts:15

继承自

Layer._delegate

---

_enableZoomShow

_enableZoomShow: boolean

定义于: layer/Layer.ts:26

继承自

Layer._enableZoomShow

---

_id

_id: any

定义于: layer/Layer.ts:11

继承自

Layer._id

---

_layerEvent

_layerEvent: any

定义于: layer/Layer.ts:21

继承自

Layer._layerEvent

---

_layerOptions

_layerOptions: any

定义于: layer/Layer.ts:12

继承自

Layer._layerOptions

---

_name

_name: any

定义于: layer/Layer.ts:13

继承自

Layer._name

---

_renderRemoveCallback

_renderRemoveCallback: any

定义于: layer/HtmlLayer.ts:14

---

_show

_show: any

定义于: layer/Layer.ts:17

继承自

Layer._show

---

_state

_state: any

定义于: layer/Layer.ts:22

继承自

Layer._state

---

_style

_style: any

定义于: layer/Layer.ts:20

继承自

Layer._style

---

_viewer

_viewer: any

定义于: layer/Layer.ts:16

继承自

Layer._viewer

---

_zIndex

_zIndex: any

定义于: layer/Layer.ts:14

继承自

Layer._zIndex

---

maxZoom

maxZoom: any

定义于: layer/Layer.ts:25

继承自

Layer.maxZoom

---

minZoom

minZoom: any

定义于: layer/Layer.ts:24

继承自

Layer.minZoom

---

type

type: any

定义于: layer/Layer.ts:23

继承自

Layer.type

访问器

attr

Getter 签名

get attr(): any

定义于: layer/Layer.ts:105

返回

any

Setter 签名

set attr(attr): void

定义于: layer/Layer.ts:101

用于设置图层的一些额外属性

参数

attr

any

返回

void

继承自

WKTLayer.attr

---

delegate

Getter 签名

get delegate(): any

定义于: layer/Layer.ts:127

图层代理对象

返回

any

继承自

Layer.delegate

---

id

Getter 签名

get id(): any

定义于: layer/Layer.ts:118

图层唯一标识 id

返回

any

继承自

Layer.id

---

layerEvent

Getter 签名

get layerEvent(): any

定义于: layer/Layer.ts:93

图层事件对象

返回

any

继承自

Layer.layerEvent

---

layerOptions

Getter 签名

get layerOptions(): any

定义于: layer/Layer.ts:84

图层设置的参数对象

返回

any

继承自

Layer.layerOptions

---

name

Getter 签名

get name(): any

定义于: layer/Layer.ts:58

获取当前图层名称

返回

any

继承自

Layer.name

---

overlays

Getter 签名

get overlays(): Overlay[]

定义于: layer/Layer.ts:140

返回

Overlay[]

继承自

Layer.overlays

---

show

Getter 签名

get show(): boolean

定义于: layer/HtmlLayer.ts:36

图层是否可见

默认值

@public

返回

boolean

Setter 签名

set show(show): void

定义于: layer/HtmlLayer.ts:30

图层是否可见

默认值

@public

参数

show

boolean

返回

void

重写了

WKTLayer.show

---

state

Getter 签名

get state(): any

定义于: layer/Layer.ts:136

图层状态

返回

any

继承自

Layer.state

方法

_addedHook()

_addedHook(): void

定义于: layer/Layer.ts:144

返回

void

继承自

Layer._addedHook

---

_addHandler()

_addHandler(viewer): Promise<void>

定义于: layer/HtmlLayer.ts:40

参数

viewer

Viewer

返回

Promise<void>

重写了

Layer._addHandler

---

_addOverlay()

_addOverlay(overlay): void

定义于: layer/Layer.ts:223

参数

overlay

any

返回

void

继承自

Layer._addOverlay

---

_init()

_init(): void

定义于: layer/Layer.ts:182

返回

void

继承自

Layer._init

---

_removedHook()

_removedHook(): void

定义于: layer/Layer.ts:146

返回

void

继承自

Layer._removedHook

---

_removeHandler()

_removeHandler(): false | undefined

定义于: layer/HtmlLayer.ts:72

返回

false | undefined

重写了

Layer._removeHandler

---

_removeOverlay()

_removeOverlay(overlay): void

定义于: layer/Layer.ts:230

参数

overlay

Overlay | PrimitiveOverlay

返回

void

继承自

Layer._removeOverlay

---

addOverlay()

addOverlay(overlay): HtmlLayer

定义于: layer/Layer.ts:261

往图层上添加 overlay

参数

overlay

any

overlay

返回

HtmlLayer

Layer

继承自

Layer.addOverlay

---

addOverlays()

addOverlays(overlays): HtmlLayer

定义于: layer/Layer.ts:285

往图层上添加 overlay 的数组

参数

overlays

Overlay[]

overlay 数组

返回

HtmlLayer

Layer

继承自

Layer.addOverlays

---

addToViewer()

addToViewer(viewer): HtmlLayer

定义于: layer/Layer.ts:272

将图层添加到 Viewer

参数

viewer

Viewer

指定的 viewer

返回

HtmlLayer

Layer

继承自

Layer.addToViewer

---

clear()

clear(): HtmlLayer

定义于: layer/HtmlLayer.ts:84

清空图层

返回

HtmlLayer

---

eachOverlay()

eachOverlay(method, context): HtmlLayer

定义于: layer/Layer.ts:364

遍历每个 Overlay 并将其作为参数传递给回调函数

参数

method

any

回调函数

context

any

上下文环境

返回

HtmlLayer

Layer

继承自

Layer.eachOverlay

---

getOverlay()

getOverlay(overlayId): any

定义于: layer/Layer.ts:311

通过 overlayId 获取对应 Overlay

参数

overlayId

string

overlay id

返回

any

overlay

继承自

Layer.getOverlay

---

getOverlayById()

getOverlayById(id): undefined

定义于: layer/Layer.ts:315

参数

id

string | number

返回

undefined

继承自

Layer.getOverlayById

---

getOverlays()

getOverlays(): Overlay[]

定义于: layer/Layer.ts:376

获取图层上所有 overlays

返回

Overlay[]

overlays

继承自

Layer.getOverlays

---

getOverlaysByAttr()

getOverlaysByAttr(attrName, attrVal): Overlay[]

定义于: layer/Layer.ts:347

通过属性名，属性值获取 overlays

参数

attrName

string

属性名

attrVal

string

属性值

返回

Overlay[]

overlays

继承自

Layer.getOverlaysByAttr

---

getOverlaysByType()

getOverlaysByType(type): Overlay[]

定义于: layer/Layer.ts:330

通过类型获取 overlays

参数

type

string | number

类型

返回

Overlay[]

overlay

继承自

Layer.getOverlaysByType

---

remove()

remove(): void

定义于: layer/Layer.ts:388

移除图层

返回

void

继承自

Layer.remove

---

removeOverlay()

removeOverlay(overlay): HtmlLayer

定义于: layer/Layer.ts:300

从图层上移出 overlay

参数

overlay

Overlay | PrimitiveOverlay

overlay

返回

HtmlLayer

Layer

继承自

Layer.removeOverlay

---

tick()

tick(zoom): void

定义于: layer/Layer.ts:237

参数

zoom

number

返回

void

继承自

Layer.tick