Class Manager

Hierarchy

Manager

Implements

IManager

Index

Constructors

Properties

apiGetter disposed getter getterSub item monitor renderedEntities viewer visualsManager

Accessors

Methods

AddEntities ClearEntities Dispose Init ReRender RemoveEntities UpdateSettings doEntityCheck onGetterUpdate recreateGetter

Constructors

constructor

new Manager(params): EntitiesLoadedRenderManager.Manager
Parameters
- params: {
      apiGetter: IGetter;
      item: IEntitiesLoaded;
      monitor: Monitor;
      register: Register;
      viewer: Viewer;
  }
  - apiGetter: IGetter
  - item: IEntitiesLoaded
  - monitor: Monitor
  - register: Register
  - viewer: Viewer
Returns EntitiesLoadedRenderManager.Manager
- Defined in src/rendering/render-managers/entities/entities-loaded-render-manager.ts:32

Properties

`Private` apiGetter

apiGetter: IGetter

`Private` disposed

disposed: boolean = false

`Private` getter

getter: Getter<IEntity> = ...

`Private` getterSub

getterSub: (() => void) = ...

Type declaration

- (): void
- Returns void

`Private` item

item: IEntitiesLoaded

`Private` monitor

monitor: Monitor

`Private` renderedEntities

renderedEntities: IDictionary<boolean> = {}

`Private` viewer

viewer: Viewer

`Private` visualsManager

visualsManager: Register

Accessors

Disposed

get Disposed(): boolean
Returns boolean
Implementation of IManager.Disposed
- Defined in src/rendering/render-managers/entities/entities-loaded-render-manager.ts:26

Methods

AddEntities

AddEntities(params): void
Adds entities to menu item and queues the render for them. If the entity already exists in the menu item, it will be removed and redrawn.
Parameters
- params: {
  entities: IEntity[];
  }
  - entities: IEntity[]
Returns void
- Defined in src/rendering/render-managers/entities/entities-loaded-render-manager.ts:58

ClearEntities

ClearEntities(): void
Clears all entities from the menu item. Any visuals will be removed as well.

Returns void
- Defined in src/rendering/render-managers/entities/entities-loaded-render-manager.ts:113

Dispose

Dispose(): void
Returns void
Implementation of IManager.Dispose
- Defined in src/rendering/render-managers/entities/entities-loaded-render-manager.ts:170

Init

Init(): void
Must be sync so that experience related to enabling/disabling is easier to manage. If any async stuff needs to be loaded then it needs to be handled internally within the manager.

Returns void
Implementation of IManager.Init
- Defined in src/rendering/render-managers/entities/entities-loaded-render-manager.ts:125

ReRender

ReRender(params): Promise<void>
Parameters
- params: {
      entities?: IEntity[];
      entityIds?: string[];
      force?: boolean;
  }
  - Optional entities?: IEntity[]
  - Optional entityIds?: string[]
  - Optional force?: boolean
Returns Promise<void>
Implementation of IManager.ReRender
- Defined in src/rendering/render-managers/entities/entities-loaded-render-manager.ts:182

RemoveEntities

RemoveEntities(params): void
Removes entities from the menu item that match provided IDs. Any visuals will be removed as well.
Parameters
- params: {
  entityIds: string[];
  }
  - entityIds: string[]
Returns void
- Defined in src/rendering/render-managers/entities/entities-loaded-render-manager.ts:88

UpdateSettings

UpdateSettings(params): void
Parameters
- params: {
  queueRerender?: boolean;
  zoomControl?: IItem[];
  }
  - Optional queueRerender?: boolean
  - Optional zoomControl?: IItem[]
Returns void
- Defined in src/rendering/render-managers/entities/entities-loaded-render-manager.ts:215

`Private` doEntityCheck

doEntityCheck(ids, force?): Promise<void>
Parameters
- ids: string[]
- force: boolean = false
Returns Promise<void>
- Defined in src/rendering/render-managers/entities/entities-loaded-render-manager.ts:238

`Private` onGetterUpdate

onGetterUpdate(entities, force?): Promise<void>
Parameters
- entities: IEntity[]
- force: boolean = false
Returns Promise<void>
- Defined in src/rendering/render-managers/entities/entities-loaded-render-manager.ts:266

`Private` recreateGetter

recreateGetter(): void
Recreates the getter for the entities. This is used when the entities within the menu item are updated. @todo: this causes a bad side-effect where all menu item entities are queued for a re-render.

Returns void
- Defined in src/rendering/render-managers/entities/entities-loaded-render-manager.ts:149

Generated using TypeDoc