The controller host this manager is bound to.
Optionalargs: UmbTreeItemPickerLocationManagerArgs
Optional construction arguments.
ReadonlybreadcrumbReadonlycurrentWhere the picker is browsing, as a tri-state:
undefined — no location established yet.null — the node last browsed to is not in the tree. A host should say so rather than show a level it cannot
describe, and must not treat this as still loading.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 normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
Returns the trail to the node currently being browsed.
The trail, ending with the node being browsed.
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 node currently being browsed.
The current location, undefined before one is established, or null when the node last browsed to is not in the tree.
Browses to a node, leaving the trail, the current location and the remembered location consistent with each other.
A node already in the trail is browsed by shortening the trail to it, so stepping back up costs no request. A node
the tree does not have leaves the current location null.
Optionalentity: UmbEntityModel
The node to browse, or undefined for the start node when there is one and the tree root otherwise.
Resolves once the trail and the current location have been set.
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. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
Optionaloptions: boolean | EventListenerOptionsSets the node the picker may not browse above. Set it before the tree alias, as the alias starts the load.
OptionalstartNode: UmbTreeStartNode
The node to start from, or undefined to browse from the tree root.
Tracks where in a tree a picker is browsing: the trail to it, the node itself, and the memory of both.