(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)

Pivot grid

 Pivot Grid is an advanced data visualization component that allows users to analyze multi-dimensional data by grouping, filtering, and summarizing information. It provides interactive capabilities for data exploration, enabling users to pivot data across different dimensions and view aggregated metrics in a customizable grid format.

General Properties

• displayName - Sets the display name of the component shown in the structure panel. For example, "Sales Analysis Grid" allows for easy identification of the component's purpose within the UI builder interface.

• id - Specifies a unique identifier for the component used for programmatic access. For example, "salesByRegionPivotGrid" enables targeted manipulation of this specific pivot grid through actions or events.

Visual Properties

• titleTranslations - Sets the title text displayed above the pivot grid, with support for multiple languages. For example, {"en-US": "Sales by Region", "de-DE": "Verkauf nach Region"} provides localized titles for different user languages.

• subtitleTranslations - Sets a secondary text displayed below the title, with language support. For example, {"en-US": "Annual Analysis", "fr-FR": "Analyse Annuelle"} provides additional context about the data being displayed.

• showBorders - Determines whether borders are displayed around the pivot grid cells. When enabled, grid cells are visually separated with border lines, making the data structure more clearly defined.

• allowFiltering - Enables the ability to filter data within the pivot grid. When enabled, users can apply filters to narrow down the displayed data based on specific criteria, such as showing only data for specific regions.

• allowSorting - Enables sorting functionality within the pivot grid. When enabled, users can sort data in ascending or descending order by clicking on column or row headers.

• showColumnGrandTotals - Controls the visibility of grand totals for columns. When enabled, displays summary totals at the end of each column group, providing aggregated values across all rows.

• showRowGrandTotals - Controls the visibility of grand totals for rows. When enabled, displays summary totals at the end of each row group, providing aggregated values across all columns.

• showRowTotals - Controls the visibility of subtotals for individual row groups. When enabled, displays totals for each group of row values, providing intermediate summaries within the data hierarchy.

• showColumnTotals - Controls the visibility of subtotals for individual column groups. When enabled, displays totals for each group of column values, providing intermediate summaries within the data structure.

Field Panel Properties

• showFieldPanel - Activates the field panel interface for the pivot grid. When enabled, displays a panel that allows users to interactively drag and drop fields between different areas of the pivot grid.

• showDataFields - Controls the visibility of data fields in the field panel. When enabled and showFieldPanel is true, displays the available data fields that can be used for calculations and aggregations.

• showRowFields - Controls the visibility of row fields in the field panel. When enabled and showFieldPanel is true, displays fields that can be assigned to row dimensions of the pivot grid.

• showColumnFields - Controls the visibility of column fields in the field panel. When enabled and showFieldPanel is true, displays fields that can be assigned to column dimensions of the pivot grid.

• showFilterFields - Controls the visibility of filter fields in the field panel. When enabled and showFieldPanel is true, displays fields that can be used to filter the entire pivot grid dataset.

• allowFieldDragging - Enables drag-and-drop field rearrangement in the field panel. When enabled and showFieldPanel is true, users can drag fields between different areas to reorganize the pivot grid structure.

Field Configuration

• elements - Defines the fields and their configuration for the pivot grid. This array contains DynamicPivotGridFieldComponent objects with properties like dataField, caption, area, and aggregation functions. For example, configuring a "region" field for rows, a "date" field for columns, and an "amount" field for data with sum aggregation.

Data Source Properties

• dataSourceId - Specifies the data source ID for retrieving pivot grid data. For example, "api/sales/analysis" connects the pivot grid to the sales analysis API endpoint.

• getEntityCollectionHttpRequestParametersMap - Configures HTTP parameters for data fetching. This object maps additional parameters needed for the data request, such as {"year": "currentYear"} to filter data for a specific year.

• useMockData - Determines whether sample data is used for the pivot grid. When enabled, the component will use built-in sample data instead of fetching from an API, useful for prototyping or demonstration purposes.

Events

• events - Configures the events that the component can trigger and respond to:
  • ON_INIT: Triggered when the pivot grid component is initialized. Can be used to perform setup operations or fetch additional context data.
  • ON_DESTROY: Triggered when the pivot grid component is removed from the DOM. Useful for cleanup operations when navigating away from a page.

Testing Hooks

• 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.