Class UmbSelectionManager<ValueType>

Manages the selection of items. UmbSelectionManager

Type Parameters

ValueType extends string | null = string | null

Hierarchy (View Summary)

UmbControllerBase
- UmbSelectionManager

Constructors

constructor

new UmbSelectionManager<ValueType extends null | string = null | string>(
host: UmbControllerHost,
): UmbSelectionManager<ValueType>
Type Parameters
- ValueType extends null | string = null | string
Parameters
- host: UmbControllerHost
Returns UmbSelectionManager<ValueType>
Overrides UmbControllerBase.constructor
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:24

Properties

_host

_host: UmbControllerHost

`Readonly`hasSelection

hasSelection: Observable<boolean> = ...

`Readonly`multiple

multiple: Observable<boolean> = ...

`Readonly`selectable

selectable: Observable<boolean> = ...

`Readonly`selection

selection: Observable<ValueType[]> = ...

Accessors

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Inherited from UmbControllerBase.controllerAlias
- Defined in src/libs/controller-api/controller.interface.ts:3

Methods

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from UmbControllerBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbControllerBase.addUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:6

clearSelection

clearSelection(): void
Clears the current selection.

Returns void
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:158

consumeContext

consumeContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    callback: UmbContextCallback<ResultType>,
): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- callback: UmbContextCallback<ResultType>
  Callback method called when context is resolved.
Returns UmbContextConsumerController<BaseType, ResultType>
Reference to the created Context Consumer Controller instance

Description
Setup a subscription for a context. The callback is called when the context is resolved.

Memberof
UmbClassInterface
Inherited from UmbControllerBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

deselect

deselect(unique: ValueType): void
Removes the given unique id from the current selection.
Parameters
- unique: ValueType
Returns void
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:136

destroy

destroy(): void
Returns void
Inherited from UmbControllerBase.destroy
- Defined in src/libs/controller-api/controller.interface.ts:6

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from UmbControllerBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

getAllowLimitation

getAllowLimitation(): (unique: ValueType) => boolean
Returns the function that determines if an item is selectable or not.

Returns (unique: ValueType) => boolean
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:177

getContext

getContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    options?: UmbClassGetContextOptions,
): Promise<undefined | ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- Optionaloptions: UmbClassGetContextOptions
Returns Promise<undefined | ResultType>
A Promise with the reference to the Context Api Instance

Description
Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.

Memberof
UmbClassInterface
Inherited from UmbControllerBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getHostElement

getHostElement(): Element
Returns Element
Inherited from UmbControllerBase.getHostElement
- Defined in src/libs/controller-api/controller-host.interface.ts:9

getMultiple

getMultiple(): boolean
Returns whether multiple items can be selected.

Returns boolean
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:79

getSelectable

getSelectable(): boolean
Returns whether items can be selected.

Returns boolean
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:33

getSelection

getSelection(): ValueType[]
Returns the current selection.

Returns ValueType[]
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:51

getUmbControllers

getUmbControllers(
filterMethod: (ctrl: UmbController) => boolean,
): UmbController[]
Parameters
- filterMethod: (ctrl: UmbController) => boolean
Returns UmbController[]
Inherited from UmbControllerBase.getUmbControllers
- Defined in src/libs/controller-api/controller-host.interface.ts:5

isSelected

isSelected(unique: ValueType): boolean
Returns true if the given unique id is selected.
Parameters
- unique: ValueType
Returns boolean
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:150

observe

observe<
    ObservableType extends undefined
    | Observable<T>,
    T,
    SpecificT = ObservableType extends Observable<U>
        ? ObservableType<ObservableType> extends undefined ? undefined | U : U
        : undefined,
    SpecificR = ObservableType extends undefined
        ? undefined
        | UmbObserverController<SpecificT>
        : UmbObserverController<SpecificT>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: null | UmbControllerAlias,
): SpecificR
Type Parameters
- ObservableType extends undefined | Observable<T>
- T
- SpecificT = ObservableType extends Observable<U>
  ? ObservableType<ObservableType> extends undefined ? undefined | U : U
  : undefined
- SpecificR = ObservableType extends undefined
      ? undefined
      | UmbObserverController<SpecificT>
      : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
  Define an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
Returns SpecificR
Reference to the created Observer Controller instance.

Description
Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState.

Memberof
UmbClassInterface
Inherited from UmbControllerBase.observe
- Defined in src/libs/class-api/class.interface.ts:27

provideContext

provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R extends UmbContextMinimal = UmbContextMinimal
Parameters
- alias: string | UmbContextToken<R, R>
- instance: R
  The API instance to be exposed.
Returns UmbContextProviderController<R>
Reference to the created Context Provider Controller instance

Description
Provide a context API for this or child elements.

Memberof
UmbClassInterface
Inherited from UmbControllerBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from UmbControllerBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

removeUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbControllerBase.removeUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:8

removeUmbControllerByAlias

removeUmbControllerByAlias(unique: UmbControllerAlias): void
Parameters
- unique: UmbControllerAlias
Returns void
Inherited from UmbControllerBase.removeUmbControllerByAlias
- Defined in src/libs/controller-api/controller-host.interface.ts:7

select

select(unique: ValueType): void
Appends the given unique id to the current selection.
Parameters
- unique: ValueType
Returns void
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:119

setAllowLimitation

setAllowLimitation(compareFn: (unique: ValueType) => boolean): void
Sets a function that determines if an item is selectable or not.
Parameters
- compareFn: (unique: ValueType) => boolean
  A function that determines if an item is selectable or not.
Returns void
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:168

setMultiple

setMultiple(value: boolean): void
Sets whether multiple items can be selected.
Parameters
- value: boolean
Returns void
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:88

setSelectable

setSelectable(value: boolean): void
Sets whether items can be selected.
Parameters
- value: boolean
Returns void
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:42

setSelection

setSelection(value: ValueType[]): void
Sets the current selection.
Parameters
- value: ValueType[]
Returns void
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:60

toggleSelect

toggleSelect(unique: ValueType): void
Toggles the given unique id in the current selection.
Parameters
- unique: ValueType
Returns void
Memberof
UmbSelectionManager
- Defined in src/packages/core/utils/selection-manager/selection.manager.ts:105

Class UmbSelectionManager<ValueType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbSelectionManager<ValueType>

Properties

_host

ReadonlyhasSelection

Readonlymultiple

Readonlyselectable

Readonlyselection

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

clearSelection

Returns void

Memberof

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

deselect

Parameters

Returns void

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getAllowLimitation

Returns (unique: ValueType) => boolean

Memberof

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getMultiple

Returns boolean

Memberof

getSelectable

Returns boolean

Memberof

getSelection

Returns ValueType[]

Memberof

getUmbControllers

Parameters

Returns UmbController[]

hasUmbController

Parameters

Returns boolean

hostConnected

Returns void

hostDisconnected

Returns void

isSelected

Parameters

Returns boolean

`Readonly`hasSelection

`Readonly`multiple

`Readonly`selectable

`Readonly`selection