OptionalcontrollerAlias: UmbControllerAliasReadonlyactiveThe trail of entities from the tree root down to the entity currently being viewed.
The active trail
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.
The active trail
Gets the trail of entities from the tree root down to the entity currently being viewed
The active trail, root first
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.
Checks if an descendant entity is active
The entity to check
True if a descendant entity is active
Checks if an descendant entity is active
The entity to check
True if a descendant entity is active
Checks if an entity is active
The entity to check
True if the entity is active
Checks if a path is the one currently open in the browser
The path to check, as it may change while the item is alive
True while the browser location points at the path
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 active entries.
Clears the active trail, but only when it matches the given trail
The trail that must match for the state to be cleared.
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
Optionaloptions: boolean | EventListenerOptionsThe active entries.
Sets the trail of entities from the tree root down to the entity currently being viewed
The active entries, root first.
Manages which tree entity is currently being viewed, and the trail of entities leading to it
Exports
UmbTreeItemActiveManager