Class ExclusiveManager

Tracks layer exclusivity, added to every LayerCollection.

Hierarchy

ExclusiveManager

Index

Constructors

Methods

clear destroy getActiveLayersForGroup handleExclusiveGroupsChanged handleLayerActivated handleSplitDirectionChanged registerLayer unregisterLayer

Properties

Constructors

constructor

new ExclusiveManager(): ExclusiveManager
Returns ExclusiveManager

Methods

clear

clear(): void
Clears all layer groups

Returns void
- Defined in src/util/exclusiveManager.ts:107

destroy

destroy(): void
Destroys the ExclusiveManager

Returns void
- Defined in src/util/exclusiveManager.ts:114

getActiveLayersForGroup

getActiveLayersForGroup(group): Layer<LayerImplementation<VcsMap<VisualisationType>>>[]
Gets all layers in the given group
Parameters
- group: string
Returns Layer<LayerImplementation<VcsMap<VisualisationType>>>[]
- Defined in src/util/exclusiveManager.ts:90

handleExclusiveGroupsChanged

handleExclusiveGroupsChanged(layer): void
Parameters
- layer: Layer<LayerImplementation<VcsMap<VisualisationType>>>
Returns void
- Defined in src/util/exclusiveManager.ts:79

handleLayerActivated

handleLayerActivated(layer): void
handles the changing of a layer
Parameters
- layer: Layer<LayerImplementation<VcsMap<VisualisationType>>>
Returns void
- Defined in src/util/exclusiveManager.ts:55

handleSplitDirectionChanged

handleSplitDirectionChanged(layer): void
Parameters
- layer: Layer<LayerImplementation<VcsMap<VisualisationType>>>
Returns void
- Defined in src/util/exclusiveManager.ts:45

registerLayer

registerLayer(layer): void
registers a Layer as Exclusive, the activation of a layer triggers the deactivation of all other exclusive Layers. The layer collection adds exclusive layers to the manager on adding the layer to the collection.
Parameters
- layer: Layer<LayerImplementation<VcsMap<VisualisationType>>>
  
  layer to register
Returns void
- Defined in src/util/exclusiveManager.ts:15

unregisterLayer

unregisterLayer(layer): void
Removes a layer from tracking. Layer collections remove the layer once they are removed from them.
Parameters
- layer: Layer<LayerImplementation<VcsMap<VisualisationType>>>
  
  layer to unregister
Returns void
- Defined in src/util/exclusiveManager.ts:36

Properties

layers

layers: Map<string | symbol, Set<Layer<LayerImplementation<VcsMap<VisualisationType>>>>> = ...

Generated using TypeDoc