jsDocs.io logo

ag-grid-react

  • Version 28.1.0
  • Published
  • 320 kB
  • 1 dependency
  • MIT license

Install

npm i ag-grid-react
yarn add ag-grid-react
pnpm add ag-grid-react

Overview

AG Grid React Component

Index

Classes

Interfaces

Classes

class AgGridColumn

class AgGridColumn extends Component<
    AgGridColumnProps | AgGridColumnGroupProps,
    {}
> {}

    method hasChildColumns

    static hasChildColumns: (children: any) => boolean;

      method mapChildColumnDefs

      static mapChildColumnDefs: (children: any) => any;

        method render

        render: () => any;

          method toColDef

          static toColDef: (columnProps: any) => ColDef;

            class AgGridReact

            class AgGridReact<TData = any> extends Component<
                AgGridReactProps<TData> | AgReactUiProps<TData>,
                {}
            > {}

              property api

              api: GridApi<TData>;

                property columnApi

                columnApi: ColumnApi;

                  method render

                  render: () => JSX.Element;

                    Interfaces

                    interface AgGridColumnGroupProps

                    interface AgGridColumnGroupProps extends ColGroupDef {}

                      interface AgGridColumnProps

                      interface AgGridColumnProps extends ColDef {}

                        interface AgGridReactProps

                        interface AgGridReactProps<TData = any> extends SharedProps<TData> {}

                          property children

                          children?: any;

                            property disableStaticMarkup

                            disableStaticMarkup?: boolean;

                              property legacyComponentRendering

                              legacyComponentRendering?: boolean;

                                property rowDataChangeDetectionStrategy

                                rowDataChangeDetectionStrategy?: ChangeDetectionStrategyType;

                                  interface AgReactComponent

                                  interface AgReactComponent {}

                                    property getReactContainerClasses

                                    getReactContainerClasses?: () => string[];

                                      property getReactContainerStyle

                                      getReactContainerStyle?: () => {};

                                        interface AgReactUiProps

                                        interface AgReactUiProps<TData = any> extends SharedProps<TData> {}

                                          interface ICellEditorReactComp

                                          interface ICellEditorReactComp extends ICellEditor, AgReactComponent {}

                                            interface ICellRendererReactComp

                                            interface ICellRendererReactComp extends ICellRenderer, AgReactComponent {}

                                              interface IDateReactComp

                                              interface IDateReactComp extends IDate, AgReactComponent {}

                                                interface IFilterReactComp

                                                interface IFilterReactComp extends IFilter, AgReactComponent {}

                                                  interface IFloatingFilterReactComp

                                                  interface IFloatingFilterReactComp extends IFloatingFilter, AgReactComponent {}

                                                    interface IHeaderGroupReactComp

                                                    interface IHeaderGroupReactComp extends IHeaderGroup, AgReactComponent {}

                                                      interface IHeaderReactComp

                                                      interface IHeaderReactComp extends IHeader, AgReactComponent {}

                                                        interface ILoadingCellRendererReactComp

                                                        interface ILoadingCellRendererReactComp extends AgReactComponent {}

                                                          interface ILoadingOverlayReactComp

                                                          interface ILoadingOverlayReactComp extends AgReactComponent {}

                                                            interface INoRowsOverlayReactComp

                                                            interface INoRowsOverlayReactComp extends AgReactComponent {}

                                                              interface IStatusPanelReactComp

                                                              interface IStatusPanelReactComp extends IStatusPanel, AgReactComponent {}

                                                                interface IToolPanelReactComp

                                                                interface IToolPanelReactComp extends IToolPanel, AgReactComponent {}

                                                                  interface ITooltipReactComp

                                                                  interface ITooltipReactComp extends AgReactComponent {}

                                                                    interface SharedProps

                                                                    interface SharedProps<TData = any> extends GridOptions<TData> {}

                                                                      property className

                                                                      className?: string;

                                                                        property componentWrappingElement

                                                                        componentWrappingElement?: string;

                                                                          property containerStyle

                                                                          containerStyle?: any;

                                                                            property gridOptions

                                                                            gridOptions?: GridOptions<TData>;

                                                                              property maxComponentCreationTimeMs

                                                                              maxComponentCreationTimeMs?: number;

                                                                                property modules

                                                                                modules?: Module[];

                                                                                  property setGridApi

                                                                                  setGridApi?: (gridApi: GridApi<TData>, columnApi: ColumnApi) => void;

                                                                                    Package Files (4)

                                                                                    Dependencies (1)

                                                                                    Dev Dependencies (38)

                                                                                    Peer Dependencies (3)

                                                                                    Badge

                                                                                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ag-grid-react.

                                                                                    • Markdown
                                                                                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/ag-grid-react)
                                                                                    • HTML
                                                                                      <a href="https://www.jsdocs.io/package/ag-grid-react"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>