Class UmbPropertyContext<ValueType>

This base provides the necessary for a class to become a context-api controller.

Type Parameters

ValueType = any

Hierarchy (View Summary)

UmbContextBase
- UmbPropertyContext

Constructors

constructor

new UmbPropertyContext<ValueType = any>(
host: UmbControllerHost,
): UmbPropertyContext<ValueType>
Type Parameters
- ValueType = any
Parameters
- host: UmbControllerHost
Returns UmbPropertyContext<ValueType>
Overrides UmbContextBase.constructor
- Defined in src/packages/core/property/components/property/property.context.ts:107

Properties

_host

_host: UmbControllerHost

`Readonly`alias

alias: Observable<undefined | string> = ...

`Readonly`dataPath

dataPath: Observable<undefined | string> = ...

`Readonly`description

description: Observable<undefined | string> = ...

`Readonly`editor

editor: Observable<undefined | UmbPropertyEditorUiElement> = ...

`Readonly`editorManifest

editorManifest: Observable<undefined | ManifestPropertyEditorUi> = ...

`Readonly`isReadOnly

isReadOnly: Observable<boolean> = ...

`Readonly`label

label: Observable<undefined | string> = ...

`Readonly`readOnlyState

readOnlyState: UmbReadOnlyStateManager<UmbState> = ...

`Readonly`validation

validation: Observable<undefined | UmbPropertyTypeValidationModel> = ...

`Readonly`validationMandatory

validationMandatory: Observable<undefined | boolean> = ...

`Readonly`validationMandatoryMessage

validationMandatoryMessage: Observable<undefined | null | string> = ...

`Readonly`value

value: Observable<undefined | ValueType> = ...

`Readonly`variantDifference

variantDifference: Observable<undefined | string> = ...

`Readonly`variantId

variantId: Observable<undefined | UmbVariantId> = ...

Accessors

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Inherited from UmbContextBase.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 UmbContextBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

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

clearValue

clearValue(): void
Clear the value of this property.

Returns void
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:374

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

destroy

destroy(): void
Returns void
Overrides UmbContextBase.destroy
- Defined in src/packages/core/property/components/property/property.context.ts:378

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

getAlias

getAlias(): undefined | string
Get the alias of this property.

Returns undefined | string
{(string | undefined)}

Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:214

getAppearance

getAppearance(): undefined | UmbPropertyTypeAppearanceModel
Get the appearance of this property.

Returns undefined | UmbPropertyTypeAppearanceModel
- the appearance properties of this property
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:268

getConfig

getConfig(): undefined | DataTypePropertyPresentationModel[]
Get the config of this property.

Returns undefined | DataTypePropertyPresentationModel[]
- Array of configurations for this property
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:305

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

getDataPath

getDataPath(): undefined | string
Returns undefined | string
- Defined in src/packages/core/property/components/property/property.context.ts:358

getDescription

getDescription(): undefined | string
Get the description of this property.

Returns undefined | string
{(string | undefined)}

Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:250

getEditor

getEditor(): undefined | UmbPropertyEditorUiElement
Get the property editor UI element for this property.

Returns undefined | UmbPropertyEditorUiElement
The property editor UI element
- Defined in src/packages/core/property/components/property/property.context.ts:78

getEditorManifest

getEditorManifest(): undefined | ManifestPropertyEditorUi
Get the property editor manifest for this property.

Returns undefined | ManifestPropertyEditorUi
The property editor manifest
- Defined in src/packages/core/property/components/property/property.context.ts:94

getHostElement

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

getIsReadOnly

getIsReadOnly(): boolean
Get the read only state of this property

Returns boolean
- If property is in read-only mode.
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:350

getLabel

getLabel(): undefined | string
Get the label of this property.

Returns undefined | string
- the label
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:232

getUmbControllers

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

getValidation

getValidation(): undefined | UmbPropertyTypeValidationModel
Get the validation of this property.

Returns undefined | UmbPropertyTypeValidationModel
- Object holding the Validation Properties.
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:341

getValue

getValue(): undefined | ValueType
Gets the current value of this property. Notice this is not reactive, you should us the value observable for that.

Returns undefined | ValueType
- the current value of this property
- Defined in src/packages/core/property/components/property/property.context.ts:287

getVariantId

getVariantId(): undefined | UmbVariantId
Get the variant ID of this property.

Returns undefined | UmbVariantId
- The property Variant ID, not necessary the same as the Property Dataset Context VariantId.
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:323

hasUmbController

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

hostConnected

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

hostDisconnected

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

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

removeUmbController

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

removeUmbControllerByAlias

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

resetValue

resetValue(): void
Reset the value of this property.

Returns void
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:366

setAlias

setAlias(alias: undefined | string): void
Set the alias of this property.
Parameters
- alias: undefined | string
  The alias of the property
Returns void
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:205

setAppearance

setAppearance(appearance: undefined | UmbPropertyTypeAppearanceModel): void
Set the appearance of this property.
Parameters
- appearance: undefined | UmbPropertyTypeAppearanceModel
  the appearance properties of this property
Returns void
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:259

setConfig

setConfig(config: undefined | DataTypePropertyPresentationModel[]): void
Set the config of this property.
Parameters
- config: undefined | DataTypePropertyPresentationModel[]
  Array of configurations for this property
Returns void
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:296

setDataPath

setDataPath(dataPath: undefined | string): void
Parameters
- dataPath: undefined | string
Returns void
- Defined in src/packages/core/property/components/property/property.context.ts:354

setDescription

setDescription(description: undefined | string): void
Set the description of this property.
Parameters
- description: undefined | string
Returns void
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:241

setEditor

setEditor(editorElement: undefined | UmbPropertyEditorUiElement): void
Set the property editor UI element for this property.
Parameters
- editorElement: undefined | UmbPropertyEditorUiElement
  The property editor UI element
Returns void
- Defined in src/packages/core/property/components/property/property.context.ts:70

setEditorManifest

setEditorManifest(manifest: undefined | ManifestPropertyEditorUi): void
Set the property editor manifest for this property.
Parameters
- manifest: undefined | ManifestPropertyEditorUi
  The property editor manifest
Returns void
- Defined in src/packages/core/property/components/property/property.context.ts:86

setLabel

setLabel(label: undefined | string): void
Set the label of this property.
Parameters
- label: undefined | string
  The label of the property
Returns void
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:223

setValidation

setValidation(validation: undefined | UmbPropertyTypeValidationModel): void
Set the validation of this property.
Parameters
- validation: undefined | UmbPropertyTypeValidationModel
  Object holding the Validation Properties.
Returns void
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:332

setValue

setValue(value: undefined | ValueType): void
Set the value of this property.
Parameters
- value: undefined | ValueType
  the whole value to be set
Returns void
- Defined in src/packages/core/property/components/property/property.context.ts:276

setVariantId

setVariantId(variantId: undefined | UmbVariantId): void
Set the variant ID of this property.
Parameters
- variantId: undefined | UmbVariantId
  The property Variant ID, not necessary the same as the Property Dataset Context VariantId.
Returns void
Memberof
UmbPropertyContext
- Defined in src/packages/core/property/components/property/property.context.ts:314

Class UmbPropertyContext<ValueType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbPropertyContext<ValueType>

Properties

_host

Readonlyalias

Readonlyappearance

Readonlyconfig

ReadonlyconfigValues

ReadonlydataPath

Readonlydescription

Readonlyeditor

ReadonlyeditorManifest

ReadonlyisReadOnly

Readonlylabel

ReadonlyreadOnlyState

Readonlyvalidation

ReadonlyvalidationMandatory

ReadonlyvalidationMandatoryMessage

Readonlyvalue

ReadonlyvariantDifference

ReadonlyvariantId

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

clearValue

Returns void

Memberof

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getAlias

Returns undefined | string

Memberof

getAppearance

Returns undefined | UmbPropertyTypeAppearanceModel

Memberof

getConfig

Returns undefined | DataTypePropertyPresentationModel[]

Memberof

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getDataPath

Returns undefined | string

getDescription

Returns undefined | string

Memberof

getEditor

Returns undefined | UmbPropertyEditorUiElement

getEditorManifest

Returns undefined | ManifestPropertyEditorUi

`Readonly`alias

`Readonly`appearance

`Readonly`config

`Readonly`configValues

`Readonly`dataPath

`Readonly`description

`Readonly`editor

`Readonly`editorManifest

`Readonly`isReadOnly

`Readonly`label

`Readonly`readOnlyState

`Readonly`validation

`Readonly`validationMandatory

`Readonly`validationMandatoryMessage

`Readonly`value

`Readonly`variantDifference

`Readonly`variantId