File

projects/components/src/widgets/common/tree/tree.component.doc.ts

Description

The 'wmTree' directive used to represent data in hierarchical format..

Index

Methods
Inputs

Methods

onCollapse
onCollapse($event: MouseEvent, widget: any, $item: any, $path: any)

Callback function which will be triggered when the tree node is collapsed.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the button widget

$item any No

which provides collapsed node details

$path any No

which provide collapsed node path

Returns : void
onExpand
onExpand($event: MouseEvent, widget: any, $item: any, $path: any)

Callback function which will be triggered when the tree node is expanded.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the button widget

$item any No

which provides expanded node details

$path any No

which provide expanded node path

Returns : void
onSelect
onSelect($event: MouseEvent, widget: any, $item: any)

Callback function which will be triggered when the tree node is selected.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the button widget

$item any No

which provides selected node details

Returns : void

Inputs

class

Class of the widget.

Type : string

dataset

Set this property to a variable to populate the list of values to display.

Bindable: true

Type : any

Default value : 'node1, node2, node3'

levels

This property is used to set depth in terms of the levels of the tree to be expanded by default.

Type : number

Default value : 0

name

Name of the tree widget.

Type : string

nodeaction

This property is used to set action for particular node.

Bindable: true

Type : string

nodechildren

This property is used to set children for particular node.

Bindable: true

Type : string

nodeclick

This property is used to expand the node when it is clicked.

Allowed Values: Expand node, Do nothing

Expand node: Expands the node.

Horizontal: Do nothing.

Type : string

Default value : 'none'

nodeicon

This property is used to set icon for node.

Bindable: true

Type : string

nodeid

This property is used to set id for nodes.

Bindable: true

Type : string

nodelabel

This property is used to set label for node.

Bindable: true

Type : string

orderby

This Property allows user for multiple selection for ordering the display of rows based on fields in ascending or descending order.

Type : string

show

This property will be used to show/hide the tree widget on the web page.

Bindable: true

Type : boolean

Default value : true

tabindex

This property specifies the tab order of the Tree Widget.

Type : number

Default value : 0

treeicons

This property specifies expand/collapse icons for tree widget.

Allowed Values: folder, plus-minus, circle-plus-minus, chevron, menu, triangle, expand-collapse

Type : string

result-matching ""

    No results matching ""