Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ObjectExplorerNode

Interface for representing and interacting with items in Object Explorer

Hierarchy

Index

Properties

Methods

Properties

Optional childProvider

childProvider: string

Informs who provides the children to a node, used by data explorer tree view api

connectionId

connectionId: string

The id of the connection that the node exists under

Optional errorMessage

errorMessage: string

Optional iconType

iconType: string | SqlThemeIcon

Optional iconType for the object in the tree. Currently this only supports an icon name or SqlThemeIcon name, rather than a path to an icon. If not defined, the nodeType + nodeStatus / nodeSubType values will be used instead.

isLeaf

isLeaf: boolean

label

label: string

Optional metadata

metadata: ObjectMetadata

nodePath

nodePath: string

Optional nodeStatus

nodeStatus: string

Optional nodeSubType

nodeSubType: string

nodeType

nodeType: string

Optional payload

payload: any

Holds the connection profile for nodes, used by data explorer tree view api

Methods

getChildren

  • Get all the child nodes. Returns an empty list if there are no children.

    Returns Thenable<ObjectExplorerNode[]>

getParent

  • Get the parent node. Returns undefined if there is none.

    Returns Thenable<ObjectExplorerNode>

isExpanded

  • isExpanded(): Thenable<boolean>

  • Whether the node is currently expanded in Object Explorer

    Returns Thenable<boolean>

refresh

  • refresh(): Thenable<void>

  • Refresh the node, expanding it if it has children

    Returns Thenable<void>

setExpandedState

  • setExpandedState(expandedState: TreeItemCollapsibleState): Thenable<void>

  • Set whether the node is expanded or collapsed

    Parameters

    • expandedState: TreeItemCollapsibleState

      The new state of the node. If 'None', the node will not be changed

    Returns Thenable<void>

setSelected

  • setSelected(selected: boolean, clearOtherSelections?: boolean): Thenable<void>

  • Set whether the node is selected

    Parameters

    • selected: boolean

      Whether the node should be selected

    • Optional clearOtherSelections: boolean

      If true, clear any other selections. If false, leave any existing selections. Defaults to true when selected is true and false when selected is false.

    Returns Thenable<void>

Generated using TypeDoc