Vue TreeView API

Specifies the shortcut key that sets focus on the UI component.

Specifies whether the UI component changes its visual state as a result of user interaction.

Specifies whether or not to animate item collapsing and expanding.

Specifies a custom collapse icon.

Allows you to load nodes on demand.

Binds the UI component to data.

Notifies the UI component of the data structure in use.

Specifies whether the UI component responds to user interaction.

Specifies the name of the data source item field whose value defines whether or not the corresponding UI component item is disabled.

Specifies the data field whose values should be displayed.

Specifies the global attributes to be attached to the UI component's container element.

Specifies whether or not a user can expand all tree view items by the "*" hot key.

Specifies which data source field specifies whether an item is expanded.

Specifies the event on which to expand/collapse a node.

Specifies a custom expand icon.

Specifies whether or not all parent nodes of an initially expanded node are displayed expanded.

Specifies whether the UI component can be focused using keyboard navigation.

Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes.

Specifies the UI component's height.

Specifies text for a hint that appears when a user pauses on the UI component.

Specifies whether the UI component changes its state when a user pauses on it.

An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

The time period in milliseconds before the onItemHold event is raised.

An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

An array of items displayed by the UI component.

Specifies which data field contains nested items. Applies only if the dataStructure property is "tree".

Specifies a custom template for items.

Specifies which data field provides keys for TreeView items.

Specifies the text or HTML markup displayed by the UI component if the item collection is empty.

A function that is executed when the UI component is rendered and each time the component is repainted.

A function that is executed before the UI component is disposed of.

A function used in JavaScript frameworks to save the UI component instance.

A function that is executed when a collection item is clicked or tapped.

A function that is executed when a tree view item is collapsed.

A function that is executed when a collection item is right-clicked or pressed.

A function that is executed when a tree view item is expanded.

A function that is executed when a collection item has been held for a specified period.

A function that is executed after a collection item is rendered.

A function that is executed when a single TreeView item is selected or selection is canceled.

A function that is executed after a UI component property is changed.

A function that is executed when the "Select All" check box value is changed. Applies only if showCheckBoxesMode is "selectAll" and selectionMode is "multiple".

A function that is executed when a TreeView item is selected or selection is canceled.

Specifies the name of the data source item field for holding the parent key of the corresponding node.

Specifies the root key.

Switches the UI component to a right-to-left representation.

A string value specifying available scrolling directions.

Configures the search panel.

Specifies whether the search panel is visible.

Specifies a data object's field name or an expression whose value is compared to the search string.

Specifies a comparison operation used to search UI component items.

Specifies a delay in milliseconds between when a user finishes typing, and the search is executed.

Specifies the current search string.

Specifies the text displayed at the "Select All" check box.

Specifies whether an item is selected if a user clicks it.

Specifies the name of the data source item field whose value defines whether or not the corresponding UI component items is selected.

Specifies item selection mode. Applies only if selection is enabled.

Specifies whether all child nodes should be selected when their parent node is selected. Applies only if the selectionMode is "multiple".

Specifies the checkbox display mode.

Specifies the number of the element when the Tab key is used for navigating.

Specifies whether or not the UI component uses native scrolling.

Enables the virtual mode in which nodes are loaded on demand. Use it to enhance the performance on large datasets.

Specifies whether the UI component is visible.

Specifies the UI component's width.

Postpones rendering that can negatively affect performance until the endUpdate() method is called.

Collapses all items.

Collapses an item with a specific key.

Collapses an item found using its DOM node.

Collapses an item with a specific key.

Specifies the device-dependent default configuration properties for this component.

Disposes of all the resources allocated to the TreeView instance.

Gets the root UI component element.

Refreshes the UI component after a call of the beginUpdate() method.

Expands all items. If you load items on demand, this method expands only the loaded items.

Expands an item found using its data object.

Expands an item found using its DOM node.

Expands an item with a specific key.

Sets focus on the UI component.

Gets the DataSource instance.

Gets the instance of a UI component found using its DOM node.

Gets all nodes.

Gets the instance of the UI component's scrollable part.

Gets the keys of selected nodes.

Gets selected nodes.

Gets the UI component's instance. Use it to access other methods of the UI component.

Detaches all event handlers from a single event.

Detaches a particular event handler from a single event.

Subscribes to an event.

Subscribes to events.

Gets all UI component properties.

Gets the value of a single property.

Updates the value of a single property.

Updates the values of several properties.

Registers a handler to be executed when a user presses a specific key.

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.

Resets a property to its default value.

Scrolls the content to an item found using its data.

Scrolls the content to an item found using its DOM node.

Scrolls the content to an item found using its key.

Selects all nodes.

Selects a node found using its data object.

Selects a TreeView node found using its DOM node.

Selects a node with a specific key.

Cancels the selection of all nodes.

Cancels the selection of a node found using its data object.

Cancels the selection of a TreeView node found using its DOM node.

Cancels the selection of a node with a specific key.

Updates the tree view scrollbars according to the current size of the UI component content.

Raised when the UI component is rendered and each time the component is repainted.

Raised before the UI component is disposed of.

Raised only once, after the UI component is initialized.

Raised when a collection item is clicked or tapped.

Raised when a tree view item is collapsed.

Raised when a collection item is right-clicked or pressed.

Raised when a tree view item is expanded.

Raised when a collection item has been held for a specified period.

Raised after a collection item is rendered.

Raised when a tree view item is selected or selection is canceled.

Raised after a UI component property is changed.

Raised when the "Select All" check box value is changed.

Raised when a tree view item is selected or selection is canceled.

The type of the contentReady event handler's argument.

The type of the disposing event handler's argument.

The type of the initialized event handler's argument.

The type of the itemClick event handler's argument.

The type of the itemCollapsed event handler's argument.

The type of the itemContextMenu event handler's argument.

The type of the itemExpanded event handler's argument.

The type of the itemHold event handler's argument.

The type of the itemRendered event handler's argument.

The type of the itemSelectionChanged event handler's argument.

The type of the optionChanged event handler's argument.

The type of the selectAllValueChanged event handler's argument.

The type of the selectionChanged event handler's argument.

Specifies the checkbox display mode.

Specifies the event on which to expand/collapse a node.