Interface GridPreferencesPanelApi

The preferences panel API interface that is available in the grid [[apiRef]].

interface GridPreferencesPanelApi {
    hidePreferences: (() => void);
    showPreferences: ((newValue: GridPreferencePanelsValue, panelId?: string, labelId?: string) => void);
}

Hierarchy (view full)

Properties

hidePreferences showPreferences

Properties

hidePreferences

hidePreferences: (() => void)

Hides the preferences panel.

showPreferences

showPreferences: ((newValue: GridPreferencePanelsValue, panelId?: string, labelId?: string) => void)

Displays the preferences panel. The newValue argument controls the content of the panel.

Type declaration

    • (newValue, panelId?, labelId?): void

    • Parameters

      • newValue: GridPreferencePanelsValue

        The panel to open. Use "filters" or "columns".

      • OptionalpanelId: string

        The unique panel id

      • OptionallabelId: string

        The unique button id

      Returns void

Settings

Member Visibility

On This Page

Properties