packages/eui/packages/components/eui-tree/eui-tree.component.ts
The eui-tree can be used to display hierarchy data with optional added behavior inside node templates and interactions that could affect the rendered data such as expand, collapse, direct actions, extra menu actions, etc.
OnInit
OnChanges
OnDestroy
changeDetection | ChangeDetectionStrategy.OnPush |
encapsulation | ViewEncapsulation.None |
selector | eui-tree |
imports |
NgIf
NgSwitch
NgFor
NgTemplateOutlet
FormsModule
TranslateModule
ScrollingModule
CdkTreeModule
RouterModule
EUI_INPUT_CHECKBOX
EUI_BUTTON
EUI_ICON
EUI_LABEL
EUI_BADGE
EUI_CHIP
EUI_DROPDOWN
|
templateUrl | ./eui-tree.component.html |
styleUrl | ./eui-tree.scss |
Properties |
Methods |
Inputs |
|
Outputs |
HostBindings |
Accessors |
autoTranslate |
Type : boolean
|
Default value : true
|
Whether i18n key can be passed to be translated with |
collapsedSvgIconClass |
Type : string
|
Default value : 'chevron-down:sharp'
|
Icon to display when a node is opened |
customNodeSelectFn |
Type : CustomNodeSelectFn
|
e2eAttr |
Type : string
|
Default value : 'eui-tree'
|
expandedSvgIconClass |
Type : string
|
Default value : 'chevron-forward:sharp'
|
Icon to display when a node is closed |
highlightPath |
Type : boolean
|
Default value : false
|
Whether all parents till the selected are highlighted in bold. |
isClickTogglingNode |
Type : boolean
|
Default value : false
|
Whether the full node display can be clicked to toggle the node. |
isMultiselect |
Type : boolean
|
Default value : false
|
Whether multiple nodes can be selected. |
isRecursiveParentSelection |
Type : boolean
|
Default value : true
|
In combination with |
isRecursiveSelection |
Type : boolean
|
Default value : false
|
In combination with |
isSingleSelect |
Type : boolean
|
Default value : false
|
Whether only one node can be selected. Select one will unselect the previous selected. |
nodeContentMetadataTemplateRef |
Type : TemplateRef<any>
|
nodes |
Type : TreeDataModel
|
Hierarchy of data to display in the tree |
nodeTemplateRef |
Type : TemplateRef<any>
|
Reference to the |
rightContextMenuTemplateRef |
Type : TemplateRef<any>
|
showLines |
Type : boolean
|
Default value : true
|
Whether the lines are displayed on the left of nodes. |
showUnderlinedLinks |
Type : boolean
|
Default value : false
|
Whether the links are underlined on hiver in the tree. |
nodeClick |
Type : EventEmitter
|
nodeToggle |
Type : EventEmitter
|
selectionChange |
Type : EventEmitter
|
class |
Type : string
|
collapseAll |
collapseAll()
|
Returns :
void
|
expandAll |
expandAll()
|
Returns :
void
|
expandAt | ||||||
expandAt(path: string)
|
||||||
Parameters :
Returns :
void
|
filterTerm | ||||||||||||
filterTerm(filterInput: string, filterKey?: string, showChildrenOfMatchedItems?: boolean)
|
||||||||||||
Parameters :
Returns :
void
|
getProcessedNodes |
getProcessedNodes()
|
Returns :
TreeDataModel
|
getRunTimeSelectionRecursiveState | ||||||
getRunTimeSelectionRecursiveState(path: string)
|
||||||
Parameters :
Returns :
TreeItemSelectionRecursiveModel
|
getSelection |
getSelection()
|
Returns :
TreeDataModel
|
getTreeItem | ||||||
getTreeItem(path: string)
|
||||||
Parameters :
Returns :
TreeItemModel
|
nodeSelected |
nodeSelected(evt: any, path: string)
|
Returns :
void
|
onNodeClick | |||||||||
onNodeClick(treeRunTimeItem: TreeItemRunTimeModel, e: any)
|
|||||||||
Parameters :
Returns :
void
|
onNodeToggle | ||||||
onNodeToggle(treeRunTimeItem: TreeItemRunTimeModel)
|
||||||
Parameters :
Returns :
void
|
onSelectFn | ||||||
onSelectFn(path: string)
|
||||||
Parameters :
Returns :
void
|
setAllSelection | ||||||
setAllSelection(isChecked: boolean)
|
||||||
Parameters :
Returns :
void
|
trackBy | |||||||||
trackBy(index: number, item: TreeItemRunTimeModel)
|
|||||||||
Parameters :
Returns :
any
|
trackByControl | ||||||
trackByControl(item: TreeItemRunTimeModel)
|
||||||
Parameters :
Returns :
any
|
updateTreeItem | |||||||||
updateTreeItem(givenTreeItem: TreeItemModel, path: string)
|
|||||||||
Parameters :
Returns :
void
|
cdkArrayDataSource |
Type : ArrayDataSource<TreeItemRunTimeModel>
|
cdkScrollableRef |
Type : CdkScrollable
|
Decorators :
@ViewChild('cdkScrollableRef', {read: CdkScrollable})
|
cdkTreeControl |
Type : NestedTreeControl<TreeItemRunTimeModel>
|
hasChild |
Default value : () => {...}
|
renderTree |
Type : boolean
|
Public treeComponentInstance |
Type : CdkTree<TreeItemRunTimeModel>
|
Decorators :
@ViewChild('treeComponentInstance')
|
Public uid |
Type : string
|
Default value : Math.floor(Math.random() * 1000000000).toString()
|
cssClasses |
getcssClasses()
|