Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TreeDataProvider<T>

A data provider that provides tree data

Type parameters

  • T

Hierarchy

  • TreeDataProvider

Index

Properties

Methods

Properties

Optional onDidChangeTreeData

onDidChangeTreeData: Event<T | undefined | null>

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.

Methods

getChildren

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

    Parameters

    • Optional element: T

      The element from which the provider gets children. Can be undefined.

    Returns ProviderResult<T[]>

    Children of element or root if no element is passed.

Optional getParent

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

    NOTE: This method should be implemented in order to access reveal API.

    Parameters

    • element: T

      The element for which the parent has to be returned.

    Returns ProviderResult<T>

    Parent of element.

getTreeItem

  • Get TreeItem representation of the element

    Parameters

    • element: T

      The element for which TreeItem representation is asked for.

    Returns TreeItem | PromiseLike<TreeItem>

    (#TreeItem) representation of the element