m-gis核心库 v0.4.4

---

m-gis核心库 / Overlay

类: Overlay

定义于: overlay/Overlay.ts:15

是三维图元的基类

继承于

• Billboard
• Box
• Corridor
• Cylinder
• DivBoard
• Ellipse
• Ellipsoid
• Heatmap
• Label
• Marker
• Plane
• Point
• Polygon
• Polyline
• PolylineVolume
• Rectangle
• Tileset
• Wall

构造函数

构造函数

new Overlay(id?): Overlay

定义于: overlay/Overlay.ts:32

参数

id?

string | number

返回

Overlay

属性

_attr

_attr: any

定义于: overlay/Overlay.ts:26

---

_bid

_bid: any

定义于: overlay/Overlay.ts:17

---

_customData

_customData: any

定义于: overlay/Overlay.ts:29

---

_delegate

_delegate: any

定义于: overlay/Overlay.ts:21

---

_id

_id: string | number

定义于: overlay/Overlay.ts:16

---

_layer

_layer: any

定义于: overlay/Overlay.ts:22

---

_options

_options: any

定义于: overlay/Overlay.ts:18

---

_overlayEvent

_overlayEvent: OverlayEvent

定义于: overlay/Overlay.ts:28

---

_position

_position: any

定义于: overlay/Overlay.ts:19

---

_positions

_positions: any

定义于: overlay/Overlay.ts:20

---

_relaters

_relaters: any

定义于: overlay/Overlay.ts:30

---

_show

_show: boolean

定义于: overlay/Overlay.ts:24

---

_state

_state: any

定义于: overlay/Overlay.ts:23

---

_style

_style: any

定义于: overlay/Overlay.ts:25

---

interactionEvents

interactionEvents: any[]

定义于: overlay/Overlay.ts:31

---

type

type: any

定义于: overlay/Overlay.ts:27

访问器

attr

Getter 签名

get attr(): any

定义于: overlay/Overlay.ts:106

返回

any

Setter 签名

set attr(attr): void

定义于: overlay/Overlay.ts:102

覆盖物的额外属性设置

参数

attr

any

返回

void

---

center

Getter 签名

get center(): Position

定义于: overlay/Overlay.ts:137

返回

Position

---

customData

Getter 签名

get customData(): any

定义于: overlay/Overlay.ts:141

返回

any

---

delegate

Getter 签名

get delegate(): any

定义于: overlay/Overlay.ts:124

覆盖物的代理对象

返回

any

---

id

Getter 签名

get id(): any

定义于: overlay/Overlay.ts:78

返回

any

Setter 签名

set id(id): void

定义于: overlay/Overlay.ts:74

设置覆盖物的业务 id

参数

id

any

返回

void

---

overlayEvent

Getter 签名

get overlayEvent(): OverlayEvent

定义于: overlay/Overlay.ts:115

覆盖物的事件对象

返回

OverlayEvent

---

overlayId

Getter 签名

get overlayId(): string | number

定义于: overlay/Overlay.ts:61

覆盖物唯一标识

返回

string | number

---

relaters

Getter 签名

get relaters(): any[]

定义于: overlay/Overlay.ts:145

返回

any[]

---

show

Getter 签名

get show(): boolean

定义于: overlay/Overlay.ts:94

返回

boolean

Setter 签名

set show(show): void

定义于: overlay/Overlay.ts:86

覆盖物的可见性

参数

show

boolean

返回

void

---

state

Getter 签名

get state(): any

定义于: overlay/Overlay.ts:133

覆盖物的状态

返回

any

---

viewer

Getter 签名

get viewer(): any

定义于: overlay/Overlay.ts:52

返回

any

方法

addCustomData()

addCustomData(key, value): void

定义于: overlay/Overlay.ts:267

参数

key

any

value

any

返回

void

---

addToLayer()

addToLayer(layer): Overlay

定义于: overlay/Overlay.ts:260

添加到指定图层

参数

layer

any

指定图层

返回

Overlay

---

clearCustomData()

clearCustomData(): void

定义于: overlay/Overlay.ts:275

返回

void

---

clearRelate()

clearRelate(): void

定义于: overlay/Overlay.ts:288

返回

void

---

eachRelaters()

eachRelaters(callback): void

定义于: overlay/Overlay.ts:292

参数

callback

any

返回

void

---

fire()

fire(type, params): Overlay

定义于: overlay/Overlay.ts:339

触发事件

参数

type

string | number

params

any

返回

Overlay

---

getCustomData()

getCustomData(key): any

定义于: overlay/Overlay.ts:271

参数

key

any

返回

any

---

off()

off(type, callback, context?): Overlay

定义于: overlay/Overlay.ts:324

注销事件

参数

type

string | number

事件类型

callback

any

监听回调

context?

any

返回

Overlay

---

on()

on(type, callback, context?): Overlay

定义于: overlay/Overlay.ts:304

注册事件

参数

type

string | number

事件类型

callback

any

监听回调

context?

any

返回

Overlay

---

relate()

relate(overlay): void

定义于: overlay/Overlay.ts:279

参数

overlay

Overlay

返回

void

---

remove()

remove(): Overlay

定义于: overlay/Overlay.ts:243

从图层上移出

返回

Overlay

---

setLabel()

setLabel(text, textStyle): Overlay

定义于: overlay/Overlay.ts:229

设置文字标签

参数

text

string

指定文本的属性。支持显式换行符'\ n'。

textStyle

any

text 样式

返回

Overlay

---

unRelate()

unRelate(overlay): void

定义于: overlay/Overlay.ts:283

参数

overlay

Overlay

返回

void

---

getOverlayType()

static getOverlayType(type): string | number | undefined

定义于: overlay/Overlay.ts:361

获取 Overlay 类型

参数

type

string

返回

string | number | undefined

---

registerType()

static registerType(type): void

定义于: overlay/Overlay.ts:349

Overlay 类型注册

参数

type

string

返回

void