Class DisplayObjectList<M>

Type Parameters

M extends DisplayObject

Hierarchy

CoreList<M>
- DisplayObjectList

Implements

IWarehouseObjectList

Constructors

constructor

new DisplayObjectList<M>(stage: PxStage, options: {
pane: string;
}): DisplayObjectList<M>
Type Parameters
- M extends DisplayObject<M>
Parameters
- stage: PxStage
- options: {
  pane: string;
  }
  - pane: string
Returns DisplayObjectList<M>
Overrides CoreList.constructor
- Defined in src/pixi/basic/DisplayObjectList.class.ts:38

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, M> = ...

`Readonly` interactiveStateActionManager

interactiveStateActionManager: InteractiveStateActionManager

`Protected` isBatching

isBatching: boolean = false

`Readonly` itemKey

itemKey: string = '_displayObjectId'

key to item.

`Readonly` items

items: Set<M> = ...

`Readonly` modeMgr

modeMgr: ModeManager

`Readonly` mounted

mounted: boolean = false

noEmit

noEmit: boolean

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

`Private` options

options: {
pane: string;
}

Type declaration

pane: string

`Readonly` pane

pane: string

`Readonly` paneObj

paneObj: PxPane = null

`Readonly` root

root: PxMap = null

size

size: number = 0

`Private` stage

stage: PxStage

Methods

$has

$has(predicate: ((item: M) => boolean)): boolean
Parameters
- predicate: ((item: M) => boolean)
  - - (item: M): boolean
    - Parameters
      
      item: M
      
      Returns boolean
Returns boolean
Implementation of IWarehouseObjectList.$has

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
Implementation of IWarehouseObjectList.$set

Inherited from CoreList.$set
- Defined in src/model/basic/Core.class.ts:7

[iterator]

[iterator](): Generator<M, void, unknown>
Returns Generator<M, void, unknown>
Implementation of IWarehouseObjectList.[iterator]

Inherited from CoreList.[iterator]
- Defined in src/model/basic/CoreList.class.ts:15

`Protected` _add

_add(item: M): void
Parameters
- item: M
Returns void
Implementation of IWarehouseObjectList._add

Overrides CoreList._add
- Defined in src/pixi/basic/DisplayObjectList.class.ts:42

`Protected` _clear

_clear(): void
Returns void
Implementation of IWarehouseObjectList._clear

Overrides CoreList._clear
- Defined in src/pixi/basic/DisplayObjectList.class.ts:60

`Protected` _remove

_remove(item: M): void
Parameters
- item: M
Returns void
Implementation of IWarehouseObjectList._remove

Overrides CoreList._remove
- Defined in src/pixi/basic/DisplayObjectList.class.ts:51

add

add(item: M): void
将一个对象加入到数据集，标记为 Added，将在下次提交时远程添加
Parameters
- item: M
Returns void
Implementation of IWarehouseObjectList.add

Inherited from CoreList.add
- Defined in src/model/basic/CoreList.class.ts:30

addArr

addArr(items: M[]): void
Parameters
- items: M[]
Returns void
Implementation of IWarehouseObjectList.addArr

Inherited from CoreList.addArr
- Defined in src/model/basic/CoreList.class.ts:54

addRange

addRange(...items: M[]): void
Parameters
- Rest ...items: M[]
Returns void
Implementation of IWarehouseObjectList.addRange

Inherited from CoreList.addRange
- Defined in src/model/basic/CoreList.class.ts:50

clear

clear(): void
Returns void
Implementation of IWarehouseObjectList.clear

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

create

create(...args: any[]): M
创建一个默认的对象，并且将其添加至数据集
Parameters
- Rest ...args: any[]
Returns M
Implementation of IWarehouseObjectList.create

Overrides CoreList.create
- Defined in src/pixi/basic/DisplayObjectList.class.ts:89

filter

filter(pipe: ((m: M) => boolean)): M[]
Parameters
- pipe: ((m: M) => boolean)
  - - (m: M): boolean
    - Parameters
      
      m: M
      
      Returns boolean
Returns M[]
Implementation of IWarehouseObjectList.filter

Inherited from CoreList.filter
- Defined in src/model/basic/CoreList.class.ts:191

find

find(key: string): M
Parameters
- key: string
Returns M
Implementation of IWarehouseObjectList.find

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 CoreListEventType
Parameters
- event: T
- Optional payload: PlainObject
Returns boolean
Implementation of IWarehouseObjectList.fire

Inherited from CoreList.fire
- Defined in src/model/basic/Emitter.ts:147

fire$n

fire$n(event: string, payload?: PlainObject): DisplayObjectList<M>
split fire
Parameters
- event: string
- Optional payload: PlainObject
Returns DisplayObjectList<M>
Implementation of IWarehouseObjectList.fire$n

Inherited from CoreList.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
Implementation of IWarehouseObjectList.first

Inherited from CoreList.first
- Defined in src/model/basic/CoreList.class.ts:170

has

has(key: string | M): boolean
查询
Parameters
- key: string | M
Returns boolean
Implementation of IWarehouseObjectList.has

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): DisplayObjectList<M>
on
Type Parameters
- T extends CoreListEventType
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 DisplayObjectList<M>
Implementation of IWarehouseObjectList.listen

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): DisplayObjectList<M>
once
Type Parameters
- T extends CoreListEventType
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 DisplayObjectList<M>
Implementation of IWarehouseObjectList.listen$1

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)): DisplayObjectList<M>
split on
Parameters
- event: string
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns DisplayObjectList<M>
Implementation of IWarehouseObjectList.listen$n

Inherited from CoreList.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[]
Implementation of IWarehouseObjectList.map

Inherited from CoreList.map
- Defined in src/model/basic/CoreList.class.ts:199

mount

mount(root: PxMap): void
Parameters
- root: PxMap
Returns void
Implementation of IWarehouseObjectList.mount
- Defined in src/pixi/basic/DisplayObjectList.class.ts:68

onClear

onClear(): void
Returns void
Implementation of IWarehouseObjectList.onClear

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

onItemAdd

onItemAdd(item: M): void
Parameters
- item: M
Returns void
Implementation of IWarehouseObjectList.onItemAdd

Inherited from CoreList.onItemAdd
- Defined in src/model/basic/CoreList.class.ts:224

onItemRemove

onItemRemove(item: M): void
Parameters
- item: M
Returns void
Implementation of IWarehouseObjectList.onItemRemove

Inherited from CoreList.onItemRemove
- Defined in src/model/basic/CoreList.class.ts:225

onItemUpdate

onItemUpdate(item: M, data: any): void
Parameters
- item: M
- data: any
Returns void
Implementation of IWarehouseObjectList.onItemUpdate

Inherited from CoreList.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[]
Implementation of IWarehouseObjectList.query

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
Implementation of IWarehouseObjectList.readOnly

Inherited from CoreList.readOnly
- Defined in src/model/basic/Core.class.ts:22

remove

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

Warn！当不传 item 的时候，表示移除全部元素
Parameters
- Optional item: M
Returns void
Implementation of IWarehouseObjectList.remove

Inherited from CoreList.remove
- Defined in src/model/basic/CoreList.class.ts:67

removeArr

removeArr(items: M[]): void
Parameters
- items: M[]
Returns void
Implementation of IWarehouseObjectList.removeArr

Inherited from CoreList.removeArr
- Defined in src/model/basic/CoreList.class.ts:114

removeById

removeById(key: string): void
Parameters
- key: string
Returns void
Implementation of IWarehouseObjectList.removeById

Inherited from CoreList.removeById
- Defined in src/model/basic/CoreList.class.ts:97

removeRange

removeRange(...items: M[]): void
Parameters
- Rest ...items: M[]
Returns void
Implementation of IWarehouseObjectList.removeRange

Inherited from CoreList.removeRange
- Defined in src/model/basic/CoreList.class.ts:110

setEventChild

setEventChild(child: WithEmitter<string>, off?: boolean): DisplayObjectList<M>
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 DisplayObjectList<M>
Implementation of IWarehouseObjectList.setEventChild

Inherited from CoreList.setEventChild
- Defined in src/model/basic/Emitter.ts:178

setEventParent

setEventParent(parent: WithEmitter<string>): DisplayObjectList<M>
Parameters
- parent: WithEmitter<string>
Returns DisplayObjectList<M>
Implementation of IWarehouseObjectList.setEventParent

Inherited from CoreList.setEventParent
- Defined in src/model/basic/Emitter.ts:180

unlisten

unlisten<T>(event: T, fn?: ((event: WikEvent<any, any>) => void)): DisplayObjectList<M>
off
Type Parameters
- T extends CoreListEventType
Parameters
- event: T
- Optional fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns DisplayObjectList<M>
Implementation of IWarehouseObjectList.unlisten

Inherited from CoreList.unlisten
- Defined in src/model/basic/Emitter.ts:163

unlisten$n

unlisten$n(event: string, fn?: ((event: WikEvent<any, any>) => void)): DisplayObjectList<M>
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 DisplayObjectList<M>
Implementation of IWarehouseObjectList.unlisten$n

Inherited from CoreList.unlisten$n
- Defined in src/model/basic/Emitter.ts:167

unmount

unmount(): void
Returns void
Implementation of IWarehouseObjectList.unmount
- Defined in src/pixi/basic/DisplayObjectList.class.ts:79

update

update(item: M): void
将对象标记为 Modified，将在下次提交时更新对应的远程对象
Parameters
- item: M
Returns void
Implementation of IWarehouseObjectList.update

Inherited from CoreList.update
- Defined in src/model/basic/CoreList.class.ts:141

updateRange

updateRange(...items: M[]): void
Parameters
- Rest ...items: M[]
Returns void
Implementation of IWarehouseObjectList.updateRange

Inherited from CoreList.updateRange
- Defined in src/model/basic/CoreList.class.ts:145

Class DisplayObjectList<M>

Type Parameters

M extends DisplayObject

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

M extends DisplayObject<M>

Parameters

stage: PxStage

options: { pane: string; }

pane: string

Returns DisplayObjectList<M>

Properties

Readonly $$isEmitter

$$parent

Readonly index

Readonly interactiveStateActionManager

Protected isBatching

Readonly itemKey

Readonly items

Readonly modeMgr

Readonly mounted

noEmit

Private options

Type declaration

pane: string

Readonly pane

Readonly paneObj

Readonly root

size

Private stage

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[]

options: {
pane: string;
}

`Readonly` $$isEmitter

`Readonly` index

`Readonly` interactiveStateActionManager

`Protected` isBatching

`Readonly` itemKey

`Readonly` items

`Readonly` modeMgr

`Readonly` mounted

`Private` options

`Readonly` pane

`Readonly` paneObj

`Readonly` root

`Private` stage

`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