@mui/x-data-grid/models/api/gridCoreApi.d.ts

The community edition of the data grid component (MUI X).

import * as React from 'react';
import { GridEventPublisher, GridEventListener, GridEventsStr } from '../events';
import { EventManager, EventListenerOptions } from '../../utils/EventManager';
import { GridApiCaches } from '../gridApiCaches';
/**
 * The core API interface that is available in the grid `apiRef`.
 */
export interface GridCoreApi {
    /**
     * The React ref of the grid root container div element.
     * @ignore - do not document.
     */
    rootElementRef?: React.RefObject<HTMLDivElement>;
    /**
     * The React ref of the grid column container virtualized div element.
     * @ignore - do not document.
     */
    columnHeadersContainerElementRef?: React.RefObject<HTMLDivElement>;
    /**
     * The React ref of the grid column headers container element.
     * @ignore - do not document.
     */
    columnHeadersElementRef?: React.RefObject<HTMLDivElement>;
    /**
     * The React ref of the grid window container element.
     * @ignore - do not document.
     */
    windowRef?: React.RefObject<HTMLDivElement>;
    /**
     * The React ref of the grid data rendering zone.
     * @ignore - do not document.
     */
    renderingZoneRef?: React.RefObject<HTMLDivElement>;
    /**
     * The React ref of the grid header element.
     * @ignore - do not document.
     */
    headerRef?: React.RefObject<HTMLDivElement>;
    /**
     * The React ref of the grid footer element.
     * @ignore - do not document.
     */
    footerRef?: React.RefObject<HTMLDivElement>;
    /**
     * The generic event emitter manager.
     * @ignore - do not document
     */
    unstable_eventManager: EventManager;
    /**
     * The caches used by hooks and state initializers.
     * @ignore - do not document.
     */
    unstable_caches: GridApiCaches;
    /**
     * Registers a handler for an event.
     * @param {string} event The name of the event.
     * @param {function} handler The handler to be called.
     * @param {object} options Additional options for this listener.
     * @returns {function} A function to unsubscribe from this event.
     */
    subscribeEvent: <E extends GridEventsStr>(event: E, handler: GridEventListener<E>, options?: EventListenerOptions) => () => void;
    /**
     * Emits an event.
     * @param {GridEvents} name The name of the event.
     * @param {any} params Arguments to be passed to the handlers.
     * @param {MuiEvent<MuiBaseEvent>} event The event object to pass forward.
     */
    publishEvent: GridEventPublisher;
    /**
     * Displays the error overlay component.
     * @param {any} props Props to be passed to the `ErrorOverlay` component.
     */
    showError: (props: any) => void;
    /**
     * Unique identifier for each component instance in a page.
     * @ignore - do not document.
     */
    instanceId: number;
}