Interface GridColumnPinningApi

The column pinning API interface that is available in the grid [[apiRef]].

interface GridColumnPinningApi {
    getPinnedColumns: (() => GridPinnedColumnFields);
    isColumnPinned: ((field: string) => false | GridPinnedColumnPosition);
    pinColumn: ((field: string, side: GridPinnedColumnPosition) => void);
    setPinnedColumns: ((pinnedColumns: GridPinnedColumnFields) => void);
    unpinColumn: ((field: string) => void);
}

Hierarchy (view full)

GridColumnPinningApi
- GridApiPro

Index

Properties

getPinnedColumns isColumnPinned pinColumn setPinnedColumns unpinColumn

Properties

getPinnedColumns

getPinnedColumns: (() => GridPinnedColumnFields)

Returns which columns are pinned.

Type declaration

- (): GridPinnedColumnFields
- Returns GridPinnedColumnFields
  An object containing the pinned columns.

isColumnPinned

isColumnPinned: ((field: string) => false | GridPinnedColumnPosition)

Returns which side a column is pinned to.

Type declaration

- (field): false | GridPinnedColumnPosition
- Parameters
  - field: string
    The column field to check.
  Returns false | GridPinnedColumnPosition
  Which side the column is pinned or false if not pinned.

pinColumn

pinColumn: ((field: string, side: GridPinnedColumnPosition) => void)

Pins a column to the left or right side of the grid.

Type declaration

- (field, side): void
- Parameters
  - field: string
    The column field to pin.
  - side: GridPinnedColumnPosition
    Which side to pin the column.
  Returns void

setPinnedColumns

setPinnedColumns: ((pinnedColumns: GridPinnedColumnFields) => void)

Changes the pinned columns.

Type declaration

- (pinnedColumns): void
- Parameters
  - pinnedColumns: GridPinnedColumnFields
    An object containing the columns to pin.
  Returns void

unpinColumn

unpinColumn: ((field: string) => void)

Unpins a column.

Type declaration

- (field): void
- Parameters
  - field: string
    The column field to unpin.
  Returns void