MultiSelectTreeComponent
Represents the Kendo UI MultiSelectTree component for Angular.
Selector
kendo-multiselecttree
Export Name
Accessible in templates as #kendoMultiSelectTreeInstance="kendoMultiSelectTree"
Inputs
Name | Type | Default | Description |
---|---|---|---|
checkableSettings |
|
Defines the checkable settings of the MultiSelecTree nodes.
If no value is provided, the default | |
checkAll |
|
|
If |
clearButton |
|
|
If set to |
data |
|
Sets the data of the MultiSelectTree.
| |
dataItems |
|
Keeps the current | |
disabled |
|
Sets the disabled state of the component. | |
fetchChildren |
|
A function which provides the child nodes for a given parent node. | |
fillMode |
|
Sets the fillMode of the component. The possible values are:
| |
filterable |
|
|
Renders the built-in input element for filtering the MultiSelectTree.
If set to |
hasChildren |
|
A function which determines if a specific node has child nodes. | |
isNodeExpanded |
|
A function that is executed for each data item and determines if a specific node is expanded. | |
isNodeVisible |
|
A callback which determines whether a tree node should be rendered as hidden. The utility .k-hidden class is used to hide the nodes. Useful for custom filtering implementations. | |
itemDisabled |
|
A function that is executed for each data item and determines if a specific item is disabled. | |
listHeight |
|
Sets the height of the options list. By default,
| |
loading |
|
Sets and gets the loading state of the MultiSelectTree. | |
loadOnDemand |
|
|
Indicates whether the child nodes will be fetched on node expand or will be initially prefetched. |
placeholder |
|
The hint which is displayed when the component is empty. | |
popupSettings |
|
Configures the popup of the MultiSelectTree. The available options are:
| |
readonly |
|
Sets the read-only state of the component. | |
rounded |
|
Sets the border radius of the component. The possible values are:
| |
size |
|
Sets the size of the component. The possible values are:
| |
tabindex |
|
Specifies the | |
tagMapper |
|
A user-defined callback function which receives an array of selected data items and maps them to an array of tags. | |
textField |
|
The fields of the data item that provide the text content of the nodes inside the
MultiSelectTree (see example). If the
| |
value |
|
Sets the value of the MultiSelectTree.
It can either be of the primitive (string, numbers) or of the complex (objects) type.
To define the type, use the | |
valueDepth |
|
Sets the levels in the data set where the values can be found when | |
valueField |
|
The fields of the data item that provide the value of the nodes inside the
MultiSelectTree (see example). If the
| |
valuePrimitive |
|
Specifies the type of the selected value
(more information and example).
If set to |
Fields
Name | Type | Default | Description |
---|---|---|---|
isOpen |
|
Returns the current open state of the popup. |
Events
Name | Type | Description |
---|---|---|
close |
|
Fires each time the popup is about to close (see example). This event is preventable. If you cancel it, the popup will remain open. |
closed |
|
Fires after the popup has been closed. |
filterChange |
|
Fires when the value of the built-in filter input element changes. |
nodeCollapse |
|
Fires when the user collapses a node in the popup TreeView. |
nodeExpand |
|
Fires when the user expands a node in the popup TreeView. |
blur |
|
Fires each time the MultiSelectTree gets blurred. |
focus |
|
Fires each time the user focuses the MultiSelectTree. |
open |
|
Fires each time the popup is about to open (see example). This event is preventable. If you cancel it, the popup will remain closed. |
opened |
|
Fires after the popup has been opened. |
removeTag |
|
Fires each time a tag is about to be removed(see examples). This event is preventable. If you cancel it, the tag will not be removed. |
valueChange |
|
Fires each time the value is changed (see example). |
Methods
blur |
---|
Blurs the MultiSelectTree. |
focus |
---|
Focuses the MultiSelectTree. |
focusItemAt | ||||||
---|---|---|---|---|---|---|
Focuses a specific item of the MultiSelectTree based on a provided index in the format of | ||||||
|
reset |
---|
Resets the value of the MultiSelectTree.
If you use the |
toggle | ||||||
---|---|---|---|---|---|---|
Toggles the visibility of the popup
(see example).
If you use the | ||||||
|