Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • dataTestId - Sets the testing hook ID for automated testing. For example, setting it to "sales-pivot-grid" allows test scripts to reliably locate this specific pivot grid component.

Guidelines

Pivot Grid — Guidelines

Usage

  • Use the component to analyze multi-dimensional data with configurable fields and aggregations defined in elements; enable the field panel when users must pivot dimensions themselves using showFieldPanel, showDataFields, showRowFields, showColumnFields, showFilterFields, and allowFieldDragging.
  • Hide the field panel when users only need to read results to keep attention on the matrix using showFieldPanel set to false.
  • Enable allowFiltering when users need to narrow visible data without changing the underlying dataSourceId or getEntityCollectionHttpRequestParametersMap.
  • Enable allowSorting when comparative or ranked views are required so users can sort by row or column headers.
  • Surface summary context by turning on showColumnGrandTotals and showRowGrandTotals when high-level rollups are essential.
  • Provide intermediate summaries by enabling showRowTotals and showColumnTotals for grouped analyses; disable them when they add clutter.
  • Use useMockData for demos or prototyping when a live dataSourceId is not yet available.

Sizing & Layout

  • Provide concise context via titleTranslations and subtitleTranslations; keep text short to avoid header truncation the component cannot manage automatically.
  • Improve legibility in dense matrices by turning on showBorders to delineate cells.

Data-Driven / Conditional Behavior

  • Define analytic structure in elements by assigning fields to row, column, data, and filter roles with appropriate aggregations so the grid renders meaningful pivots.
  • Keep grand totals and subtotals consistent with field roles by pairing showRowTotals with row groups and showColumnTotals with column groups.

Content & Localization

  • Localize the grid title and subtitle using titleTranslations and subtitleTranslations to match user locale.
  • Use displayName for authoring clarity in the structure panel without affecting end-user strings.
  • Keep localized titles succinct and specific; avoid placing critical instructions here because titles and subtitles are static text, not interactive hints.

...