DropDownTreeComponent
Represents the Kendo UI DropDownTree component for Angular.
Definition
Package:@progress/kendo-angular-dropdowns
Selector:kendo-dropdowntree
Export Name:Accessible in templates as #kendoDropDownTreeInstance="kendoDropDownTree"
Syntax:
<kendo-dropdowntree [data]="data" textField="text" valueField="value"></kendo-dropdowntree>
Inputs
Enables or disables the adaptive mode. By default the adaptive rendering is disabled.
'none'
adaptiveSubtitle
string
Sets the subtitle of the ActionSheet that is rendered instead of the Popup when using small screen devices. By default the ActionSheet does not render a subtitle.
''
adaptiveTitle
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 DropDownTree.
''
clearButton
boolean
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.
true
data
object[]
Sets the data of the DropDownTree.
The data has to be provided in an array-like list with objects.
dataItem
object
Keeps the current dataItem object in order to resolve selection.
Needs to be provided when value is bound in 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.
false
A function which provides the child nodes for a given parent node.
Observable<object[]>
fetchChildren
Sets the fillMode of the component. The default value is set by the Kendo theme.
filterable
boolean
Renders the built-in input element for filtering the DropDownTree.
If set to true, the component emits the filterChange event, which can be used to filter the DropDownTree manually.
A built-in filtering implementation is available to use with the kendoDropDownTreeHierarchyBinding and kendoDropDownTreeFlatBinding directives.
false
A function which determines if a specific node has child nodes.
boolean
hasChildren
A function that is executed for each data item and determines if a specific node is expanded.
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.
boolean
isNodeVisible
A function that is executed for each data item and determines if a specific item is disabled.
boolean
itemDisabled
listHeight
number
Sets the height of the options list in the popup. By default, listHeight is 200px.
The
listHeightproperty affects only the list of options and not the whole popup container. To set the height of the popup container, usepopupSettings.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 DropDownTree.
loadOnDemand
boolean
Indicates whether the child nodes will be fetched on node expand or will be initially prefetched.
true
placeholder
string
Sets the placeholder of the input element of the DropDownTree.
""
Configures the popup of the DropDownTree.
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 toauto, 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
Sets the read-only state of the component.
false
Sets the border radius of the component. The default value is set by the Kendo theme.
Sets the size of the component. The default value is set by the Kendo theme.
textField
string | string[]
The fields of the data item that provide the text content of the nodes inside the
DropDownTree (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
textFieldproperty can be set to point to a nested property value - e.g.category.name.
value
any
Sets the value of the DropDownTree.
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 level in the data set where the value can be found when valueField is an Array.
The field serves to correctly allocate a data item used when the DropDownTree is initialized with a value.
valueField
string | string[]
The fields of the data item that provide the value of the nodes inside the
DropDownTree (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
valueFieldproperty 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 of a primitive value.
false
Fields
isOpen
boolean
Returns the current open state. Returns true if the popup or actionSheet is open.
Events
blur
EventEmitter<any>
Fires each time the DropDownTree gets blurred.
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.
focus
EventEmitter<any>
Fires each time the user focuses the DropDownTree.
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.
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.
valueChange
EventEmitter<any>
Fires each time the value is changed (see example).
Methods
Blurs the DropDownTree.
Focuses the DropDownTree.
Focuses a specific item of the DropDownTree 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.
Resets the value of the DropDownTree.
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.
Toggles the visibility of the popup or actionSheet.
(see example).
If you use the toggle method to open or close the popup or actionSheet, the open and close events will not be fired.
The state of the popup.