---
title: "Row Grouping - Row Group Panel"
enterprise: true
framework: javascript
version: "36.1.0"
---

# Row Grouping - Row Group Panel

Use the Row Group Panel to enable users to modify the configured row group columns.

#### Enabling Row Group Panel

```ts
import {
  ClientSideRowModelModule,
  GridApi,
  GridOptions,
  ModuleRegistry,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";
import { RowGroupingModule, RowGroupingPanelModule } from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelModule,
  RowGroupingModule,
  RowGroupingPanelModule,
]);

let gridApi: GridApi<IOlympicData>;

const gridOptions: GridOptions<IOlympicData> = {
  columnDefs: [
    { field: "country", rowGroup: true, enableRowGroup: true, hide: true },
    { field: "year", rowGroup: true, enableRowGroup: true, hide: true },
    { field: "sport", enableRowGroup: true },
    { field: "total" },
  ],
  defaultColDef: {
    flex: 1,
    minWidth: 100,
  },
  autoGroupColumnDef: {
    minWidth: 200,
  },
  rowGroupPanelShow: "always",
};

const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);

fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
  .then((response) => response.json())
  .then((data: IOlympicData[]) => gridApi!.setGridOption("rowData", data));
```

[Live example: Enabling Row Group Panel](https://www.ag-grid.com/examples/grouping-group-panel/row-group-panel/typescript/)

## Enabling the Row Group Panel

The Row Group Panel allows users to modify which columns are grouped by using drag and drop. The panel can be enabled by setting the `rowGroupPanelShow` grid option to `"always"` or `"onlyWhenGrouping"`.

Columns also need to have `enableRowGroup` set to `true` in their column definition to be dragged into the panel.

The example above enables the panel and configures the `country` and `year` columns to be controllable by the panel:

```js
const gridOptions = {
    columnDefs: [
        { field: 'country', rowGroup: true, enableRowGroup: true },
        { field: 'year', rowGroup: true, enableRowGroup: true },
        // ...other column definitions
    ],
    // possible options: 'never', 'always', 'onlyWhenGrouping'
    rowGroupPanelShow: 'always',

    // other grid options ...
}
```

## Row Group Panel in the Side Bar

The Row Group Panel is also displayed as part of the [Columns Tool Panel](https://www.ag-grid.com/javascript-data-grid/tool-panel-columns/) in the [Side Bar](https://www.ag-grid.com/javascript-data-grid/side-bar/).

#### Side Bar Row Group Panel

```ts
import {
  ClientSideRowModelModule,
  GridApi,
  GridOptions,
  ModuleRegistry,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";
import { ColumnsToolPanelModule, RowGroupingModule } from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelModule,
  RowGroupingModule,
  ColumnsToolPanelModule,
]);

let gridApi: GridApi<IOlympicData>;

const gridOptions: GridOptions<IOlympicData> = {
  columnDefs: [
    { field: "country", enableRowGroup: true, rowGroup: true, hide: true },
    { field: "year", enableRowGroup: true, rowGroup: true, hide: true },
    { field: "athlete", minWidth: 180 },
    { field: "total", enableValue: true, aggFunc: "sum" },
  ],
  defaultColDef: {
    flex: 1,
    minWidth: 150,
  },
  autoGroupColumnDef: {
    minWidth: 200,
  },
  sideBar: "columns",
};

var gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);

fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
  .then((response) => response.json())
  .then((data: IOlympicData[]) => gridApi!.setGridOption("rowData", data));
```

[Live example: Side Bar Row Group Panel](https://www.ag-grid.com/examples/grouping-group-panel/side-bar-row-group-panel/typescript/)

The example above enabled the [Columns Tool Panel](https://www.ag-grid.com/javascript-data-grid/tool-panel-columns/) using the following configuration:

```js
const gridOptions = {
    sideBar: 'columns',

    // other grid options ...
}
```

Refer to the [Side Bar](https://www.ag-grid.com/javascript-data-grid/side-bar/) documentation for further configuration options.

## Row Group Panel in the Toolbar

The Row Group Panel can be embedded in the [Quick Access Toolbar](https://www.ag-grid.com/javascript-data-grid/toolbar/#row-group-and-pivot-panels) using the `agRowGroupPanelToolbarItem` built-in item, configured independently of `rowGroupPanelShow`.

```js
const gridOptions = {
    toolbar: {
        items: ['agRowGroupPanelToolbarItem'],
    },

    // other grid options ...
}
```

## Prevent User Grouping from Hiding Columns

After a user applies row grouping to a column, the column is hidden. If the user removes the row grouping, the column is made visible again.

This behaviour can be configured by setting the `suppressGroupChangesColumnVisibility` grid option property to `true`, `"suppressHideOnGroup"` or `"suppressShowOnUngroup"`.

#### Keep Columns Visible

```ts
import {
  ClientSideRowModelModule,
  GridApi,
  GridOptions,
  ModuleRegistry,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";
import { RowGroupingModule, RowGroupingPanelModule } from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelModule,
  RowGroupingModule,
  RowGroupingPanelModule,
]);

let gridApi: GridApi<IOlympicData>;

const gridOptions: GridOptions<IOlympicData> = {
  columnDefs: [
    { field: "country", enableRowGroup: true },
    { field: "year", enableRowGroup: true },
    { field: "athlete", minWidth: 180 },
    { field: "total" },
  ],
  defaultColDef: {
    flex: 1,
    minWidth: 150,
  },
  autoGroupColumnDef: {
    minWidth: 200,
  },
  suppressDragLeaveHidesColumns: true,
  rowGroupPanelShow: "always",
};

function onPropertyChange() {
  const prop = (
    document.querySelector("#visibility-behaviour") as HTMLSelectElement
  ).value;
  if (prop === "true" || prop === "false") {
    gridApi!.setGridOption(
      "suppressGroupChangesColumnVisibility",
      prop === "true",
    );
  } else {
    gridApi!.setGridOption(
      "suppressGroupChangesColumnVisibility",
      prop as "suppressHideOnGroup" | "suppressShowOnUngroup",
    );
  }
}

function resetCols() {
  gridApi!.setGridOption("columnDefs", [
    { field: "country", enableRowGroup: true, hide: false },
    { field: "year", enableRowGroup: true, hide: false },
    { field: "athlete", minWidth: 180, hide: false },
    { field: "total", hide: false },
  ]);
}

const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);

fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
  .then((response) => response.json())
  .then((data: IOlympicData[]) => gridApi!.setGridOption("rowData", data));

if (typeof window !== "undefined") {
  // Attach external event handlers to window so they can be called from index.html
  (<any>window).onPropertyChange = onPropertyChange;
  (<any>window).resetCols = resetCols;
}
```

[Live example: Keep Columns Visible](https://www.ag-grid.com/examples/grouping-group-panel/keep-columns-visible/typescript/)

> **Note**
>
> When dragging a column over the row group panel, the column is considered outside of the grid and so will be hidden. This behaviour can be prevented by setting `suppressDragLeaveHidesColumns` to `true`.

The following configuration can be used to prevent the column visibility from being impacted when a user changes the row group columns:

```js
const gridOptions = {
    suppressGroupChangesColumnVisibility: true,
    // prevent columns from being hidden when dragged over the row group panel
    suppressDragLeaveHidesColumns: true,

    // other grid options ...
}
```

## Prevent Sorting

The panel displays sort indicators, and the column pills can be clicked to change their sort. This behaviour can be prevented by setting the `rowGroupPanelSuppressSort` property to `true`.

#### Prevent Panel Sorting

```ts
import {
  ClientSideRowModelModule,
  GridApi,
  GridOptions,
  ModuleRegistry,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";
import { RowGroupingModule, RowGroupingPanelModule } from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelModule,
  RowGroupingModule,
  RowGroupingPanelModule,
]);

let gridApi: GridApi<IOlympicData>;

const gridOptions: GridOptions<IOlympicData> = {
  columnDefs: [
    { field: "country", enableRowGroup: true, rowGroup: true, hide: true },
    { field: "year", enableRowGroup: true, rowGroup: true, hide: true },
    { field: "athlete", minWidth: 180 },
    { field: "total" },
  ],
  defaultColDef: {
    flex: 1,
    minWidth: 150,
  },
  autoGroupColumnDef: {
    sort: "asc",
    minWidth: 200,
  },
  rowGroupPanelShow: "always",
};

function toggle() {
  const checked = document.querySelector<HTMLInputElement>(
    "#rowGroupPanelSuppressSort",
  )!.checked;
  gridApi!.setGridOption("rowGroupPanelSuppressSort", checked);
}

const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);

fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
  .then((response) => response.json())
  .then((data: IOlympicData[]) => gridApi!.setGridOption("rowData", data));

if (typeof window !== "undefined") {
  // Attach external event handlers to window so they can be called from index.html
  (<any>window).toggle = toggle;
}
```

[Live example: Prevent Panel Sorting](https://www.ag-grid.com/examples/grouping-group-panel/prevent-panel-sorting/typescript/)

The previous example demonstrates the following configuration for preventing the Row Group Panel from sorting columns:

```js
const gridOptions = {
    rowGroupPanelSuppressSort: true,

    // other grid options ...
}
```

## Prevent Changes to Group Order

The panel can be used to reorder or remove row grouping from columns. To prevent this, `groupLockGroupColumns` can be set to prevent removing or reordering columns. Providing `-1` will lock all columns, or provide a number representing the number of columns to lock.

#### Prevent Group Order Changes

```ts
import {
  ClientSideRowModelModule,
  GridApi,
  GridOptions,
  ModuleRegistry,
  createGrid,
  enableDevValidations,
} from "ag-grid-community";
import { RowGroupingModule, RowGroupingPanelModule } from "ag-grid-enterprise";
import { IOlympicData } from "./interfaces";

// Enable extended validations only for development
if (process.env.NODE_ENV !== "production") {
  enableDevValidations();
}

ModuleRegistry.registerModules([
  ClientSideRowModelModule,
  RowGroupingModule,
  RowGroupingPanelModule,
]);

let gridApi: GridApi<IOlympicData>;

const gridOptions: GridOptions<IOlympicData> = {
  columnDefs: [
    { field: "country", rowGroup: true, hide: true },
    { field: "year", rowGroup: true, hide: true },
    { field: "athlete", minWidth: 180 },
    { field: "total" },
  ],
  defaultColDef: {
    flex: 1,
    minWidth: 150,
  },
  autoGroupColumnDef: {
    minWidth: 200,
  },
  rowGroupPanelShow: "always",
  groupLockGroupColumns: -1,
};

const gridDiv = document.querySelector<HTMLElement>("#myGrid")!;
gridApi = createGrid(gridDiv, gridOptions);

fetch("https://www.ag-grid.com/example-assets/olympic-winners.json")
  .then((response) => response.json())
  .then((data: IOlympicData[]) => gridApi!.setGridOption("rowData", data));
```

[Live example: Prevent Group Order Changes](https://www.ag-grid.com/examples/grouping-group-panel/prevent-group-order-changes/typescript/)

The example above demonstrates locking the columns from their grouping being moved or removed:

```js
const gridOptions = {
    groupLockGroupColumns: -1,

    // other grid options ...
}
```