Advanced User Interface Controls and Components

IntegralUI Web

Documentation and API Reference

collapse(name, row)

Collapses a specified row in TreeGrid directive.


nameStringThe value of name attribute of the TreeGrid directive
row (optional)ObjectThe row to be collapsed

Return Value

This method does not return a value.


This method is part of IntegralUITreeGridService. A call to this method will trigger beforeCollapse and afterCollapse events. By handling beforeCollapse event you can prevent collapsing of specified row using your own custom conditions.
An row can also become collapsed by setting the expanded variable of row object to false. However, in this case only afterCollapse event will be fired.
If there is no specified row, all rows in TreeGrid will become collapsed.

Version Information

Supported in: v1.0.

Articles & Samples

See Also