Interface IWarehouseObjectList<O, E>

Type Parameters

O extends GraphicObject = GraphicObject
E extends string = never

Hierarchy

CoreList<O, E>
IWarehouseObjectListAbstarct
- IWarehouseObjectList

Implemented by

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

`Readonly` index

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

`Protected` isBatching

isBatching: boolean = false

`Abstract` itemKey

itemKey: string

key to item.

`Readonly` items

items: Set<O> = ...

`Readonly` mounted

mounted: boolean

noEmit

noEmit: boolean

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

root

root: unknown

size

size: number = 0

Methods

$has

$has(predicate: ((item: O) => boolean)): boolean
Parameters
- predicate: ((item: O) => boolean)
  - - (item: O): boolean
    - Parameters
      
      item: O
      
      Returns boolean
Returns boolean
Inherited from CoreList.$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 CoreList.$set
- Defined in src/model/basic/Core.class.ts:7

[iterator]

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

`Protected` _add

_add(item: O): void
Parameters
- item: O
Returns void
Inherited from CoreList._add
- Defined in src/model/basic/CoreList.class.ts:41

`Protected` _clear

_clear(): void
Returns void
Inherited from CoreList._clear
- Defined in src/model/basic/CoreList.class.ts:133

`Protected` _remove

_remove(item: O): void
Parameters
- item: O
Returns void
Inherited from CoreList._remove
- Defined in src/model/basic/CoreList.class.ts:88

add

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

addArr

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

addRange

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

clear

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

`Abstract` create

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

filter

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

find

find(key: string): O
Parameters
- key: string
Returns O
Inherited from CoreList.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 CoreList.fire
- Defined in src/model/basic/Emitter.ts:147

fire$n

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

first

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

has

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

listen

listen<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): IWarehouseObjectList<O, 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 IWarehouseObjectList<O, E>
Inherited from CoreList.listen
- Defined in src/model/basic/Emitter.ts:155

listen$1

listen$1<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): IWarehouseObjectList<O, 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 IWarehouseObjectList<O, E>
Inherited from CoreList.listen$1
- Defined in src/model/basic/Emitter.ts:172

listen$n

listen$n(event: string, fn: ((event: WikEvent<any, any>) => void)): IWarehouseObjectList<O, 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 IWarehouseObjectList<O, E>
Inherited from CoreList.listen$n
- Defined in src/model/basic/Emitter.ts:159

map

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

mount

mount(root: unknown): void
Parameters
- root: unknown
Returns void
Inherited from IWarehouseObjectListAbstarct.mount
- Defined in src/model/IWarehouseObjectList.ts:7

onClear

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

onItemAdd

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

onItemRemove

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

onItemUpdate

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

query

query(predicate: ((item: O) => boolean)): O[]
Parameters
- predicate: ((item: O) => boolean)
  - - (item: O): boolean
    - Parameters
      
      item: O
      
      Returns boolean
Returns O[]
Inherited from CoreList.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 CoreList.readOnly
- Defined in src/model/basic/Core.class.ts:22

remove

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

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

removeArr

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

removeById

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

removeRange

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

setEventChild

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

setEventParent

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

unlisten

unlisten<T>(event: T, fn?: ((event: WikEvent<any, any>) => void)): IWarehouseObjectList<O, 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 IWarehouseObjectList<O, E>
Inherited from CoreList.unlisten
- Defined in src/model/basic/Emitter.ts:163

unlisten$n

unlisten$n(event: string, fn?: ((event: WikEvent<any, any>) => void)): IWarehouseObjectList<O, 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 IWarehouseObjectList<O, E>
Inherited from CoreList.unlisten$n
- Defined in src/model/basic/Emitter.ts:167

unmount

unmount(): void
Returns void
Inherited from IWarehouseObjectListAbstarct.unmount
- Defined in src/model/IWarehouseObjectList.ts:8

update

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

updateRange

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

Interface IWarehouseObjectList<O, E>

Type Parameters

O extends GraphicObject = GraphicObject

E extends string = never

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly $$isEmitter

$$parent

Readonly index

Protected isBatching

Abstract itemKey

Readonly items

Readonly mounted

noEmit

root

size

Methods

$has

Parameters

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

Parameters

item: O

Returns boolean

Returns boolean

$set

Parameters

pairs: string | Record<string, any>

Optional value: any

Optional context: object

Returns void

[iterator]

Returns Generator<O, void, unknown>

Protected _add

Parameters

item: O

Returns void

Protected _clear

Returns void

Protected _remove

Parameters

item: O

Returns void

add

Parameters

item: O

Returns void

addArr

Parameters

items: O[]

Returns void

addRange

Parameters

Rest ...items: O[]

Returns void

clear

Returns void

Abstract create

Parameters

Rest ...args: any[]

Returns O

filter

Parameters

pipe: ((m: O) => boolean)

Parameters

m: O

Returns boolean

Returns O[]

find

Parameters

key: string

Returns O

fire

Type Parameters

T extends string

Parameters

event: T

`Readonly` $$isEmitter

`Readonly` index

`Protected` isBatching

`Abstract` itemKey

`Readonly` items

`Readonly` mounted

`Optional` value: any

`Optional` context: object

`Protected` _add

`Protected` _clear

`Protected` _remove

`Rest` ...items: O[]

`Abstract` create

`Rest` ...args: any[]

`Optional` payload: PlainObject

`Optional` payload: PlainObject

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

`Optional` context: any

`Optional` context: any