Protected_Protected_Protected_Protected_Protected_Protected Optional_Protected Optional_Protected_Protected_ReadonlybulkReadonlyfilterReadonlyinteractionReadonlyitemsReadonlyloadingReadonlypaginationReadonlyselectionReadonlyselectReadonlytotalReadonlyuserReadonlyvalueReadonlyviewReadonlyviewReadonlyworkspaceProtected_Protected_Protected_The 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.
Optionaloptions: UmbClassGetContextOptions
Options 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.
Returns the alias of the view the collection was last left in.
The unique of the entity holding the collection.
The alias of the last selected view.
Returns the manifest for the collection.
An Observable to observe from.
Optionalcallback: ObserverCallback<UmbObserverValueType<ObservableType>>
Callback method called when data is changed.
OptionalcontrollerAlias: UmbControllerAlias | null
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.
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 | EventListenerOptionsReturns the href for a specific collection item. Override this method in specialized collection contexts to provide item-specific hrefs.
The collection item to get the href for.
Sets the configuration for the collection.
The collection configuration.
Sets the filter for the collection and refreshes the collection.
The filter to merge into the current filter.
Stores the alias of the view the collection was last left in.
The unique of the entity holding the collection.
The alias of the view.
Sets the manifest for the collection.
The manifest for the collection.
This base provides the necessary for a class to become a context-api controller.