{"id":2406,"date":"2026-11-02T16:30:01","date_gmt":"2026-11-02T08:30:01","guid":{"rendered":"https:\/\/xlwings.net\/blog\/?p=2406"},"modified":"2026-03-29T10:26:52","modified_gmt":"2026-03-29T10:26:52","slug":"how-to-use-rangegroup-in-the-xlwings-api-way","status":"publish","type":"post","link":"https:\/\/xlwings.net\/blog\/how-to-use-rangegroup-in-the-xlwings-api-way\/","title":{"rendered":"How to use Range.Group in the xlwings API way"},"content":{"rendered":"\n

The Group<\/code> member of the Range<\/code> object in the Excel object model is a method used to group rows or columns in an outline, which is particularly useful for creating structured, collapsible sections in worksheets for summarizing data. In xlwings, this functionality is accessible through the api<\/code> property, which provides direct access to the underlying Excel object model. This method allows you to manage grouped ranges programmatically, enhancing automation in report generation and data presentation.<\/p>\n\n\n\n

Functionality:<\/strong>
The primary purpose of the Group<\/code> method is to group selected rows or columns, enabling users to collapse or expand them for better data organization. It is commonly applied in financial models, detailed lists, or any dataset where hierarchical viewing is beneficial. Grouping helps in hiding detail while showing summary rows or columns, making worksheets more readable.<\/p>\n\n\n\n

Syntax:<\/strong>
In xlwings, the syntax for using the Group<\/code> method is as follows:<\/p>\n\n\n\n

range.api.Group(Start, End, ByRows, Periods)<\/code><\/pre>\n\n\n\n
Parameters:<\/p>\n\n\n\n
    \n
  • Start<\/code> (Optional, Variant): Specifies the first row or column to group. If omitted, grouping starts from the first cell in the range.<\/li>\n\n\n\n
  • End<\/code> (Optional, Variant): Specifies the last row or column to group. If omitted, grouping ends at the last cell in the range.<\/li>\n\n\n\n
  • ByRows<\/code> (Optional, Boolean): Determines whether to group by rows (True<\/code>) or columns (False<\/code>). The default is True<\/code> if not specified.<\/li>\n\n\n\n
  • Periods<\/code> (Optional, Integer): Indicates the number of periods to group, typically used for creating multiple outline levels. The default is 1.<\/li>\n<\/ul>\n\n\n\n
    A table summarizing parameter details:<\/p>\n\n\n\n
    Parameter<\/th>Type<\/th>Description<\/th>Default Value<\/th><\/tr><\/thead>
    Start<\/td>Variant<\/td>First row\/column index<\/td>First cell in range<\/td><\/tr>
    End<\/td>Variant<\/td>Last row\/column index<\/td>Last cell in range<\/td><\/tr>
    ByRows<\/td>Boolean<\/td>Group by rows (True) or columns (False)<\/td>True<\/td><\/tr>
    Periods<\/td>Integer<\/td>Number of outline levels<\/td>1<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
    Example:<\/strong>
    Here is an xlwings code example demonstrating the use of the Group<\/code> method to group rows in a worksheet:<\/p>\n\n\n\n
    import xlwings as xw\n\n# Connect to the active workbook\nwb = xw.books.active\nws = wb.sheets['Sheet1']\n\n# Define a range, e.g., rows 5 to 10\ntarget_range = ws.range('5:10')\n\n# Group the rows in the range\ntarget_range.api.Group(Start=None, End=None, ByRows=True, Periods=1)\n\n# To group columns, for instance columns B to D\ncol_range = ws.range('B:D')\ncol_range.api.Group(Start=None, End=None, ByRows=False, Periods=1)<\/code><\/pre>\n\n\n\n
    <\/p>\n","protected":false},"excerpt":{"rendered":"
    The `Group` member of the `Range` object in the Excel object model is a method used to group rows or…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[25],"tags":[],"class_list":["post-2406","post","type-post","status-publish","format-standard","hentry","category-xlwings-api-reference"],"_links":{"self":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2406","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/comments?post=2406"}],"version-history":[{"count":1,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2406\/revisions"}],"predecessor-version":[{"id":3660,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2406\/revisions\/3660"}],"wp:attachment":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/media?parent=2406"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/categories?post=2406"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/tags?post=2406"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}