slickgrid-react
Version:
Slickgrid components made available in React
36 lines (35 loc) • 1.76 kB
TypeScript
import type { BackendService, ExtensionService, FilterService, GridEventService, GridService, GridStateService, HeaderGroupingService, PaginationService, ResizerService, SlickDataView, SlickGrid, SortService, TreeDataService } from '@slickgrid-universal/common';
import type { EventPubSubService } from '@slickgrid-universal/event-pub-sub';
export interface SlickgridReactInstance {
element: HTMLDivElement;
/** Slick DataView object */
dataView: SlickDataView;
/** Slick Grid object */
slickGrid: SlickGrid;
/** Dispose of the grid and optionally empty the DOM element grid container as well */
dispose: (emptyDomElementContainer?: boolean) => void;
/** Backend Service, when available */
backendService?: BackendService;
/** EventPubSub Service instance that is used internal by the lib and could be used externally to subscribe to Slickgrid-React events */
eventPubSubService?: EventPubSubService;
/** Extension (Plugins & Controls) Service */
extensionService: ExtensionService;
/** Filter Service */
filterService: FilterService;
/** Grid Service (grid extra functionalities) */
gridService: GridService;
/** Grid Events Service */
gridEventService: GridEventService;
/** Grid State Service */
gridStateService: GridStateService;
/** Grouping (and colspan) Service */
headerGroupingService: HeaderGroupingService;
/** Pagination Service (allows you to programmatically go to first/last page, etc...) */
paginationService?: PaginationService;
/** Resizer Service (including auto-resize) */
resizerService: ResizerService;
/** Sort Service */
sortService: SortService;
/** Tree Data View Service */
treeDataService: TreeDataService;
}