dots.vscode.tree-view

Liking cljdoc? Tell your friends :D

ClojureScript only.

badge
description
dispose
message
on-did-change-checkbox-state
on-did-change-selection
on-did-change-visibility
on-did-collapse-element
on-did-expand-element
reveal
selection
set-badge!
set-description!
set-message!
set-title!
title
visible?

Represents a Tree view

Represents a Tree view

raw docstring

badge^cljs

(badge tree-view)

The badge to display for this TreeView. To remove the badge, set to undefined.

Returns: ViewBadge | undefined

The badge to display for this TreeView.
To remove the badge, set to undefined.

**Returns:** `ViewBadge | undefined`

source raw docstring

description^cljs

(description tree-view)

An optional human-readable description which is rendered less prominently in the title of the view. Setting the title description to null, undefined, or empty string will remove the description from the view.

Returns: string | undefined

An optional human-readable description which is rendered less prominently in the title of the view.
Setting the title description to null, undefined, or empty string will remove the description from the view.

**Returns:** `string | undefined`

source raw docstring

dispose^cljs

(dispose tree-view)

Dispose this object.

Returns: any

Dispose this object.

**Returns:** `any`

source raw docstring

message^cljs

(message tree-view)

An optional human-readable message that will be rendered in the view. Setting the message to null, undefined, or empty string will remove the message from the view.

Returns: string | undefined

An optional human-readable message that will be rendered in the view.
Setting the message to null, undefined, or empty string will remove the message from the view.

**Returns:** `string | undefined`

source raw docstring

on-did-change-checkbox-state^cljs

(on-did-change-checkbox-state tree-view)

(on-did-change-checkbox-state tree-view listener)

(on-did-change-checkbox-state tree-view listener this-args)

(on-did-change-checkbox-state tree-view listener this-args disposables)

An event to signal that an element or root has either been checked or unchecked.

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

An event to signal that an element or root has either been checked or unchecked.

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

on-did-change-selection^cljs

(on-did-change-selection tree-view)

(on-did-change-selection tree-view listener)

(on-did-change-selection tree-view listener this-args)

(on-did-change-selection tree-view listener this-args disposables)

Event that is fired when the {@link TreeView.selection selection} has changed

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

Event that is fired when the {@link TreeView.selection selection} has changed

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

on-did-change-visibility^cljs

(on-did-change-visibility tree-view)

(on-did-change-visibility tree-view listener)

(on-did-change-visibility tree-view listener this-args)

(on-did-change-visibility tree-view listener this-args disposables)

Event that is fired when {@link TreeView.visible visibility} has changed

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

Event that is fired when {@link TreeView.visible visibility} has changed

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

on-did-collapse-element^cljs

(on-did-collapse-element tree-view)

(on-did-collapse-element tree-view listener)

(on-did-collapse-element tree-view listener this-args)

(on-did-collapse-element tree-view listener this-args disposables)

Event that is fired when an element is collapsed

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

Event that is fired when an element is collapsed

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

on-did-expand-element^cljs

(on-did-expand-element tree-view)

(on-did-expand-element tree-view listener)

(on-did-expand-element tree-view listener this-args)

(on-did-expand-element tree-view listener this-args disposables)

Event that is fired when an element is expanded

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

Event that is fired when an element is expanded

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

reveal^cljs

(reveal tree-view element)

(reveal tree-view element options)

Reveals the given element in the tree view. If the tree view is not visible then the tree view is shown and element is revealed.

By default revealed element is selected. In order to not to select, set the option select to false. In order to focus, set the option focus to true. In order to expand the revealed element, set the option expand to true. To expand recursively set expand to the number of levels to expand.

NOTE: You can expand only to 3 levels maximum.
NOTE: The {@link TreeDataProvider } that the TreeView {@link window.createTreeView is registered with} with must implement {@link TreeDataProvider.getParent getParent} method to access this API.

Parameters:

element: T
options: { select?: boolean | undefined; focus?: boolean | undefined; expand?: number | boolean | undefined; } | undefined

Returns: Thenable<void>

Reveals the given element in the tree view.
If the tree view is not visible then the tree view is shown and element is revealed.

By default revealed element is selected.
In order to not to select, set the option `select` to `false`.
In order to focus, set the option `focus` to `true`.
In order to expand the revealed element, set the option `expand` to `true`. To expand recursively set `expand` to the number of levels to expand.

* *NOTE:* You can expand only to 3 levels maximum.
* *NOTE:* The {@link TreeDataProvider } that the `TreeView` {@link window.createTreeView is registered with} with must implement {@link TreeDataProvider.getParent getParent} method to access this API.

**Parameters:**
- `element`: `T`
- `options`: `{ select?: boolean | undefined; focus?: boolean | undefined; expand?: number | boolean | undefined; } | undefined`

**Returns:** `Thenable<void>`

source raw docstring

selection^cljs

(selection tree-view)

Currently selected elements.

Returns: readonly T[]

Currently selected elements.

**Returns:** `readonly T[]`

source raw docstring

set-badge!^cljs

(set-badge! tree-view value)

The badge to display for this TreeView. To remove the badge, set to undefined.

The badge to display for this TreeView.
To remove the badge, set to undefined.

source raw docstring

set-description!^cljs

(set-description! tree-view value)

An optional human-readable description which is rendered less prominently in the title of the view.
Setting the title description to null, undefined, or empty string will remove the description from the view.

source raw docstring

set-message!^cljs

(set-message! tree-view value)

An optional human-readable message that will be rendered in the view. Setting the message to null, undefined, or empty string will remove the message from the view.

An optional human-readable message that will be rendered in the view.
Setting the message to null, undefined, or empty string will remove the message from the view.

source raw docstring

set-title!^cljs

(set-title! tree-view value)

The tree view title is initially taken from the extension package.json Changes to the title property will be properly reflected in the UI in the title of the view.

The tree view title is initially taken from the extension package.json
Changes to the title property will be properly reflected in the UI in the title of the view.

source raw docstring

title^cljs

(title tree-view)

The tree view title is initially taken from the extension package.json Changes to the title property will be properly reflected in the UI in the title of the view.

Returns: string | undefined

The tree view title is initially taken from the extension package.json
Changes to the title property will be properly reflected in the UI in the title of the view.

**Returns:** `string | undefined`

source raw docstring

visible?^cljs

(visible? tree-view)

true if the {@link TreeView tree view} is visible otherwise false.

Returns: boolean

`true` if the {@link TreeView tree view} is visible otherwise `false`.

**Returns:** `boolean`

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close