Class Warehouse<LayoutData>

Todo

Use Constructor as the Map key of TypedLists, thus we don't need a name for every list
While calling add on List, should see if it has $$parent, and call $$parent.add ? So does remove & update
Should I define fields with structure of map & set on warehouse to store the items added in order to find & iterate?

Type Parameters

LayoutData = any

Hierarchy

WarehouseBase
- Warehouse
  - WikWarehouse

Constructors

constructor

new Warehouse<LayoutData>(): Warehouse<LayoutData>
Type Parameters
- LayoutData = any
Returns Warehouse<LayoutData>
Inherited from WarehouseBase.constructor
- Defined in node_modules/eventemitter3/index.d.ts:88

Properties

`Readonly` $$isEmitter

$$isEmitter: true

`Readonly` animationManager

animationManager: AnimationManager

`Readonly` globalConsts

globalConsts: GlobalConstManager

`Readonly` highlightManager

highlightManager: HighlightManager

`Readonly` imageManager

imageManager: ImageManager

injector

injector: IInjector

`Readonly` interactiveStateActionManager

interactiveStateActionManager: InteractiveStateActionManager

`Readonly` layouted

layouted: boolean = false

`Readonly` logger

logger: ILogger

`Readonly` modeManager

modeManager: IModeManager

`Readonly` mounted

mounted: boolean = false

noEmit

noEmit: boolean

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

`Readonly` paneManager

paneManager: PaneManager

`Readonly` root

root: WikMap = null

`Readonly` selectionManager

selectionManager: ISelectionManager

Methods

$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 WarehouseBase.$set
- Defined in src/model/basic/Core.class.ts:7

$type

$type(type: string, ...args: any[]): IWarehouseObjectList<GraphicObject, never>
Parameters
- type: string
- Rest ...args: any[]
Returns IWarehouseObjectList<GraphicObject, never>
Inherited from WarehouseBase.$type
- Defined in src/model/WarehouseBase.class.ts:116

$untype

$untype(type: string): void
Parameters
- type: string
Returns void
Inherited from WarehouseBase.$untype
- Defined in src/model/WarehouseBase.class.ts:137

[iterator]

[iterator](): Generator<GraphicObject, void, unknown>
Returns Generator<GraphicObject, void, unknown>
Inherited from WarehouseBase.[iterator]
- Defined in src/model/WarehouseBase.class.ts:56

add

add<M>(type: string, item: M): M
Type Parameters
- M extends GraphicObject
Parameters
- type: string
- item: M
Returns M
Inherited from WarehouseBase.add
- Defined in src/model/WarehouseBase.class.ts:191

addUpdateDep

addUpdateDep<M, D>(type: string, fn?: ItemUpdateFn<M, D>): void
Type Parameters
- M extends GraphicObject = GraphicObject
- D = any
Parameters
- type: string
- fn: ItemUpdateFn<M, D> = null
Returns void
Inherited from WarehouseBase.addUpdateDep
- Defined in src/model/WarehouseBase.class.ts:255

clear

clear(type: string): void
Parameters
- type: string
Returns void
Inherited from WarehouseBase.clear
- Defined in src/model/WarehouseBase.class.ts:233

configModes

configModes(): Record<string, IBehavior[]>
Returns Record<string, IBehavior[]>
Overrides WarehouseBase.configModes
- Defined in src/2d/Warehouse.class.ts:76

create

create<C>(ctor: C, ...args: ConstructorParameters<C>): InstanceType<C>
Type Parameters
- C extends Constructor<object, C>
Parameters
- ctor: C
- Rest ...args: ConstructorParameters<C>
Returns InstanceType<C>
Inherited from WarehouseBase.create
- Defined in src/model/WarehouseBase.class.ts:239

createList

createList(list: ListCtorArgs | LayerList<LayerWithID, never>): any
Parameters
- list: ListCtorArgs | LayerList<LayerWithID, never>
Returns any
Overrides WarehouseBase.createList
- Defined in src/2d/Warehouse.class.ts:99

dispose

dispose(): void
Returns void
Inherited from WarehouseBase.dispose
- Defined in src/model/WarehouseBase.class.ts:253

each

each(fn: ((item: GraphicObject, type: string) => void), type?: string): void
Parameters
- fn: ((item: GraphicObject, type: string) => void)
  - - (item: GraphicObject, type: string): void
    - Parameters
      
      item: GraphicObject
      
      type: string
      
      Returns void
- Optional type: string
Returns void
Inherited from WarehouseBase.each
- Defined in src/model/WarehouseBase.class.ts:162

fire

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

fire$n

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

first

first<M>(type: string): M
Type Parameters
- M extends GraphicObject
Parameters
- type: string
Returns M
Inherited from WarehouseBase.first
- Defined in src/model/WarehouseBase.class.ts:171

getLayoutData

getLayoutData(): Promise<any>
Returns Promise<any>
Inherited from WarehouseBase.getLayoutData
- Defined in src/model/WarehouseBase.class.ts:243

item

item(type: string, id: string): GraphicObject
Parameters
- type: string
- id: string
Returns GraphicObject
Inherited from WarehouseBase.item
- Defined in src/model/WarehouseBase.class.ts:181

layout

layout(data?: LayoutData): void | Promise<void>
Parameters
- Optional data: LayoutData
Returns void | Promise<void>
Overrides WarehouseBase.layout
- Defined in src/2d/Warehouse.class.ts:97

listen

listen<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): Warehouse<LayoutData>
on
Type Parameters
- T extends WarehouseBaseEventType
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 Warehouse<LayoutData>
Inherited from WarehouseBase.listen
- Defined in src/model/basic/Emitter.ts:155

listen$1

listen$1<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): Warehouse<LayoutData>
once
Type Parameters
- T extends WarehouseBaseEventType
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 Warehouse<LayoutData>
Inherited from WarehouseBase.listen$1
- Defined in src/model/basic/Emitter.ts:172

listen$n

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

mount

mount(map: WikMap): void
Parameters
- map: WikMap
Returns void
Overrides WarehouseBase.mount
- Defined in src/2d/Warehouse.class.ts:31

query

query<M>(type: string, predicate: ((item: M) => boolean)): M[]
Type Parameters
- M extends GraphicObject
Parameters
- type: string
- predicate: ((item: M) => boolean)
  - - (item: M): boolean
    - Parameters
      
      item: M
      
      Returns boolean
Returns M[]
Inherited from WarehouseBase.query
- Defined in src/model/WarehouseBase.class.ts:185

queryList

queryList(type: string): IList<GraphicObject>
Parameters
- type: string
Returns IList<GraphicObject>
Inherited from WarehouseBase.queryList
- Defined in src/model/WarehouseBase.class.ts:158

queryListAll

queryListAll(): GueryListAllReturns
Returns GueryListAllReturns
Inherited from WarehouseBase.queryListAll
- Defined in src/model/WarehouseBase.class.ts:149

readOnly

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

remove

remove(type: string, item: string | GraphicObject): void
Parameters
- type: string
- item: string | GraphicObject
Returns void
Inherited from WarehouseBase.remove
- Defined in src/model/WarehouseBase.class.ts:219

setEventChild

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

setEventParent

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

unlisten

unlisten<T>(event: T, fn?: ((event: WikEvent<any, any>) => void)): Warehouse<LayoutData>
off
Type Parameters
- T extends WarehouseBaseEventType
Parameters
- event: T
- Optional fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns Warehouse<LayoutData>
Inherited from WarehouseBase.unlisten
- Defined in src/model/basic/Emitter.ts:163

unlisten$n

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

unmount

unmount(): void
Returns void
Overrides WarehouseBase.unmount
- Defined in src/2d/Warehouse.class.ts:74

update

update(type: string, item: GraphicObject, data: any): void
Parameters
- type: string
- item: GraphicObject
- data: any
Returns void
Inherited from WarehouseBase.update
- Defined in src/model/WarehouseBase.class.ts:207

Class Warehouse<LayoutData>

Todo

Type Parameters

LayoutData = any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

LayoutData = any

Returns Warehouse<LayoutData>

Properties

Readonly $$isEmitter

Readonly animationManager

Readonly globalConsts

Readonly highlightManager

Readonly imageManager

injector

Readonly interactiveStateActionManager

Readonly layouted

Readonly logger

Readonly modeManager

Readonly mounted

noEmit

Readonly paneManager

Readonly root

Readonly selectionManager

Methods

$set

Parameters

pairs: string | Record<string, any>

Optional value: any

Optional context: object

Returns void

$type

Parameters

type: string

Rest ...args: any[]

Returns IWarehouseObjectList<GraphicObject, never>

$untype

Parameters

type: string

Returns void

[iterator]

Returns Generator<GraphicObject, void, unknown>

add

Type Parameters

M extends GraphicObject

Parameters

type: string

item: M

Returns M

addUpdateDep

Type Parameters

M extends GraphicObject = GraphicObject

D = any

Parameters

type: string

fn: ItemUpdateFn<M, D> = null

Returns void

clear

Parameters

type: string

Returns void

configModes

Returns Record<string, IBehavior[]>

create

Type Parameters

C extends Constructor<object, C>

Parameters

ctor: C

Rest ...args: ConstructorParameters<C>

Returns InstanceType<C>

createList

Parameters

list: ListCtorArgs | LayerList<LayerWithID, never>

Returns any

`Readonly` $$isEmitter

`Readonly` animationManager

`Readonly` globalConsts

`Readonly` highlightManager

`Readonly` imageManager

`Readonly` interactiveStateActionManager

`Readonly` layouted

`Readonly` logger

`Readonly` modeManager

`Readonly` mounted

`Readonly` paneManager

`Readonly` root

`Readonly` selectionManager

`Optional` value: any

`Optional` context: object

`Rest` ...args: any[]

`Rest` ...args: ConstructorParameters<C>

`Optional` type: string

`Optional` payload: PlainObject

`Optional` payload: PlainObject

`Optional` data: LayoutData

`Optional` context: any

`Optional` context: any