Class EntitiesManager

Constructors

constructor

new EntitiesManager(_app): EntitiesManager
Parameters
- _app: App
Returns EntitiesManager
- Defined in src/ts/managers/entitiesManager/index.ts:86

Accessors

entities

get entities(): Entity<Spec>[]
Returns Entity<Spec>[]
- Defined in src/ts/managers/entitiesManager/index.ts:42

entityMap

get entityMap(): Map<string, Entity<Spec>>
Returns Map<string, Entity<Spec>>
- Defined in src/ts/managers/entitiesManager/index.ts:46

hoveredEntity

get hoveredEntity(): null | Entity<Spec>
Returns null | Entity<Spec>
- Defined in src/ts/managers/entitiesManager/index.ts:82
set hoveredEntity(value): void
Parameters
- value: null | Entity<Spec>
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:73

selectedEntity

get selectedEntity(): null | Entity<Spec>
Returns null | Entity<Spec>
- Defined in src/ts/managers/entitiesManager/index.ts:69
set selectedEntity(value): void
Parameters
- value: null | Entity<Spec>
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:50

Methods

applyColorToLabel

applyColorToLabel(label, fill): void
Parameters
- label: Group
- fill: string
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:451

applyMessageFlows

applyMessageFlows(messageFlows): void
Parameters
- messageFlows: Nullable<{
      connectionConfiguration: {
          source: string;
          targets: {
              connection: string;
              type: string;
          }[];
      }[];
  }>
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:474

clear

clear(): void
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:129

conditionOnClick

conditionOnClick(params): void
Parameters
- params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:151

deleteEntity

deleteEntity(entity): void
Parameters
- entity: Entity<Spec>
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:404

entityDisplayAnchors

entityDisplayAnchors(params): void
Parameters
- params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:312

entityHideAnchors

entityHideAnchors(params): void
Parameters
- params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:319

entityOnHover

entityOnHover(params): void
Parameters
- params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:297

entityOnLeave

entityOnLeave(_params): void
Parameters
- _params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:327

eventOnClick

eventOnClick(params): void
Parameters
- params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:285

focusOn

focusOn(entity): void
Parameters
- entity: Entity<Spec>
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:445

gateWayOnClick

gateWayOnClick(params): void
Parameters
- params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:281

getEntityById

getEntityById(id): null | Entity<Spec>
Parameters
- id: string
Returns null | Entity<Spec>
- Defined in src/ts/managers/entitiesManager/index.ts:125

hideAllEntitiesAnchors

hideAllEntitiesAnchors(): void
Hide the anchors of all entities

Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:521

highlightLink

highlightLink(link): void
Parameters
- link: Entity<Spec>
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:375

hoverLink

hoverLink(link): void
Parameters
- link: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:352

initialize

initialize(): void
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:121

labelOnClick

labelOnClick(_params): void
Parameters
- _params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:159

labelStartEdition

labelStartEdition(entity, label?): void
Parameters
- entity: Entity<Spec>
- Optionallabel: LabelContainer
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:386

labelViewOnClick

labelViewOnClick(params): void
Parameters
- params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:146

laneAddEntityButtonOnClick

laneAddEntityButtonOnClick(__namedParameters): void
Parameters
- __namedParameters: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:241

laneOnHover

laneOnHover(params): void
Parameters
- params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:304

lanePoolLabelOnClick

lanePoolLabelOnClick(__namedParameters): void
Handle lane or pool click event

This method also makes the distinction between single and double click events
Parameters
- __namedParameters: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:217

loadUI

loadUI(): void
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:138

planeOnClick

planeOnClick(e): void
Parameters
- e: {
  e: KonvaEventObject<MouseEvent>;
  }
  - e: KonvaEventObject<MouseEvent>
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:249

planeOpenContextMenu

planeOpenContextMenu(params): void
Parameters
- params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:260

poolHitBoxOnMouseMove

poolHitBoxOnMouseMove(e, entity): void
Parameters
- e: MouseEvent
- entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:170

poolOnClick

poolOnClick(e, entity): void
Parameters
- e: KonvaEventObject<MouseEvent>
- entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:163

poolOnMouseEnter

poolOnMouseEnter(e, entity): void
Parameters
- e: MouseEvent
- entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:178

poolOnMouseLeave

poolOnMouseLeave(e, entity): void
Parameters
- e: MouseEvent
- entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:189

poolOnMouseMove

poolOnMouseMove(e, entity): void
Parameters
- e: MouseEvent
- entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:199

poolUnselect

poolUnselect(): void
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:208

resetMouseCursor

resetMouseCursor(): void
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:293

selectEntity

selectEntity(entity): void
Parameters
- entity: Nullable<Entity<Spec>>
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:398

selectFocus

selectFocus(params): void
Parameters
- params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:340

selectFromId

selectFromId(entityId): boolean
Parameters
- entityId: string
Returns boolean
- Defined in src/ts/managers/entitiesManager/index.ts:410

setMouseCursorPointer

setMouseCursorPointer(): void
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:289

startEntityLabelEdition

startEntityLabelEdition(shapeId): void
Focus a given entity and start the label edition (display the edition textarea)
Parameters
- shapeId: string
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:463

taskOnClick

taskOnClick(params): void
Parameters
- params: {
  e: KonvaEventObject<MouseEvent>;
  entity: BaseEntity;
  }
  - e: KonvaEventObject<MouseEvent>
  - entity: BaseEntity
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:155

toggleFocusablePlanes

toggleFocusablePlanes(focusable?): void
Enable or disable planes focus

When disabled, planes won't be focusable and won't be highlighted when hovered, clicking on a plane label won't display its related context menu

You can use the VITE_PLANES_SELECTION_ENABLED env variable as well
Parameters
- focusable: boolean = !Config.PLANES_SELECTION_ENABLED
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:501

unHoverLink

unHoverLink(): void
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:382

updateEntitiesAnnotations

updateEntitiesAnnotations(): void
Returns void
- Defined in src/ts/managers/entitiesManager/index.ts:98