kotlin-vscode/vscode/TreeDataProvider

TreeDataProvider

interface TreeDataProvider<T : JsAny?>(source)

A data provider that provides tree data

Online Documentation

Properties

getParent

abstract var getParent: (element: T) -> ProviderResult<T>?

Optional method to return the parent of element. Return null or undefined if element is a child of root.

onDidChangeTreeData

abstract var onDidChangeTreeData: Event<JsAny>?

An optional event to signal that an element or root has changed. This will trigger the view to update the changed element/root and its children recursively (if shown). To signal that root has changed, do not pass any argument or pass undefined or null.

resolveTreeItem

abstract var resolveTreeItem: (item: TreeItem, element: T, token: CancellationToken) -> ProviderResult<TreeItem>?

Called on hover to resolve the TreeItem property if it is undefined. Called on tree item click/open to resolve the TreeItem property if it is undefined. Only properties that were undefined can be resolved in resolveTreeItem. Functionality may be expanded later to include being called to resolve other missing properties on selection and/or on open.

Functions

getChildren

abstract fun getChildren(element: T = definedExternally): ProviderResult<ReadonlyArray<T>>

Get the children of element or root if no element is passed.

getTreeItem

abstract fun getTreeItem(element: T): PromiseResult<TreeItem>

Get TreeItem representation of the element