Static Functions

Root static functions of Grid Component

NameParametersReturnsDescription
useGridExcelExport
  • options?

    : UseGridExcelExportOptions<T>
  • Hook for managing Excel export state and execution.


    Params:
  • options: Optional grid-aware export options
  • useGridPdfExport
  • options

    : UseGridPdfExportOptions<T>
  • Object

    React hook for Grid PDF export functionality.


    Params:
  • options: Hook configuration options
  • pivotInputEqual
  • left

    : unknown
  • right

    : unknown
  • boolean

    Structural comparison keeps callback identity significant while tolerating equivalent inline objects.


    Params:
  • left: left.
  • right: right.
  • usePivot
  • props

    : Partial<GridProps<T>>
  • Object

    Owns a React pivot report and derives immutable result state. @private


    Params:
  • props: props.
  • useGridPrint
  • options

    : UseGridPrintOptions<T>
  • Custom hook managing grid print operations and loading state


    Params:
  • options: The grid print options
  • selectPivotMemberDomain
  • props

    : Partial<GridProps<T>>
  • fields

    : ColumnProps<T>[]
  • filter

    : FilterSettings
  • search

    : SearchSettings
  • settings

    : PivotSettings<T>
  • field

    : string
  • Object

    Options ignore their own UI filter, but retain all other source constraints.


    Params:
  • props: props.
  • fields: fields.
  • filter: filter.
  • search: search.
  • settings: settings.
  • field: field.
  • selectPivotSource
  • props

    : Partial<GridProps<T>>
  • fields

    : ColumnProps<T>[]
  • filter

    : FilterSettings
  • search

    : SearchSettings
  • T[]

    Complete-source branch: filtering/search precede pivot aggregation; source paging is never applied.


    Params:
  • props: props.
  • fields: fields.
  • filter: filter.
  • search: search.
  • applyPivotControlCommand
  • settings

    : PivotSettings<T>
  • command

    : PivotControlCommand
  • capabilities

    : PivotFieldCapability<T>[]
  • Applies one validated panel command without mutating the current report.


    Params:
  • settings: Current committed or draft report.
  • command: Panel command to apply.
  • capabilities: Available source fields and their supported roles.
  • getPivotFieldCapabilities
    -

    Collects the pivot field capabilities available for the supplied columns.

    customizePivotColumns
  • result

    : PivotResult
  • sources

    : ColumnProps<T>[]
  • callbacks

    : Pick<GridProps<T>>
  • Applies presentation callbacks outside the engine and worker boundary.


    Params:
  • result: Raw engine result and typed metadata.
  • sources: Source field definitions.
  • callbacks: Optional presentation callbacks.
  • pivotUserPresentation
  • previous

    : ColumnProps<PivotResultRow>[]
  • defaults

    : ColumnProps<PivotResultRow>[]
  • Extracts actual presentation changes without treating callback defaults as user choices.


    Params:
  • previous: Last displayed definitions.
  • defaults: Last customized defaults.
  • createPivotMemberFormatter
  • columns

    : ColumnProps<T>[]
  • formatter

    : IValueFormatter
  • Object

    Creates a Grid formatter for pivot member captions without changing their identities.


    Params:
  • columns: Source Grid columns.
  • formatter: Locale-aware Grid formatting service.
  • createReactPivotHost
  • locale?

    : string
  • PivotHost

    The same formatting host is constructed independently in each execution context.


    Params:
  • locale: locale.
  • 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:
  • data: data.
  • sourceColumns: sourceColumns.
  • settings: settings.
  • host: host.
  • calculateCustomPivotValue
  • input

    : PivotInput<T>
  • rowPath

    : PivotAxisPath
  • columnPath

    : PivotAxisPath
  • measure

    : PivotMeasureMetadata
  • number

    Calculates a custom aggregate from the source rows that match the current pivot intersections.


    Params:
  • input: Pivot projection and source data.
  • rowPath: Current row-axis path.
  • columnPath: Current column-axis path.
  • measure: Target measure metadata.
  • convertPivotResult
  • matrix

    : IAxisSet[][]
  • input

    : PivotInput<T>
  • Converts the supplied engine viewport, without applying another page operation.


    Params:
  • matrix: matrix.
  • input: input.
  • getPivotEngineFieldTypes
  • engine

    : PivotEngine
  • input

    : PivotInput<T>
  • Record<string, string>

    Maps projected measure types back to the source fields.


    Params:
  • engine: Engine containing the projected field types.
  • input: Prepared input mapping measures to source fields.
  • pivotMemberKey
  • value

    : unknown
  • string

    Typed encoding prevents EJ2 member maps merging 1 with "1", or delimiters in labels.


    Params:
  • value: value.
  • preparePivotInput
  • data

    : T[]
  • sourceColumns

    : ColumnProps<T>[]
  • settings

    : PivotSettings<T>
  • Validates and projects only report fields; caller-owned records remain untouched.


    Params:
  • data: data.
  • sourceColumns: sourceColumns.
  • settings: settings.
  • readPivotField
  • record

    : T
  • field

    : string
  • unknown

    Read source paths without confusing missing values with zero.


    Params:
  • record: record.
  • field: field.
  • reconcilePivotColumns
  • next

    : ColumnProps<PivotRow>[]
  • previous

    : ColumnProps<PivotRow>[]
  • preserveOrder?

    : boolean
  • Retains compatible user presentation choices while accepting the latest pivot schema.


    Params:
  • next: next.
  • previous: previous.
  • preserveOrder: preserveOrder.
  • visiblePivotRows
  • rows

    : PivotRow[]
  • expanded

    : Set<string>
  • sortField?

    : string
  • descending?

    : boolean
  • memberSorts?

    : PivotMemberSort<unknown>[]
  • Sort siblings, retain totals at the end, then apply expansion before Grid paging.


    Params:
  • rows: rows.
  • expanded: expanded.
  • sortField: sortField.
  • descending: descending.
  • memberSorts: Sort directions for dimension members.
  • packPivotInput
  • input

    : PivotInput<T>
  • Object

    All transfer buffers are newly allocated and owned by this adapter.


    Params:
  • input: input.
  • createPivotWorker
    -
    Worker

    Kept separate so synchronous consumers never instantiate a worker.

    flattenForRender
  • normalizedData

    : T[]
  • expandedKeys

    : Set<string>
  • T[]

    Flatten tree by expansion state.


    Params:
  • normalizedData: Flat array of normalized rows.
  • expandedKeys: Set of treeKeys currently expanded.
  • getAllTreeKeys
  • normalizedData

    : T[]
  • Set<string>

    Get all tree keys from normalized data.


    Params:
  • normalizedData: Flat array of normalized rows.
  • 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:
  • props: Panel settings and callbacks.
  • PivotView
    -
    ReactElement

    Composes source and derived Grid renderers without crossing their row-type boundaries. @private