Excel.GroupOption enum

Remarks

API set: ExcelApi 1.10

Used by

• Excel.Range: group, hideGroupDetails, showGroupDetails, ungroup

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml

Excel.run(async (context) => {
 const sheet = context.workbook.worksheets.getActiveWorksheet();
 
 // Group the larger, main level. Note that the outline controls
 // will be on row 10, meaning 4-9 will collapse and expand.
 sheet.getRange("4:9").group(Excel.GroupOption.byRows);

 // Group the smaller, sublevels. Note that the outline controls
 // will be on rows 6 and 9, meaning 4-5 and 7-8 will collapse and expand.
 sheet.getRange("4:5").group(Excel.GroupOption.byRows);
 sheet.getRange("7:8").group(Excel.GroupOption.byRows);
 await context.sync();
});

Fields