Interface GridColumnMenuApi

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

interface GridColumnMenuApi {
    hideColumnMenu: (() => void);
    showColumnMenu: ((field: string) => void);
    toggleColumnMenu: ((field: string) => void);
}

Hierarchy (view full)

Properties

hideColumnMenu showColumnMenu toggleColumnMenu

Properties

hideColumnMenu

hideColumnMenu: (() => void)

Hides the column menu that is open.

showColumnMenu

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

Display the column menu under the field column.

Type declaration

    • (field): void

    • Parameters

      • field: string

        The column to display the menu.

      Returns void

toggleColumnMenu

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

Toggles the column menu under the field column.

Type declaration

    • (field): void

    • Parameters

      • field: string

        The field name to toggle the column menu.

      Returns void

Settings

Member Visibility

On This Page

Properties