m-gis核心库 v0.4.4

---

m-gis核心库 / Mask

类: Mask

定义于: overlay/primitive/Mask.ts:17

继承

• PrimitiveOverlay

构造函数

构造函数

new Mask(positions, options): Mask

定义于: overlay/primitive/Mask.ts:18

参数

positions

string | Position[] | Position[][]

options

MaskOptions

返回

Mask

重写了

PrimitiveOverlay.constructor

属性

_attr

_attr: any

定义于: overlay/PrimitiveOverlay.ts:19

继承自

PrimitiveOverlay._attr

---

_bid

_bid: any

定义于: overlay/PrimitiveOverlay.ts:11

继承自

PrimitiveOverlay._bid

---

_delegate

_delegate: any

定义于: overlay/PrimitiveOverlay.ts:13

继承自

PrimitiveOverlay._delegate

---

_id

_id: any

定义于: overlay/PrimitiveOverlay.ts:10

继承自

PrimitiveOverlay._id

---

_inBatch

_inBatch: boolean

定义于: overlay/PrimitiveOverlay.ts:12

继承自

PrimitiveOverlay._inBatch

---

_layer

_layer: Layer | undefined

定义于: overlay/PrimitiveOverlay.ts:16

继承自

PrimitiveOverlay._layer

---

_options

_options: any

定义于: overlay/PrimitiveOverlay.ts:23

继承自

PrimitiveOverlay._options

---

_outline

_outline: any

定义于: overlay/PrimitiveOverlay.ts:22

继承自

PrimitiveOverlay._outline

---

_overlayEvent

_overlayEvent: OverlayEvent

定义于: overlay/PrimitiveOverlay.ts:20

继承自

PrimitiveOverlay._overlayEvent

---

_position

_position: any

定义于: overlay/PrimitiveOverlay.ts:14

继承自

PrimitiveOverlay._position

---

_positions

_positions: any

定义于: overlay/PrimitiveOverlay.ts:15

继承自

PrimitiveOverlay._positions

---

_show

_show: boolean

定义于: overlay/PrimitiveOverlay.ts:17

继承自

PrimitiveOverlay._show

---

_style

_style: any

定义于: overlay/PrimitiveOverlay.ts:18

继承自

PrimitiveOverlay._style

---

type

type: any

定义于: overlay/PrimitiveOverlay.ts:21

继承自

PrimitiveOverlay.type

访问器

attr

Getter 签名

get attr(): any

定义于: overlay/PrimitiveOverlay.ts:82

返回

any

Setter 签名

set attr(attr): void

定义于: overlay/PrimitiveOverlay.ts:78

覆盖物的额外属性设置

参数

attr

any

返回

void

继承自

PrimitiveOverlay.attr

---

delegate

Getter 签名

get delegate(): any

定义于: overlay/PrimitiveOverlay.ts:100

覆盖物的代理对象

返回

any

继承自

PrimitiveOverlay.delegate

---

id

Getter 签名

get id(): any

定义于: overlay/PrimitiveOverlay.ts:57

返回

any

Setter 签名

set id(id): void

定义于: overlay/PrimitiveOverlay.ts:53

设置覆盖物的业务 id

参数

id

any

返回

void

继承自

PrimitiveOverlay.id

---

invert

Getter 签名

get invert(): boolean

定义于: overlay/primitive/Mask.ts:56

返回

boolean

Setter 签名

set invert(invert): void

定义于: overlay/primitive/Mask.ts:51

参数

invert

boolean

返回

void

---

maskColor

Getter 签名

get maskColor(): Color

定义于: overlay/primitive/Mask.ts:47

返回

Color

Setter 签名

set maskColor(color): void

定义于: overlay/primitive/Mask.ts:42

参数

color

Color

返回

void

---

outline

Getter 签名

get outline(): any

定义于: overlay/PrimitiveOverlay.ts:109

outline 代理对象

返回

any

继承自

PrimitiveOverlay.outline

---

overlayEvent

Getter 签名

get overlayEvent(): OverlayEvent

定义于: overlay/PrimitiveOverlay.ts:91

覆盖物的事件对象

返回

OverlayEvent

继承自

PrimitiveOverlay.overlayEvent

---

overlayId

Getter 签名

get overlayId(): any

定义于: overlay/PrimitiveOverlay.ts:45

覆盖物唯一标识

返回

any

继承自

PrimitiveOverlay.overlayId

---

positions

Getter 签名

get positions(): Position[] | Position[][]

定义于: overlay/primitive/Mask.ts:38

返回

Position[] | Position[][]

Setter 签名

set positions(positions): void

定义于: overlay/primitive/Mask.ts:28

参数

positions

string | Position[] | Position[][]

返回

void

---

show

Getter 签名

get show(): boolean

定义于: overlay/PrimitiveOverlay.ts:70

返回

boolean

Setter 签名

set show(show): void

定义于: overlay/PrimitiveOverlay.ts:65

覆盖物的可见性

参数

show

boolean

返回

void

继承自

PrimitiveOverlay.show

方法

_addHandlerSync()

_addHandlerSync(): void

定义于: overlay/PrimitiveOverlay.ts:163

返回

void

继承自

PrimitiveOverlay._addHandlerSync

---

addToLayer()

addToLayer(layer): Mask

定义于: overlay/PrimitiveOverlay.ts:232

添加到指定图层

参数

layer

any

指定图层

返回

Mask

继承自

PrimitiveOverlay.addToLayer

---

fire()

fire(type, params): Mask

定义于: overlay/PrimitiveOverlay.ts:272

触发事件

参数

type

string

params

any

返回

Mask

继承自

PrimitiveOverlay.fire

---

getInstances()

getInstances(): GeometryInstance[]

定义于: overlay/primitive/Mask.ts:82

返回

GeometryInstance[]

---

getMaskFabric()

getMaskFabric(): object

定义于: overlay/primitive/Mask.ts:138

返回

object

fabric

fabric: object

fabric.type

type: string = 'Color'

fabric.uniforms

uniforms: object

fabric.uniforms.color

color: Color

---

initMask()

initMask(): void

定义于: overlay/primitive/Mask.ts:72

返回

void

---

off()

off(type, callback, context): Mask

定义于: overlay/PrimitiveOverlay.ts:260

注销事件

参数

type

string

事件类型

callback

any

监听回调

context

any

返回

Mask

继承自

PrimitiveOverlay.off

---

on()

on(type, callback, context?): Mask

定义于: overlay/PrimitiveOverlay.ts:247

注册事件

参数

type

string | number

事件类型

callback

any

监听回调

context?

any

返回

Mask

继承自

PrimitiveOverlay.on

---

processGeoJSONData()

processGeoJSONData(data): any[]

定义于: overlay/primitive/Mask.ts:149

参数

data

any

返回

any[]

---

reload()

reload(): void

定义于: overlay/primitive/Mask.ts:65

返回

void

---

remove()

remove(): Mask

定义于: overlay/PrimitiveOverlay.ts:219

从图层上移出

返回

Mask

继承自

PrimitiveOverlay.remove

---

set()

set(): void

定义于: overlay/PrimitiveOverlay.ts:277

返回

void

继承自

PrimitiveOverlay.set

---

setLabel()

setLabel(text, textStyle): Mask

定义于: overlay/PrimitiveOverlay.ts:195

设置文字标签

参数

text

string

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

textStyle

any

text 样式

返回

Mask

继承自

PrimitiveOverlay.setLabel

---

setStyle()

setStyle(): Mask

定义于: overlay/PrimitiveOverlay.ts:210

TODO设置样式

返回

Mask

继承自

PrimitiveOverlay.setStyle

---

getOverlayType()

static getOverlayType(type): string | number | undefined

定义于: overlay/PrimitiveOverlay.ts:305

获取 Overlay 类型

参数

type

string

返回

string | number | undefined

继承自

PrimitiveOverlay.getOverlayType

---

registerType()

static registerType(type): void

定义于: overlay/PrimitiveOverlay.ts:293

Overlay 类型注册

参数

type

string

返回

void

继承自

PrimitiveOverlay.registerType