Static Functions
Root static functions of Grid Component
| Name | Parameters | Returns | Description |
|---|---|---|---|
| useGridExcelExport | options? : UseGridExcelExportOptions<T> | Hook for managing Excel export state and execution. Params: | |
| useGridPdfExport | options : UseGridPdfExportOptions<T> | Object | React hook for Grid PDF export functionality. Params: |
| pivotInputEqual | left : unknownright : unknown | boolean | Structural comparison keeps callback identity significant while tolerating equivalent inline objects. Params: |
| usePivot | props : Partial<GridProps<T>> | Object | Owns a React pivot report and derives immutable result state. @private Params: |
| useGridPrint | options : UseGridPrintOptions<T> | Custom hook managing grid print operations and loading state Params: | |
| selectPivotMemberDomain | props : Partial<GridProps<T>>fields : ColumnProps<T>[]filter : FilterSettingssearch : SearchSettingssettings : PivotSettings<T>field : string | Object | Options ignore their own UI filter, but retain all other source constraints. Params: |
| selectPivotSource | props : Partial<GridProps<T>>fields : ColumnProps<T>[]filter : FilterSettingssearch : SearchSettings | T[] | Complete-source branch: filtering/search precede pivot aggregation; source paging is never applied. Params: |
| applyPivotControlCommand | settings : PivotSettings<T>command : PivotControlCommandcapabilities : PivotFieldCapability<T>[] | Applies one validated panel command without mutating the current report. Params: | |
| getPivotFieldCapabilities | - | Collects the pivot field capabilities available for the supplied columns. | |
| customizePivotColumns | result : PivotResultsources : ColumnProps<T>[]callbacks : Pick<GridProps<T>> | Applies presentation callbacks outside the engine and worker boundary. Params: | |
| pivotUserPresentation | previous : ColumnProps<PivotResultRow>[]defaults : ColumnProps<PivotResultRow>[] | Extracts actual presentation changes without treating callback defaults as user choices. Params: | |
| createPivotMemberFormatter | columns : ColumnProps<T>[]formatter : IValueFormatter | Object | Creates a Grid formatter for pivot member captions without changing their identities. Params: |
| createReactPivotHost | locale? : string | PivotHost | The same formatting host is constructed independently in each execution context. Params: |
| pivotMemberOptions | - | Complete-source member identities; labels never participate in equality. | |
| reconcilePivotMemberFilters | - | Removed members are pruned against the complete domain, not other filters' visible subset. | |
| updatePivotMemberSelection | - | Set<string> | Select-all-matching changes only the visible popup options. |
| buildPivotResult | data : T[]sourceColumns : ColumnProps<T>[]settings : PivotSettings<T>host : PivotHost | Existing synchronous, complete-result path. Params: | |
| calculateCustomPivotValue | input : PivotInput<T>rowPath : PivotAxisPathcolumnPath : PivotAxisPathmeasure : PivotMeasureMetadata | number | Calculates a custom aggregate from the source rows that match the current pivot intersections. Params: |
| convertPivotResult | matrix : IAxisSet[][]input : PivotInput<T> | Converts the supplied engine viewport, without applying another page operation. Params: | |
| getPivotEngineFieldTypes | engine : PivotEngineinput : PivotInput<T> | Record<string, string> | Maps projected measure types back to the source fields. Params: |
| pivotMemberKey | value : unknown | string | Typed encoding prevents EJ2 member maps merging 1 with "1", or delimiters in labels. Params: |
| preparePivotInput | data : T[]sourceColumns : ColumnProps<T>[]settings : PivotSettings<T> | Validates and projects only report fields; caller-owned records remain untouched. Params: | |
| readPivotField | record : Tfield : string | unknown | Read source paths without confusing missing values with zero. Params: |
| reconcilePivotColumns | next : ColumnProps<PivotRow>[]previous : ColumnProps<PivotRow>[]preserveOrder? : boolean | Retains compatible user presentation choices while accepting the latest pivot schema. Params: | |
| visiblePivotRows | rows : PivotRow[]expanded : Set<string>sortField? : stringdescending? : booleanmemberSorts? : PivotMemberSort<unknown>[] | Sort siblings, retain totals at the end, then apply expansion before Grid paging. Params: | |
| packPivotInput | input : PivotInput<T> | Object | All transfer buffers are newly allocated and owned by this adapter. Params: |
| createPivotWorker | - | Worker | Kept separate so synchronous consumers never instantiate a worker. |
| flattenForRender | normalizedData : T[]expandedKeys : Set<string> | T[] | Flatten tree by expansion state. Params: |
| getAllTreeKeys | normalizedData : T[] | Set<string> | Get all tree keys from normalized data. Params: |
| normalizeChildrenFieldData | - | Mode 1: Normalize nested children array data. | |
| normalizeParentIdData | - | Mode 2: Normalize self-referential (parent ID) data. | |
| validateTreeDataModes | - | void | Validate tree data settings for mutual exclusivity. |
| PivotColumnMenu | - | ReactElement | Uses the same Pure React menu and submenu slots as the ordinary Grid. |
| PivotMemberFilter | - | ReactElement | A source-member popup. Search and checkbox changes remain local until Apply. |
| PivotPanel | props : PivotPanelProps<T> | ReactElement | Syncfusion field catalogue and assignment controls for a relational pivot report. Params: |
| PivotView | - | ReactElement | Composes source and derived Grid renderers without crossing their row-type boundaries. @private |