ReadonlyaliasReadonlyappearanceReadonlyconfigReadonlyconfigReadonlydataReadonlydescriptionReadonlyeditorReadonlyeditorReadonlyeditorReadonlyisReadonlylabelReadonlyreadReadonlyvalidationReadonlyvalidationReadonlyvalidationReadonlyvalueReadonlyvariantReadonlyvariantThe addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Optionaloptions: boolean | AddEventListenerOptionsCallback method called with the resolved context instance or undefined.
Reference to the created Context Consumer Controller instance
Subscribe to a context. The callback fires when the context resolves, again if the context is replaced, and can also be invoked with undefined if the context is unprovided or the host disconnects. Use this whenever a controller or element needs the context at setup time — both for ongoing observation and for reading values immediately on resolve. This is the default choice; prefer it over getContext unless the context is only needed inside a later user action.
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
Get the appearance of this property.
Get the config of this property.
Optionaloptions: UmbClassGetContextOptionsOptions for resolving the context once, including timeout-related behavior such as preventTimeout.
A Promise resolving to the Context API instance when available, or undefined when applicable.
Retrieve a context once as a Promise. Use this only when the context is first needed inside a user action or event handler that runs later (for example a button click, a property action, or an entity action execute()). For setup-time access — including a single immediate read — use consumeContext instead so the controller lifecycle handles resolution and cleanup. The returned Promise may reject if the context is not found before the default timeout; callers should handle rejection and/or pass preventTimeout in the options when waiting longer is expected.
Get the property editor UI element for this property.
The property editor UI element
Get the editor data source alias for this property.
The editor data source alias for this property.
Get the property editor manifest for this property.
The property editor manifest
Get the validation of this property.
Gets the current value of this property.
Notice this is not reactive, you should us the value observable for that.
Get the variant ID of this property.
An Observable to observe from.
Optionalcallback: ObserverCallback<SpecificT>Callback method called when data is changed.
OptionalcontrollerAlias: UmbControllerAlias | nullDefine 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.
The API instance to be exposed.
Reference to the created Context Provider Controller instance
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
Optionaloptions: boolean | EventListenerOptionsSet the appearance of this property.
the appearance properties of this property
Set the config of this property.
Array of configurations for this property
Set the property editor UI element for this property.
The property editor UI element
Set the editor data source alias for this property.
The data source alias to set
Set the property editor manifest for this property.
The property editor manifest
Set the validation of this property.
Object holding the Validation Properties.
Set the value of this property.
the whole value to be set
Set the variant ID of this property.
The property Variant ID, not necessary the same as the Property Dataset Context VariantId.
This base provides the necessary for a class to become a context-api controller.