Class SVGOverlayList<M, E>

Type Parameters

M extends LayerWithID
E extends string = never

Hierarchy

LayerList<M, E>
- SVGOverlayList

Constructors

constructor

new SVGOverlayList<M, E>(pane: string): SVGOverlayList<M, E>
Type Parameters
- M extends LayerWithID<M>
- E extends string = never
Parameters
- pane: string
Returns SVGOverlayList<M, E>
Overrides LayerList.constructor
- Defined in src/2d/basic/SVGOverlayList.class.ts:20

Properties

`Readonly` $$isEmitter

$$isEmitter: true

$$parent

$$parent: IWarehouse

The parent of event.

List is a parent of Base or Layer.

This field has the name $$parent declared, which keep consistent with /model/basic/Base.class

`Protected` featureGroup

featureGroup: FeatureGroup<any> = null

Todo

Can featureGroup be removed?

`Readonly` index

index: Map<string, M> = ...

injector

injector: IInjector

`Readonly` interactiveStateActionManager

interactiveStateActionManager: InteractiveStateActionManager

`Protected` isBatching

isBatching: boolean = false

`Readonly` itemKey

itemKey: string = 'layerId'

key to item.

`Readonly` items

items: Set<M> = ...

`Readonly` modeMgr

modeMgr: ModeManager

`Readonly` mounted

mounted: false = false

noEmit

noEmit: boolean

set it True, the follow emit will be ignore and then set it False.

`Readonly` pane

pane: string

`Readonly` paneMgr

paneMgr: PaneManager

`Readonly` paneObj

paneObj: WikPane

`Readonly` root

root: WikMap = null

size

size: number = 0

`Readonly` svgServer

svgServer: ReactSVGOverlayAppServer

Methods

$has

$has(predicate: ((item: M) => boolean)): boolean
Parameters
- predicate: ((item: M) => boolean)
  - - (item: M): boolean
    - Parameters
      
      item: M
      
      Returns boolean
Returns boolean
Inherited from LayerList.$has
- Defined in src/model/basic/CoreList.class.ts:207

$set

$set(pairs: string | Record<string, any>, value?: any, context?: object): void
Parameters
- pairs: string | Record<string, any>
- Optional value: any
- Optional context: object
Returns void
Inherited from LayerList.$set
- Defined in src/model/basic/Core.class.ts:7

[iterator]

[iterator](): Generator<M, void, unknown>
Returns Generator<M, void, unknown>
Inherited from LayerList.[iterator]
- Defined in src/model/basic/CoreList.class.ts:15

`Protected` _add

_add(item: M): void
Parameters
- item: M
Returns void
Overrides LayerList._add
- Defined in src/2d/basic/SVGOverlayList.class.ts:26

`Protected` _clear

_clear(): void
Returns void
Inherited from LayerList._clear
- Defined in src/2d/basic/LayerList.class.ts:141

`Protected` _remove

_remove(item: M): void
Parameters
- item: M
Returns void
Overrides LayerList._remove
- Defined in src/2d/basic/SVGOverlayList.class.ts:33

add

add(item: M): void
将一个对象加入到数据集，标记为 Added，将在下次提交时远程添加
Parameters
- item: M
Returns void
Inherited from LayerList.add
- Defined in src/model/basic/CoreList.class.ts:30

addArr

addArr(items: M[]): void
Parameters
- items: M[]
Returns void
Inherited from LayerList.addArr
- Defined in src/model/basic/CoreList.class.ts:54

addRange

addRange(...items: M[]): void
Parameters
- Rest ...items: M[]
Returns void
Inherited from LayerList.addRange
- Defined in src/model/basic/CoreList.class.ts:50

clear

clear(): void
Returns void
Inherited from LayerList.clear
- Defined in src/model/basic/CoreList.class.ts:127

create

create(...args: any[]): M
创建一个默认的对象，并且将其添加至数据集
Parameters
- Rest ...args: any[]
Returns M
Inherited from LayerList.create
- Defined in src/2d/basic/LayerList.class.ts:178

dispose

dispose(): void
Returns void
Overrides LayerList.dispose
- Defined in src/2d/basic/SVGOverlayList.class.ts:56

filter

filter(pipe: ((m: M) => boolean)): M[]
Parameters
- pipe: ((m: M) => boolean)
  - - (m: M): boolean
    - Parameters
      
      m: M
      
      Returns boolean
Returns M[]
Inherited from LayerList.filter
- Defined in src/model/basic/CoreList.class.ts:191

find

find(key: string): M
Parameters
- key: string
Returns M
Inherited from LayerList.find
- Defined in src/model/basic/CoreList.class.ts:159

fire

fire<T>(event: T, payload?: PlainObject): boolean
Type Parameters
- T extends string
Parameters
- event: T
- Optional payload: PlainObject
Returns boolean
Inherited from LayerList.fire
- Defined in src/model/basic/Emitter.ts:147

fire$n

fire$n(event: string, payload?: PlainObject): SVGOverlayList<M, E>
split fire
Parameters
- event: string
- Optional payload: PlainObject
Returns SVGOverlayList<M, E>
Inherited from LayerList.fire$n
- Defined in src/model/basic/Emitter.ts:151

first

first(predicate?: ((item: M) => boolean)): M
Parameters
- Optional predicate: ((item: M) => boolean)
  - - (item: M): boolean
    - Parameters
      
      item: M
      
      Returns boolean
Returns M
Inherited from LayerList.first
- Defined in src/model/basic/CoreList.class.ts:170

fit

fit(immediately?: boolean): void
Parameters
- immediately: boolean = false
Returns void
Inherited from LayerList.fit
- Defined in src/2d/basic/LayerList.class.ts:160

has

has(key: string | M): boolean
查询
Parameters
- key: string | M
Returns boolean
Inherited from LayerList.has
- Defined in src/model/basic/CoreList.class.ts:149

listen

listen<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): SVGOverlayList<M, E>
on
Type Parameters
- T extends string
Parameters
- event: T
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
- Optional context: any
Returns SVGOverlayList<M, E>
Inherited from LayerList.listen
- Defined in src/model/basic/Emitter.ts:155

listen$1

listen$1<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): SVGOverlayList<M, E>
once
Type Parameters
- T extends string
Parameters
- event: T
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
- Optional context: any
Returns SVGOverlayList<M, E>
Inherited from LayerList.listen$1
- Defined in src/model/basic/Emitter.ts:172

listen$n

listen$n(event: string, fn: ((event: WikEvent<any, any>) => void)): SVGOverlayList<M, E>
split on
Parameters
- event: string
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns SVGOverlayList<M, E>
Inherited from LayerList.listen$n
- Defined in src/model/basic/Emitter.ts:159

map

map<R>(project: ((m: M) => R)): R[]
Type Parameters
- R
Parameters
- project: ((m: M) => R)
  - - (m: M): R
    - Parameters
      
      m: M
      
      Returns R
Returns R[]
Inherited from LayerList.map
- Defined in src/model/basic/CoreList.class.ts:199

mount

mount(parent: WikMap): void
Parameters
- parent: WikMap
Returns void
Overrides LayerList.mount
- Defined in src/2d/basic/SVGOverlayList.class.ts:49

onClear

onClear(): void
Returns void
Inherited from LayerList.onClear
- Defined in src/model/basic/CoreList.class.ts:227

onItemAdd

onItemAdd(item: M): void
Parameters
- item: M
Returns void
Inherited from LayerList.onItemAdd
- Defined in src/model/basic/CoreList.class.ts:224

onItemRemove

onItemRemove(item: M): void
Parameters
- item: M
Returns void
Inherited from LayerList.onItemRemove
- Defined in src/model/basic/CoreList.class.ts:225

onItemUpdate

onItemUpdate(item: M, data: any): void
Parameters
- item: M
- data: any
Returns void
Inherited from LayerList.onItemUpdate
- Defined in src/model/basic/CoreList.class.ts:226

query

query(predicate: ((item: M) => boolean)): M[]
Parameters
- predicate: ((item: M) => boolean)
  - - (item: M): boolean
    - Parameters
      
      item: M
      
      Returns boolean
Returns M[]
Inherited from LayerList.query
- Defined in src/model/basic/CoreList.class.ts:183

readOnly

readOnly<V>(key: string, value: V): void
Type Parameters
- V = any
Parameters
- key: string
- value: V
Returns void
Inherited from LayerList.readOnly
- Defined in src/model/basic/Core.class.ts:22

remove

remove(item?: M): void
将对象从数据集移除，并将其标记为 Deleted，将在下次提交时远程删除

Warn！当不传 item 的时候，表示移除全部元素
Parameters
- Optional item: M
Returns void
Inherited from LayerList.remove
- Defined in src/model/basic/CoreList.class.ts:67

removeArr

removeArr(items: M[]): void
Parameters
- items: M[]
Returns void
Inherited from LayerList.removeArr
- Defined in src/model/basic/CoreList.class.ts:114

removeById

removeById(key: string): void
Parameters
- key: string
Returns void
Inherited from LayerList.removeById
- Defined in src/model/basic/CoreList.class.ts:97

removeRange

removeRange(...items: M[]): void
Parameters
- Rest ...items: M[]
Returns void
Inherited from LayerList.removeRange
- Defined in src/model/basic/CoreList.class.ts:110

setEventChild

setEventChild(child: WithEmitter<string>, off?: boolean): SVGOverlayList<M, E>
Create parent-child relationships of two evented objects manually. Because this method not mounted on evented object.
Parameters
- child: WithEmitter<string>
- Optional off: boolean
Returns SVGOverlayList<M, E>
Inherited from LayerList.setEventChild
- Defined in src/model/basic/Emitter.ts:178

setEventParent

setEventParent(parent: WithEmitter<string>): SVGOverlayList<M, E>
Parameters
- parent: WithEmitter<string>
Returns SVGOverlayList<M, E>
Inherited from LayerList.setEventParent
- Defined in src/model/basic/Emitter.ts:180

setZ

setZ(z: number): void
Parameters
- z: number
Returns void
Overrides LayerList.setZ
- Defined in src/2d/basic/SVGOverlayList.class.ts:40

unlisten

unlisten<T>(event: T, fn?: ((event: WikEvent<any, any>) => void)): SVGOverlayList<M, E>
off
Type Parameters
- T extends string
Parameters
- event: T
- Optional fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns SVGOverlayList<M, E>
Inherited from LayerList.unlisten
- Defined in src/model/basic/Emitter.ts:163

unlisten$n

unlisten$n(event: string, fn?: ((event: WikEvent<any, any>) => void)): SVGOverlayList<M, E>
split off
Parameters
- event: string
- Optional fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns SVGOverlayList<M, E>
Inherited from LayerList.unlisten$n
- Defined in src/model/basic/Emitter.ts:167

unmount

unmount(): void
Returns void
Inherited from LayerList.unmount
- Defined in src/2d/basic/LayerList.class.ts:153

update

update(item: M): void
将对象标记为 Modified，将在下次提交时更新对应的远程对象
Parameters
- item: M
Returns void
Inherited from LayerList.update
- Defined in src/model/basic/CoreList.class.ts:141

updateRange

updateRange(...items: M[]): void
Parameters
- Rest ...items: M[]
Returns void
Inherited from LayerList.updateRange
- Defined in src/model/basic/CoreList.class.ts:145

Class SVGOverlayList<M, E>

Type Parameters

M extends LayerWithID

E extends string = never

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

M extends LayerWithID<M>

E extends string = never

Parameters

pane: string

Returns SVGOverlayList<M, E>

Properties

Readonly $$isEmitter

$$parent

Protected featureGroup

Todo

Readonly index

injector

Readonly interactiveStateActionManager

Protected isBatching

Readonly itemKey

Readonly items

Readonly modeMgr

Readonly mounted

noEmit

Readonly pane

Readonly paneMgr

Readonly paneObj

Readonly root

size

Readonly svgServer

Methods

$has

Parameters

predicate: ((item: M) => boolean)

Parameters

item: M

Returns boolean

Returns boolean

$set

Parameters

pairs: string | Record<string, any>

Optional value: any

Optional context: object

Returns void

[iterator]

Returns Generator<M, void, unknown>

Protected _add

Parameters

item: M

Returns void

Protected _clear

Returns void

Protected _remove

Parameters

item: M

Returns void

add

Parameters

item: M

Returns void

addArr

Parameters

items: M[]

Returns void

addRange

Parameters

Rest ...items: M[]

Returns void

clear

Returns void

create

Parameters

Rest ...args: any[]

`Readonly` $$isEmitter

`Protected` featureGroup

`Readonly` index

`Readonly` interactiveStateActionManager

`Protected` isBatching

`Readonly` itemKey

`Readonly` items

`Readonly` modeMgr

`Readonly` mounted

`Readonly` pane

`Readonly` paneMgr

`Readonly` paneObj

`Readonly` root

`Readonly` svgServer

`Optional` value: any

`Optional` context: object

`Protected` _add

`Protected` _clear

`Protected` _remove

`Rest` ...items: M[]

`Rest` ...args: any[]

`Optional` payload: PlainObject

`Optional` payload: PlainObject

`Optional` predicate: ((item: M) => boolean)

`Optional` context: any

`Optional` context: any