Class SelectionService<M>

Type parameters

M = unknown

Hierarchy

Service<M>
- SelectionService

Index

Constructors

constructor

Properties

Accessors

attached

Constructors

constructor

new SelectionService<M>(): SelectionService<M>

Overrides Service.constructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:8
Type parameters
- M = unknown
Returns SelectionService<M>

Properties

Optional Readonly observerType

observerType: Class<SelectionServiceObserver<M, SelectionService<M>>>

Readonly observers

observers: readonly SelectionServiceObserver<M, SelectionService<M>>[]

Readonly roots

roots: readonly M[]

Readonly selections

selections: readonly Model[]

Accessors

attached

get attached(): boolean

- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:16
Returns boolean

Methods

attachRoot

attachRoot(root: M): void

Inherited from Service.attachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:8
Parameters
- root: M
Returns void

detachRoot

detachRoot(root: M): void

Inherited from Service.detachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:12
Parameters
- root: M
Returns void

Protected didAttach

didAttach(): void

Inherited from Service.didAttach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:19
Returns void

Protected didAttachRoot

didAttachRoot(root: M): void

Inherited from Service.didAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:11
Parameters
- root: M
Returns void

Protected didDetach

didDetach(): void

Inherited from Service.didDetach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:22
Returns void

Protected didDetachRoot

didDetachRoot(root: M): void

Inherited from Service.didDetachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:15
Parameters
- root: M
Returns void

Protected didObserve

didObserve(observer: SelectionServiceObserver<M, SelectionService<M>>): void

Inherited from Service.didObserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:27
Parameters
- observer: SelectionServiceObserver<M, SelectionService<M>>
Returns void

Protected didSelect

didSelect(model: Model, index: number, options: null | SelectionOptions): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:15
Parameters
- model: Model
- index: number
- options: null | SelectionOptions
Returns void

Protected didUnobserve

didUnobserve(observer: SelectionServiceObserver<M, SelectionService<M>>): void

Inherited from Service.didUnobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:31
Parameters
- observer: SelectionServiceObserver<M, SelectionService<M>>
Returns void

Protected didUnselect

didUnselect(model: Model): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:19
Parameters
- model: Model
Returns void

Protected forEachObserver

forEachObserver<T>(callback: (observer: SelectionServiceObserver<M, SelectionService<M>>) => void | T): undefined | T

Inherited from Service.forEachObserver
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:32
Type parameters
- T
Parameters
- callback: (observer: SelectionServiceObserver<M, SelectionService<M>>) => void | T
  - - (observer: SelectionServiceObserver<M, SelectionService<M>>): void | T
    - Parameters
      - observer: SelectionServiceObserver<M, SelectionService<M>>
      Returns void | T
Returns undefined | T

isSelected

isSelected(model: Model): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:11
Parameters
- model: Model
Returns boolean

observe

observe(observer: SelectionServiceObserver<M, SelectionService<M>>): void

Inherited from Service.observe
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:24
Parameters
- observer: SelectionServiceObserver<M, SelectionService<M>>
Returns void

Protected onAttach

onAttach(): void

Inherited from Service.onAttach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:18
Returns void

Protected onAttachRoot

onAttachRoot(root: M): void

Inherited from Service.onAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:10
Parameters
- root: M
Returns void

Protected onDetach

onDetach(): void

Inherited from Service.onDetach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:21
Returns void

Protected onDetachRoot

onDetachRoot(root: M): void

Inherited from Service.onDetachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:14
Parameters
- root: M
Returns void

Protected onObserve

onObserve(observer: SelectionServiceObserver<M, SelectionService<M>>): void

Inherited from Service.onObserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:26
Parameters
- observer: SelectionServiceObserver<M, SelectionService<M>>
Returns void

Protected onSelect

onSelect(model: Model, index: number, options: null | SelectionOptions): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:14
Parameters
- model: Model
- index: number
- options: null | SelectionOptions
Returns void

Protected onUnobserve

onUnobserve(observer: SelectionServiceObserver<M, SelectionService<M>>): void

Inherited from Service.onUnobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:30
Parameters
- observer: SelectionServiceObserver<M, SelectionService<M>>
Returns void

Protected onUnselect

onUnselect(model: Model): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:18
Parameters
- model: Model
Returns void

select

select(model: Model, options?: null | SelectionOptions, index?: number): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:12
Parameters
- model: Model
- Optional options: null | SelectionOptions
- Optional index: number
Returns void

toggle

toggle(model: Model, options?: null | SelectionOptions, index?: number): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:21
Parameters
- model: Model
- Optional options: null | SelectionOptions
- Optional index: number
Returns void

unobserve

unobserve(observer: SelectionServiceObserver<M, SelectionService<M>>): void

Inherited from Service.unobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:28
Parameters
- observer: SelectionServiceObserver<M, SelectionService<M>>
Returns void

unselect

unselect(model: Model): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:16
Parameters
- model: Model
Returns void

unselectAll

unselectAll(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:20
Returns void

Protected willAttach

willAttach(): void

Inherited from Service.willAttach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:17
Returns void

Protected willAttachRoot

willAttachRoot(root: M): void

Inherited from Service.willAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:9
Parameters
- root: M
Returns void

Protected willDetach

willDetach(): void

Inherited from Service.willDetach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:20
Returns void

Protected willDetachRoot

willDetachRoot(root: M): void

Inherited from Service.willDetachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:13
Parameters
- root: M
Returns void

Protected willObserve

willObserve(observer: SelectionServiceObserver<M, SelectionService<M>>): void

Inherited from Service.willObserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:25
Parameters
- observer: SelectionServiceObserver<M, SelectionService<M>>
Returns void

Protected willSelect

willSelect(model: Model, index: number, options: null | SelectionOptions): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:13
Parameters
- model: Model
- index: number
- options: null | SelectionOptions
Returns void

Protected willUnobserve

willUnobserve(observer: SelectionServiceObserver<M, SelectionService<M>>): void

Inherited from Service.willUnobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:29
Parameters
- observer: SelectionServiceObserver<M, SelectionService<M>>
Returns void

Protected willUnselect

willUnselect(model: Model): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:17
Parameters
- model: Model
Returns void

Static global

global<M>(): SelectionService<M>

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionService.d.ts:22
Type parameters
- M
Returns SelectionService<M>

Generated using TypeDoc