TreeOptions
Setting model for TreeView display
Signature:
export interface TreeOptionsRemarks
When setting it as an option in TreeView, you only need to enter the necessary information.
Example
tree.setTreeOptions({lineVisible: false});Properties
| Property | Type | Description |
|---|---|---|
| collapsedIcon | number | Icon displayed when a tree item is collapsed |
| collapseWhenCtrlKey | boolean | Whether to fold when the ctrl key and left arrow key are pressed together |
| collapseWhenLeftKey | boolean | Whether to fold when only the left arrow key is pressed |
| defaultIcon | number | If the icon index of an item does not exist or exceeds the total number, the designated icon index |
| expandedIcon | number | Icon displayed when tree item is expanded |
| expanderIconStyle | TreeExpanderIconStyle | Specifies the shape of the Tree Expander icon |
| expandWhenCtrlKey | boolean | Whether to expand when pressing the ctrl key and the right arrow key together |
| expandWhenRightKey | boolean | Whether to expand when the right arrow key is pressed |
| expandWhenSetData | ExpandWhenSetData | You can set whether to keep the existing expansion after set data. |
| iconImages | string[] | List of image files to use as icons |
| iconImagesRoot | string | Path to image to use as icon |
| iconVisible | boolean | tree icon visible |
| lineVisible | boolean | Tree line visibility |
| recursiveDeleting | boolean | If the parent node is removed in softDeleting state, the state value of the child node changes to RowState.DELETED. |
| showCheckBox | boolean | Checkbox inside tree |
| templateOptions | TreeTemplateOptions | undefined | Used when displaying an HTML tag in the first column of treeView. |
Properties Desc
collapsedIcon
Icon displayed when a tree item is collapsed
Type - number
collapseWhenCtrlKey
Whether to fold when pressing the ctrl key and left arrow key together
Type - boolean
Remarks:
This works even if collapseWhenLeftKey is false.
collapseWhenLeftKey
Whether to fold when only the left arrow key is pressed
Type - boolean
Remarks:
It should be located on the far left.
defaultIcon
Icon index designated when the icon index of an item does not exist or exceeds the total number.
Type - number
expandedIcon
Icon displayed when a tree item is expanded
Type - number
expanderIconStyle
Specifies the shape of the Tree Expander icon
Type - TreeExpanderIconStyle
expandWhenCtrlKey
Whether to expand when pressing the ctrl key and the right arrow key together
Type - boolean
Remarks:
This works even if expandWhenRightKey is false.
expandWhenRightKey
Whether to expand when the right arrow key is pressed
Type - boolean
Remarks:
It should be located on the far right.
expandWhenSetData
Set whether to keep the existing expansion after setting data.
Type - ExpandWhenSetData
Remarks:
Applies only when setting data with LocalTreeDataProvider.setRows() or LocalTreeDataProvider.setCsvRows().
iconImages
List of image files to use as icons
Type - string[]
iconImagesRoot
Path to the image to use as the icon
Type - string
iconVisible
tree icon visible
Type - boolean
lineVisible
Whether to display tree lines
Type - boolean
recursiveDeleting
If the parent node is removed in softDeleting state, the state value of the child node changes to RowState.DELETED.
Type - boolean
showCheckBox
Checkbox inside tree
Type - boolean
templateOptions
Used when displaying html tags in the first column of treeView.
Type - TreeTemplateOptions | undefined