Represents a Tree view
Represents a Tree view
(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`
(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`
(dispose tree-view)
Dispose this object.
Returns: any
Dispose this object. **Returns:** `any`
(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`
(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.
(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.
(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.
(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.
(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.
(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.
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>`
(selection tree-view)
Currently selected elements.
Returns: readonly T[]
Currently selected elements. **Returns:** `readonly T[]`
(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.
(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.
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.
(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.
(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.
(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`
(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`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close