Class UmbElementWorkspaceDataManager<ModelType>

Manages the workspace data for an entity. UmbEntityWorkspaceDataManager

Implements

Constructors

constructor

new UmbElementWorkspaceDataManager<ModelType extends UmbElementDetailModel>(
host: UmbControllerHost,
controllerAlias?: UmbControllerAlias,
): UmbElementWorkspaceDataManager
Type Parameters
- ModelType extends UmbElementDetailModel
Parameters
- host: UmbControllerHost
- OptionalcontrollerAlias: UmbControllerAlias
Returns UmbElementWorkspaceDataManager
Inherited from UmbEntityWorkspaceDataManager.constructor
- Defined in src/libs/class-api/class.mixin.ts:19

Properties

`Protected` `Readonly`_current

_current: UmbObjectState<undefined | ModelType> = ...

_host

_host: UmbControllerHost

`Protected` `Readonly`_persisted

_persisted: UmbObjectState<undefined | ModelType> = ...

`Protected` `Optional`_varies

_varies?: boolean

`Protected` `Optional`_variesByCulture

_variesByCulture?: boolean

`Protected` `Optional`_variesBySegment

_variesBySegment?: boolean

`Readonly`current

current: Observable<undefined | ModelType> = ...

Observable of the current data

Memberof

UmbEntityWorkspaceDataManager

`Readonly`persisted

persisted: Observable<undefined | ModelType> = ...

Observable of the persisted data

Memberof

UmbEntityWorkspaceDataManager

Accessors

controllerAlias

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

Methods

`Protected`_sortCurrentData

_sortCurrentData<GivenType extends Partial<ModelType> = Partial<ModelType>>(
persistedData: Partial<ModelType>,
currentData: GivenType,
): GivenType
Type Parameters
- GivenType extends Partial<ModelType> = Partial<ModelType>
Parameters
- persistedData: Partial<ModelType>
- currentData: GivenType
Returns GivenType
Overrides UmbEntityWorkspaceDataManager._sortCurrentData
- Defined in src/packages/content/content/manager/element-data-manager.ts:23

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 UmbEntityWorkspaceDataManager.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

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

clear

clear(): void
Clears the data

Returns void
Memberof
UmbSubmittableWorkspaceDataManager
Implementation of UmbWorkspaceDataManager.clear
Inherited from UmbEntityWorkspaceDataManager.clear
- Defined in src/packages/core/workspace/entity/entity-workspace-data-manager.ts:155

constructData

constructData(selectedVariants: UmbVariantId[]): Promise<ModelType>
Parameters
- selectedVariants: UmbVariantId[]
Returns Promise<ModelType>
- Defined in src/packages/content/content/manager/element-data-manager.ts:75

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 UmbEntityWorkspaceDataManager.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

createObservablePartOfCurrent

createObservablePartOfCurrent<ReturnType>(
mappingFunction: MappingFunction<undefined | ModelType, ReturnType>,
): Observable<ReturnType>
Creates an observable part of the current data
Type Parameters
- ReturnType
Parameters
- mappingFunction: MappingFunction<undefined | ModelType, ReturnType>
Returns Observable<ReturnType>
Memberof
UmbEntityWorkspaceDataManager
Implementation of UmbWorkspaceDataManager.createObservablePartOfCurrent
Inherited from UmbEntityWorkspaceDataManager.createObservablePartOfCurrent
- Defined in src/packages/core/workspace/entity/entity-workspace-data-manager.ts:123

createObservablePartOfPersisted

createObservablePartOfPersisted<ReturnType>(
mappingFunction: MappingFunction<undefined | ModelType, ReturnType>,
): Observable<ReturnType>
Creates an observable part of the persisted data
Type Parameters
- ReturnType
Parameters
- mappingFunction: MappingFunction<undefined | ModelType, ReturnType>
Returns Observable<ReturnType>
Memberof
UmbEntityWorkspaceDataManager
Implementation of UmbWorkspaceDataManager.createObservablePartOfPersisted
Inherited from UmbEntityWorkspaceDataManager.createObservablePartOfPersisted
- Defined in src/packages/core/workspace/entity/entity-workspace-data-manager.ts:73

destroy

destroy(): void
Returns void
Implementation of UmbWorkspaceDataManager.destroy
Inherited from UmbEntityWorkspaceDataManager.destroy
- Defined in src/packages/core/workspace/entity/entity-workspace-data-manager.ts:160

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 UmbEntityWorkspaceDataManager.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

finishPropertyValueChange

finishPropertyValueChange(): void
Returns void
- Defined in src/packages/content/content/manager/element-data-manager.ts:53

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 UmbEntityWorkspaceDataManager.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getCurrent

getCurrent(): undefined | ModelType
Gets the current data

Returns undefined | ModelType
Memberof
UmbSubmittableWorkspaceDataManager
Implementation of UmbWorkspaceDataManager.getCurrent
Inherited from UmbEntityWorkspaceDataManager.getCurrent
- Defined in src/packages/core/workspace/entity/entity-workspace-data-manager.ts:82

getHasUnpersistedChanges

getHasUnpersistedChanges(): boolean
Checks if there are unpersisted changes

Returns boolean
Memberof
UmbSubmittableWorkspaceDataManager
Implementation of UmbWorkspaceDataManager.getHasUnpersistedChanges
Inherited from UmbEntityWorkspaceDataManager.getHasUnpersistedChanges
- Defined in src/packages/core/workspace/entity/entity-workspace-data-manager.ts:132

getHostElement

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

getPersisted

getPersisted(): undefined | ModelType
Gets persisted data

Returns undefined | ModelType
Memberof
UmbSubmittableWorkspaceDataManager
Implementation of UmbWorkspaceDataManager.getPersisted
Inherited from UmbEntityWorkspaceDataManager.getPersisted
- Defined in src/packages/core/workspace/entity/entity-workspace-data-manager.ts:44

getUmbControllers

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

hasUmbController

hasUmbController(controller: UmbController): boolean
Parameters
- controller: UmbController
Returns boolean
Inherited from UmbEntityWorkspaceDataManager.hasUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:4

hostConnected

hostConnected(): void
Returns void
Implementation of UmbWorkspaceDataManager.hostConnected
Inherited from UmbEntityWorkspaceDataManager.hostConnected
- Defined in src/libs/controller-api/controller.interface.ts:4

hostDisconnected

hostDisconnected(): void
Returns void
Implementation of UmbWorkspaceDataManager.hostDisconnected
Inherited from UmbEntityWorkspaceDataManager.hostDisconnected
- Defined in src/libs/controller-api/controller.interface.ts:5

initiatePropertyValueChange

initiatePropertyValueChange(): void
Returns void
- Defined in src/packages/content/content/manager/element-data-manager.ts:45

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 UmbEntityWorkspaceDataManager.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 UmbEntityWorkspaceDataManager.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 UmbEntityWorkspaceDataManager.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

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

removeUmbControllerByAlias

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

resetCurrent

resetCurrent(): void
Resets the current data to the persisted data

Returns void
Memberof
UmbSubmittableWorkspaceDataManager
Implementation of UmbWorkspaceDataManager.resetCurrent
Inherited from UmbEntityWorkspaceDataManager.resetCurrent
- Defined in src/packages/core/workspace/entity/entity-workspace-data-manager.ts:147

setCurrent

setCurrent(data: undefined | ModelType): void
Sets the current data
Parameters
- data: undefined | ModelType
Returns void
Memberof
UmbSubmittableWorkspaceDataManager
Implementation of UmbWorkspaceDataManager.setCurrent
Inherited from UmbEntityWorkspaceDataManager.setCurrent
- Defined in src/packages/core/workspace/entity/entity-workspace-data-manager.ts:91

setPersisted

setPersisted(data: undefined | ModelType): void
Sets the persisted data
Parameters
- data: undefined | ModelType
Returns void
Memberof
UmbSubmittableWorkspaceDataManager
Implementation of UmbWorkspaceDataManager.setPersisted
Inherited from UmbEntityWorkspaceDataManager.setPersisted
- Defined in src/packages/core/workspace/entity/entity-workspace-data-manager.ts:53

setVaries

setVaries(vary: undefined | boolean): void
Parameters
- vary: undefined | boolean
Returns void
- Defined in src/packages/content/content/manager/element-data-manager.ts:71

setVariesByCulture

setVariesByCulture(vary: undefined | boolean): void
Parameters
- vary: undefined | boolean
Returns void
- Defined in src/packages/content/content/manager/element-data-manager.ts:63

setVariesBySegment

setVariesBySegment(vary: undefined | boolean): void
Parameters
- vary: undefined | boolean
Returns void
- Defined in src/packages/content/content/manager/element-data-manager.ts:67

updateCurrent

updateCurrent(partialData: Partial<ModelType>): void
Updates the current data
Parameters
- partialData: Partial<ModelType>
Returns void
Memberof
UmbSubmittableWorkspaceDataManager
Implementation of UmbWorkspaceDataManager.updateCurrent
Inherited from UmbEntityWorkspaceDataManager.updateCurrent
- Defined in src/packages/core/workspace/entity/entity-workspace-data-manager.ts:106

updatePersisted

updatePersisted(partialData: Partial<ModelType>): void
Updates the persisted data
Parameters
- partialData: Partial<ModelType>
Returns void
Memberof
UmbSubmittableWorkspaceDataManager
Implementation of UmbWorkspaceDataManager.updatePersisted
Inherited from UmbEntityWorkspaceDataManager.updatePersisted
- Defined in src/packages/core/workspace/entity/entity-workspace-data-manager.ts:62

Class UmbElementWorkspaceDataManager<ModelType>

Implements

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbElementWorkspaceDataManager

Properties

Protected Readonly_current

_host

Protected Readonly_persisted

Protected Optional_varies

Protected Optional_variesByCulture

Protected Optional_variesBySegment

Readonlycurrent

Memberof

Readonlypersisted

Memberof

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

Protected_sortCurrentData

Type Parameters

Parameters

Returns GivenType

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

clear

Returns void

Memberof

constructData

Parameters

Returns Promise<ModelType>

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

createObservablePartOfCurrent

Type Parameters

Parameters

Returns Observable<ReturnType>

Memberof

createObservablePartOfPersisted

Type Parameters

Parameters

Returns Observable<ReturnType>

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

finishPropertyValueChange

Returns void

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getCurrent

Returns undefined | ModelType

Memberof

getHasUnpersistedChanges

Returns boolean

`Protected` `Readonly`_current

`Protected` `Readonly`_persisted

`Protected` `Optional`_varies

`Protected` `Optional`_variesByCulture

`Protected` `Optional`_variesBySegment

`Readonly`current

`Readonly`persisted

`Protected`_sortCurrentData