AbstractOptionalvariantId: UmbVariantIdProtected Readonly_dataProtected_readAbstractcultureAbstractnameAbstractsegmentAppends 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 | AddEventListenerOptionsCallback method called when context is resolved.
Reference to the created Context Consumer Controller instance
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Optionaloptions: UmbClassGetContextOptionsA Promise with the reference to the Context Api Instance
AbstractgetAn 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.
FunctionpropertyValueByAlias
The alias of the property
FunctionpropertyVariantId
The property alias to observe the variantId of.
The API instance to be exposed.
Reference to the created Context Provider Controller instance
Removes the event listener in target's event listener list with the same type, callback, and options.
Optionaloptions: boolean | EventListenerOptionsFunctionsetPropertyValueByVariant
The alias of the property
value can be a promise resolving into the actual value or the raw value it self.
The variant id for the value to be set for.
A property dataset context, represents the data of a set of properties. This can take form as many, so to list a few:
The base type of this holds a Name and some Properties. Some might be enriches with Variant Info, like culture and segment. Others might have saved publishing status. Also setting the name is an additional feature.