Class GroupManager<E>

constructor

• new GroupManager<E>(instance: JsPlumbInstance): GroupManager<E>

  Type Parameters

  • E

  Parameters

  • instance: JsPlumbInstance

  Returns GroupManager<E>

_connectionSourceMap

_connectionTargetMap

groupMap

instance

_updateConnectionsForGroup

• _updateConnectionsForGroup(group: UIGroup<E>): void

  Parameters

  • group: UIGroup<E>

  Returns void

addGroup

• addGroup(params: AddGroupOptions<E>): UIGroup<E>

  Parameters

  • params: AddGroupOptions<E>

  Returns UIGroup<E>

addToGroup

• addToGroup(
      group: string | UIGroup<E>,
      doNotFireEvent: boolean,
      ...el: E[],
  ): void

  Parameters

  • group: string | UIGroup<E>
  • doNotFireEvent: boolean
  • ...el: E[]

  Returns void

cascadeCollapse

• cascadeCollapse(
      collapsedGroup: UIGroup<E>,
      targetGroup: UIGroup<E>,
      collapsedIds: Set<string>,
  ): void

  Cascade a collapse from the given collapsedGroup into the given targetGroup.

  Parameters

  • collapsedGroup: UIGroup<E>
  • targetGroup: UIGroup<E>
  • collapsedIds: Set<string>

    Set of connection ids for already collapsed connections, which we can ignore.

  Returns void

collapseGroup

• collapseGroup(group: string | UIGroup<E>): void

  Parameters

  • group: string | UIGroup<E>

  Returns void

expandGroup

• expandGroup(group: string | UIGroup<E>, doNotFireEvent?: boolean): void

  Parameters

  • group: string | UIGroup<E>
  • OptionaldoNotFireEvent: boolean

  Returns void

forEach

• forEach(f: (g: UIGroup<E>) => any): void

  Parameters

  • f: (g: UIGroup<E>) => any

  Returns void

getAncestors

• getAncestors(group: UIGroup<E>): UIGroup<E>[]

  Parameters

  • group: UIGroup<E>

  Returns UIGroup<E>[]

getDescendants

• getDescendants(group: UIGroup<E>): UIGroup<E>[]

  Parameters

  • group: UIGroup<E>

  Returns UIGroup<E>[]

getGroup

• getGroup(groupId: string | UIGroup<E>): UIGroup<E>

  Parameters

  • groupId: string | UIGroup<E>

  Returns UIGroup<E>

getGroupFor

• getGroupFor(el: E): UIGroup<E>

  Parameters

  • el: E

  Returns UIGroup<E>

getGroups

• getGroups(): UIGroup<E>[]

  Returns UIGroup<E>[]

isAncestor

• isAncestor(group: UIGroup<E>, possibleAncestor: UIGroup<E>): boolean

  Tests if possibleAncestor is in fact an ancestor of group

  Parameters

  • group: UIGroup<E>
  • possibleAncestor: UIGroup<E>

  Returns boolean

isDescendant

• isDescendant(possibleDescendant: UIGroup<E>, ancestor: UIGroup<E>): boolean

  Parameters

  • possibleDescendant: UIGroup<E>
  • ancestor: UIGroup<E>

  Returns boolean

orphan

• orphan(el: E, doNotTransferToAncestor: boolean): { id: string; pos: PointXY }

  Parameters

  • el: E
  • doNotTransferToAncestor: boolean

  Returns { id: string; pos: PointXY }

removeAllGroups

• removeAllGroups(
      deleteMembers?: boolean,
      manipulateView?: boolean,
      doNotFireEvent?: boolean,
  ): void

  Parameters

  • OptionaldeleteMembers: boolean
  • OptionalmanipulateView: boolean
  • OptionaldoNotFireEvent: boolean

  Returns void

removeFromGroup

• removeFromGroup(
      group: string | UIGroup<E>,
      doNotFireEvent: boolean,
      ...el: E[],
  ): void

  Parameters

  • group: string | UIGroup<E>
  • doNotFireEvent: boolean
  • ...el: E[]

  Returns void

removeGroup

• removeGroup(
      group: string | UIGroup<E>,
      deleteMembers?: boolean,
      manipulateView?: boolean,
      doNotFireEvent?: boolean,
  ): Record<string, PointXY>

  Parameters

  • group: string | UIGroup<E>
  • OptionaldeleteMembers: boolean
  • OptionalmanipulateView: boolean
  • OptionaldoNotFireEvent: boolean

  Returns Record<string, PointXY>

repaintGroup

• repaintGroup(group: string | UIGroup<E>): void

  Parameters

  • group: string | UIGroup<E>

  Returns void

reset

• reset(): void

  Returns void

toggleGroup

• toggleGroup(group: string | UIGroup<E>): void

  Parameters

  • group: string | UIGroup<E>

  Returns void