Protected Readonly_dataProtected Optional_detailProtected Optional_getReadonlycontentReadonlydataReadonlyentityReadonlyIS_ReadonlyIS_ReadonlyloadingOptional ReadonlymodalReadonlyparentReadonlyparentReadonlyreadReadonlyroutesReadonlysplitReadonlystructureReadonlyuniqueReadonlyvaluesReadonlyvariantReadonlyvariantsReadonlyvariesReadonlyvariesReadonlyvariesReadonlyworkspaceProtected_checkProtected_closeProtected_createProtected_determineProtected_getProtected_handleProtected_performProtected_readProtected_runProtected_updateAppends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Optionaloptions: boolean | AddEventListenerOptionsAppends a validation context to the workspace.
Callback method called when context is resolved.
Reference to the created Context Consumer Controller instance
Create a data scaffold
The arguments to create the scaffold.
The data of the scaffold.
A Promise with the reference to the Context Api Instance
Get the current data
The entity context
Get the name of a variant
OptionalvariantId: UmbVariantIdThe variant id
Get the parent
The parent entity
Get the parent unique
The parent unique identifier
Get the current value of the property with the given alias and variantId.
The alias of the property
OptionalvariantId: UmbVariantIdThe variant id of the property
The value or undefined if not set or found.
Get the unique
The unique identifier
Get the values of the content
Get the variant by the given variantId
The variant id
ProtectedinvalidGet an observable for the name of a variant
OptionalvariantId: UmbVariantIdThe variant id
An Observable to observe from.
Optionalcallback: ObserverCallback<SpecificT>Callback method called when data is changed.
OptionalcontrollerAlias: null | UmbControllerAliasDefine 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.
Reference to the created Observer Controller instance.
Observe the property type
The id of the property
The alias of the property
OptionalvariantId: UmbVariantIdThe variant
The API instance to be exposed.
Reference to the created Context Provider Controller instance
ProtectedsetSet the name of a variant
The name of the variant
OptionalvariantId: UmbVariantIdThe variant id
Set the value of the property with the given alias and variantId.
The alias of the property
The value to set
OptionalvariantId: UmbVariantIdThe variant id of the property
ProtectedvalidateGet the variant by the given variantId
The variant id
The data supplier for a Element Property Dataset