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
adaptiveMode	AdaptiveMode		Enables or disables the adaptive mode. By default the adaptive rendering is disabled.
checkableSettings	MultiSelectTreeCheckableSettings		Defines the checkable settings of the MultiSelecTree nodes. If no value is provided, the default CheckableSettings are applied.
checkAll	boolean	false	If checkАll is set to true and the checkboxes are enabled, a tri-state checkbox appears above the embedded treeview. Clicking the checkbox checks or unchecks all enabled items of the treeview that are loaded.
clearButton	boolean	true	If set to true, renders a button on hovering over the component. Clicking this button resets the value of the component to undefined and triggers the change event.
data	Object[]		Sets the data of the MultiSelectTree. The data has to be provided in an array-like list with objects.
dataItems	any[]		Keeps the current dataItems object in order to resolve selection. Needs to be provided when when programmatically setting a value and valuePrimitive is set to true.
disabled	boolean		Sets the disabled state of the component. To learn how to disable the component in reactive forms, refer to the article on Forms Support.
fetchChildren	(node: object) => Observable<object[]>		A function which provides the child nodes for a given parent node.
fillMode	DropDownFillMode		Sets the fillMode of the component. The possible values are: flat solid (default) outline none
filterable	boolean	false	Renders the built-in input element for filtering the MultiSelectTree. If set to true, the component emits the filterChange event, which can be used to filter the MultiSelectTree manually. A built-in filtering implementation is available to use with the kendoMultiSelectTreeHierarchyBinding and kendoMultiSelectTreeFlatBinding directives.
hasChildren	(node: object) => boolean		A function which determines if a specific node has child nodes.
isNodeExpanded	(item: object, index: string) => boolean		A function that is executed for each data item and determines if a specific node is expanded.
isNodeVisible	(item: object, index: string) => boolean		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	(item: object, index: string) => boolean		A function that is executed for each data item and determines if a specific item is disabled.
listHeight	number		Sets the height of the options list in the popup. By default, listHeight is 200px. The listHeight property affects only the list of options and not the whole popup container. To set the height of the popup container, use popupSettings.height. When using adaptiveMode and the screen size is small or medium the listHeight property is set to null.
loading	boolean		Sets and gets the loading state of the MultiSelectTree.
loadOnDemand	boolean	false	Indicates whether the child nodes will be fetched on node expand or will be initially prefetched.
placeholder	string		The hint which is displayed when the component is empty.
popupSettings	PopupSettings		Configures the popup of the MultiSelectTree. The available options are: animate: Boolean—Controls the popup animation. By default, the open and close animations are enabled. width: Number | String—Sets the width of the popup container. By default, the width of the host element is used. If set to auto, the component automatically adjusts the width of the popup and no item labels are wrapped. height: Number—Sets the height of the popup container. popupClass: String—Specifies a list of CSS classes that are used to style the popup. appendTo: "root" | "component" | ViewContainerRef—Specifies the component to which the popup will be appended.
readonly	boolean	false	Sets the read-only state of the component.
rounded	DropDownRounded		Sets the border radius of the component. The possible values are: small medium (default) large full none
size	DropDownSize		Sets the size of the component. The possible values are: small medium (default) large none
subtitle	string		Sets the subtitle of the ActionSheet that is rendered instead of the Popup when using small screen devices. By default the ActionSheet subtitle uses the text provided for the placeholder of the AutoComplete.
tabindex	number		Specifies the tabindex of the component.
tagMapper	(tags: any) => any		A user-defined callback function which receives an array of selected data items and maps them to an array of tags.
textField	string | string[]		The fields of the data item that provide the text content of the nodes inside the MultiSelectTree (see example). If the textField input is set to an array, each hierarchical level uses the field that corresponds to the same index in the array, or the last item in the array. The textField property can be set to point to a nested property value - e.g. category.name.
title	string		Sets the title of the ActionSheet that is rendered instead of the Popup when using small screen devices. By default the ActionSheet title uses the text provided for the label of the AutoComplete.
value	any[]		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 valuePrimitive option.
valueDepth	number[]		Sets the levels in the data set where the values can be found when valueField is an Array. The field serves to correctly allocate a data item used when the MultiSelectTree is initialized with a value.
valueField	string | string[]		The fields of the data item that provide the value of the nodes inside the MultiSelectTree (see example). If the valueField input is set to an array, each hierarchical level uses the field that corresponds to the same index in the array, or the last item in the array. The valueField property can be set to point to a nested property value - e.g. category.id.
valuePrimitive	boolean		Specifies the type of the selected value (more information and example). If set to true, the selected value has to be a primitive one.

Fields

Name	Type	Default	Description
isOpen	boolean		Returns the current open state. Returns true if the popup or actionSheet is open.

Events

Name	Type	Description
close	EventEmitter<PreventableEvent>	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	EventEmitter<any>	Fires after the popup has been closed.
filterChange	EventEmitter<string>	Fires when the value of the built-in filter input element changes.
nodeCollapse	EventEmitter<TreeItem>	Fires when the user collapses a node in the popup TreeView.
nodeExpand	EventEmitter<TreeItem>	Fires when the user expands a node in the popup TreeView.
blur	EventEmitter<any>	Fires each time the MultiSelectTree gets blurred.
focus	EventEmitter<any>	Fires each time the user focuses the MultiSelectTree.
open	EventEmitter<PreventableEvent>	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	EventEmitter<any>	Fires after the popup has been opened.
removeTag	EventEmitter<RemoveTagEvent>	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	EventEmitter<any>	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 1_1. The targeted item should be expanded in order for it to be focused. If null or invalid index is provided the focus will be set on the first item.
Parameters index string

reset
Resets the value of the MultiSelectTree. If you use the reset method to clear the value of the component, the model will not update automatically and the valueChange event will not be fired.

toggle
Toggles the visibility of the popup or actionSheet (see example). If you use the toggle method to open or close the popup, the open and close events will not be fired.
Parameters open? boolean The state of the popup.