Class GroupList<E>

Type Parameters

E extends string = never

Hierarchy

LayerList<Group, E>
- GroupList

Constructors

constructor

new GroupList<E>(groups: Group<{}>[], options?: GroupListOptions): GroupList<E>
Type Parameters
- E extends string = never
Parameters
- groups: Group<{}>[]
- options: GroupListOptions = ...
Returns GroupList<E>
Overrides LayerList.constructor
- Defined in src/2d/basic/GroupList.class.ts:10

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, Group<{}>> = ...

injector

injector: IInjector

`Readonly` interactiveStateActionManager

interactiveStateActionManager: InteractiveStateActionManager

`Protected` isBatching

isBatching: boolean = false

`Readonly` itemKey

itemKey: string = 'layerId'

key to item.

`Readonly` items

items: Set<Group<{}>> = ...

`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.

`Private` options

options: GroupListOptions = ...

`Readonly` root

root: WikMap = null

size

size: number = 0

Methods

$has

$has(predicate: ((item: Group<{}>) => boolean)): boolean
Parameters
- predicate: ((item: Group<{}>) => boolean)
  - - (item: Group<{}>): boolean
    - Parameters
      
      item: Group<{}>
      
      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<Group<{}>, void, unknown>
Returns Generator<Group<{}>, void, unknown>
Inherited from LayerList.[iterator]
- Defined in src/model/basic/CoreList.class.ts:15

`Protected` _add

_add(item: Group<{}>): void
Parameters
- item: Group<{}>
Returns void
Overrides LayerList._add
- Defined in src/2d/basic/GroupList.class.ts:14

`Protected` _clear

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

`Protected` _remove

_remove(item: Group<{}>): void
Parameters
- item: Group<{}>
Returns void
Overrides LayerList._remove
- Defined in src/2d/basic/GroupList.class.ts:20

add

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

addArr

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

addRange

addRange(...items: Group<{}>[]): void
Parameters
- Rest ...items: Group<{}>[]
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[]): Group<{}>
创建一个默认的对象，并且将其添加至数据集
Parameters
- Rest ...args: any[]
Returns Group<{}>
Inherited from LayerList.create
- Defined in src/2d/basic/LayerList.class.ts:178

dispose

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

filter

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

find

find(key: string): Group<{}>
Parameters
- key: string
Returns Group<{}>
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): GroupList<E>
split fire
Parameters
- event: string
- Optional payload: PlainObject
Returns GroupList<E>
Inherited from LayerList.fire$n
- Defined in src/model/basic/Emitter.ts:151

first

first(predicate?: ((item: Group<{}>) => boolean)): Group<{}>
Parameters
- Optional predicate: ((item: Group<{}>) => boolean)
  - - (item: Group<{}>): boolean
    - Parameters
      
      item: Group<{}>
      
      Returns boolean
Returns Group<{}>
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 | Group<{}>): boolean
查询
Parameters
- key: string | Group<{}>
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): GroupList<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 GroupList<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): GroupList<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 GroupList<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)): GroupList<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 GroupList<E>
Inherited from LayerList.listen$n
- Defined in src/model/basic/Emitter.ts:159

map

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

mount

mount(root: WikMap): void
Parameters
- root: WikMap
Returns void
Inherited from LayerList.mount
- Defined in src/2d/basic/LayerList.class.ts:146

onClear

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

onItemAdd

onItemAdd(item: Group<{}>): void
Parameters
- item: Group<{}>
Returns void
Inherited from LayerList.onItemAdd
- Defined in src/model/basic/CoreList.class.ts:224

onItemRemove

onItemRemove(item: Group<{}>): void
Parameters
- item: Group<{}>
Returns void
Inherited from LayerList.onItemRemove
- Defined in src/model/basic/CoreList.class.ts:225

onItemUpdate

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

query

query(predicate: ((item: Group<{}>) => boolean)): Group<{}>[]
Parameters
- predicate: ((item: Group<{}>) => boolean)
  - - (item: Group<{}>): boolean
    - Parameters
      
      item: Group<{}>
      
      Returns boolean
Returns Group<{}>[]
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?: Group<{}>): void
将对象从数据集移除，并将其标记为 Deleted，将在下次提交时远程删除

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

removeArr

removeArr(items: Group<{}>[]): void
Parameters
- items: Group<{}>[]
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: Group<{}>[]): void
Parameters
- Rest ...items: Group<{}>[]
Returns void
Inherited from LayerList.removeRange
- Defined in src/model/basic/CoreList.class.ts:110

setEventChild

setEventChild(child: WithEmitter<string>, off?: boolean): GroupList<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 GroupList<E>
Inherited from LayerList.setEventChild
- Defined in src/model/basic/Emitter.ts:178

setEventParent

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

setZ

setZ(z: number): void
Parameters
- z: number
Returns void
Inherited from LayerList.setZ
- Defined in src/2d/basic/LayerList.class.ts:174

unlisten

unlisten<T>(event: T, fn?: ((event: WikEvent<any, any>) => void)): GroupList<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 GroupList<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)): GroupList<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 GroupList<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: Group<{}>): void
将对象标记为 Modified，将在下次提交时更新对应的远程对象
Parameters
- item: Group<{}>
Returns void
Inherited from LayerList.update
- Defined in src/model/basic/CoreList.class.ts:141

updateRange

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

Class GroupList<E>

Type Parameters

E extends string = never

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

E extends string = never

Parameters

groups: Group<{}>[]

options: GroupListOptions = ...

Returns GroupList<E>

Properties

Readonly $$isEmitter

$$parent

Protected featureGroup

Todo

Readonly index

injector

Readonly interactiveStateActionManager

Protected isBatching

Readonly itemKey

Readonly items

Readonly modeMgr

Readonly mounted

noEmit

Private options

Readonly root

size

Methods

$has

Parameters

predicate: ((item: Group<{}>) => boolean)

Parameters

item: Group<{}>

Returns boolean

Returns boolean

$set

Parameters

pairs: string | Record<string, any>

Optional value: any

Optional context: object

Returns void

[iterator]

Returns Generator<Group<{}>, void, unknown>

Protected _add

Parameters

item: Group<{}>

Returns void

Protected _clear

Returns void

Protected _remove

Parameters

item: Group<{}>

Returns void

add

Parameters

item: Group<{}>

Returns void

addArr

Parameters

items: Group<{}>[]

Returns void

addRange

Parameters

Rest ...items: Group<{}>[]

Returns void

clear

Returns void

create

Parameters

Rest ...args: any[]

Returns Group<{}>

dispose

Returns void

filter

`Readonly` $$isEmitter

`Protected` featureGroup

`Readonly` index

`Readonly` interactiveStateActionManager

`Protected` isBatching

`Readonly` itemKey

`Readonly` items

`Readonly` modeMgr

`Readonly` mounted

`Private` options

`Readonly` root

`Optional` value: any

`Optional` context: object

`Protected` _add

`Protected` _clear

`Protected` _remove

`Rest` ...items: Group<{}>[]

`Rest` ...args: any[]

`Optional` payload: PlainObject

`Optional` payload: PlainObject

`Optional` predicate: ((item: Group<{}>) => boolean)

`Optional` context: any

`Optional` context: any