TabSheet.addExpander

Syntax

addExpander(range: PP.Ui.TabSheetRange, noValidation: Boolean, isCollapse: Boolean);

Parameters

range. Range expanded using the expander button.

noValidation. Indicates if the expanded ranges are checked for nesting. If the parameters is set to True, the checking is disabled, otherwise it is enabled.

isCollapse. Indicates if the expanded range is collapsed. If the parameter is True the range should be collapsed, otherwise it will be expanded.

Description

The addExpander method adds the range expanding button to the top left cell of the range.

Comments

When the expander button is collapsed, all range cells are hidden except the cell that contains the expander button.

This method returns an object of the PP.Ui.TabSheetExpander type.

Example

To execute the example, the HTML page must contain a component named tabSheet (see Example of Creating the TabSheet Component). Add an expander button to a specified range, expand this range and select it:

// Get a cell range by the specified coordinates
var range = tabSheet.getRange(1, 2, 2, 1);
// Add an expander by the specified range
var expander = tabSheet.addExpander(range, False, False);
// Expand the range
tabSheet.getExpanderUnderCoord(expander.getCoord()).setIsCollapsed(False);
// Select the expandable range
tabSheet.select(range);
// Increase table size
tabSheet.setSize(400, 200);
// Refresh the table
tabSheet.rerender();

After executing the example an expander button is added for the range (1, 2, 2, 1), the range is expanded and selected: