@gooddata/sdk-ui-pivot 11.8.0-alpha.2 → 11.8.0-alpha.4

package/esm/sdk-ui-pivot.d.ts

@@ -9,6 +9,7 @@
 
 import { AttributesMeasuresOrPlaceholders } from '@gooddata/sdk-ui';
 import { AttributesOrPlaceholders } from '@gooddata/sdk-ui';
+import { ExplicitDrill } from '@gooddata/sdk-ui';
 import { IAnalyticalBackend } from '@gooddata/sdk-backend-spi';
 import { IAttribute } from '@gooddata/sdk-model';
 import { IBackendCapabilities } from '@gooddata/sdk-backend-spi';
@@ -34,16 +35,31 @@ import { WrappedComponentProps } from 'react-intl';
  */
 export declare type ColumnHeadersPosition = "top" | "left";
 
+/**
+ * @public
+ */
+export declare type ColumnHeadersPositionNext = "left" | "top";
+
 /**
  * @public
  */
 export declare type ColumnLocator = IAttributeColumnLocator | IMeasureColumnLocator | ITotalColumnLocator;
 
+/**
+ * @public
+ */
+export declare type ColumnLocatorNext = IAttributeColumnLocatorNext | IMeasureColumnLocatorNext | ITotalColumnLocatorNext;
+
 /**
  * @public
  */
 export declare type ColumnResizedCallback = (columnWidths: ColumnWidthItem[]) => void;
 
+/**
+ * @public
+ */
+export declare type ColumnResizedCallbackNext = (columnWidths: ColumnWidthItemNext[]) => void;
+
 /**
  * @public
  */
@@ -54,6 +70,16 @@ export declare type ColumnWidth = IAbsoluteColumnWidth | IAutoColumnWidth;
  */
 export declare type ColumnWidthItem = IAttributeColumnWidthItem | IMeasureColumnWidthItem | ISliceMeasureColumnWidthItem | IMixedValuesColumnWidthItem | IAllMeasureColumnWidthItem | IWeakMeasureColumnWidthItem;
 
+/**
+ * @public
+ */
+export declare type ColumnWidthItemNext = IAttributeColumnWidthItemNext | IMeasureColumnWidthItemNext | ISliceMeasureColumnWidthItemNext | IMixedValuesColumnWidthItemNext | IAllMeasureColumnWidthItemNext | IWeakMeasureColumnWidthItemNext;
+
+/**
+ * @public
+ */
+export declare type ColumnWidthNext = IAbsoluteColumnWidthNext | IAutoColumnWidthNext;
+
 /**
  * @internal
  */
@@ -64,6 +90,11 @@ export declare function CorePivotTable(props: ICorePivotTableProps): JSX.Element
  */
 export declare type DefaultColumnWidth = "unset" | "autoresizeAll" | "viewport";
 
+/**
+ * @public
+ */
+export declare type DefaultColumnWidthNext = "unset" | "autoresizeAll" | "viewport";
+
 /**
  * Prepares dimensions for pivot table execution from buckets and info if table is transposed or not.
  *
@@ -81,6 +112,14 @@ export declare interface IAbsoluteColumnWidth {
     allowGrowToFit?: boolean;
 }
 
+/**
+ * @public
+ */
+export declare interface IAbsoluteColumnWidthNext {
+    value: number;
+    allowGrowToFit?: boolean;
+}
+
 /**
  * @public
  */
@@ -97,6 +136,22 @@ export declare interface IAllMeasureColumnWidthItemBody {
     width: IAbsoluteColumnWidth;
 }
 
+/**
+ * Object defining {@link IAllMeasureColumnWidthItem} object body.
+ *
+ * @public
+ */
+export declare interface IAllMeasureColumnWidthItemBodyNext {
+    width: IAbsoluteColumnWidthNext;
+}
+
+/**
+ * @public
+ */
+export declare interface IAllMeasureColumnWidthItemNext {
+    measureColumnWidthItem: IAllMeasureColumnWidthItemBodyNext;
+}
+
 /**
  * Locates all columns for an attribute or columns for particular attribute element.
  *
@@ -122,6 +177,31 @@ export declare interface IAttributeColumnLocatorBody {
     element?: string | null;
 }
 
+/**
+ * Object defining the {@link IAttributeColumnLocator} object body.
+ *
+ * @public
+ */
+export declare interface IAttributeColumnLocatorBodyNext {
+    /**
+     * Local identifier of the attribute
+     */
+    attributeIdentifier: Identifier;
+    /**
+     * Attribute element URI / primary key.
+     */
+    element?: string | null;
+}
+
+/**
+ * Locates all columns for an attribute or columns for particular attribute element.
+ *
+ * @public
+ */
+export declare interface IAttributeColumnLocatorNext {
+    attributeLocatorItem: IAttributeColumnLocatorBodyNext;
+}
+
 /**
  * @public
  */
@@ -139,6 +219,23 @@ export declare interface IAttributeColumnWidthItemBody {
     attributeIdentifier: Identifier;
 }
 
+/**
+ * Object defining the {@link IAttributeColumnWidthItem} object body.
+ *
+ * @public
+ */
+export declare interface IAttributeColumnWidthItemBodyNext {
+    width: IAbsoluteColumnWidthNext;
+    attributeIdentifier: Identifier;
+}
+
+/**
+ * @public
+ */
+export declare interface IAttributeColumnWidthItemNext {
+    attributeColumnWidthItem: IAttributeColumnWidthItemBodyNext;
+}
+
 /**
  * @public
  */
@@ -146,6 +243,13 @@ export declare interface IAutoColumnWidth {
     value: "auto";
 }
 
+/**
+ * @public
+ */
+export declare interface IAutoColumnWidthNext {
+    value: "auto";
+}
+
 /**
  * @public
  */
@@ -173,6 +277,64 @@ export declare interface IColumnSizing {
     columnWidths?: ColumnWidthItem[];
 }
 
+/**
+ * @public
+ */
+export declare interface IColumnSizingNext {
+    /**
+     * Indicate that the table should grow to fit into the allocated space.
+     *
+     * @remarks
+     * Default: false
+     */
+    growToFit?: boolean;
+    /**
+     * Specify whether columns should be resized to fill the entire viewport.
+     *
+     * @remarks
+     * Default: unset
+     */
+    defaultWidth?: DefaultColumnWidthNext;
+    /**
+     * Specify custom column widths to apply.
+     *
+     * @remarks
+     * Default: none
+     */
+    columnWidths?: ColumnWidthItemNext[];
+}
+
+/**
+ * Column text wrapping item that specifies text wrapping settings for specific column(s).
+ *
+ * @public
+ */
+export declare interface IColumnTextWrappingItem {
+    /**
+     * Column locators to identify which column this wrapping applies to.
+     */
+    locators: ColumnLocatorNext[];
+    /**
+     * Whether to wrap text in cells for the specified columns.
+     */
+    wrapText?: boolean;
+    /**
+     * Whether to wrap text in column headers for the specified columns.
+     */
+    wrapHeaderText?: boolean;
+    /**
+     * Match type determines how the locators are matched against columns.
+     *
+     * - "column" (default): Exact match - all locators must match exactly
+     * - "pivotGroup": Pivot group match - locators match the pivot group and all its descendant columns
+     *
+     * @remarks
+     * Use "pivotGroup" for pivot group headers to match all descendant columns.
+     * Use "column" (or omit) for specific column overrides.
+     */
+    matchType?: "column" | "pivotGroup";
+}
+
 /**
  * @internal
  */
@@ -202,6 +364,27 @@ export declare interface IMeasureColumnLocatorBody {
     measureIdentifier: Identifier;
 }
 
+/**
+ * Object defining the {@link IMeasureColumnLocator} object body.
+ *
+ * @public
+ */
+export declare interface IMeasureColumnLocatorBodyNext {
+    /**
+     * Local identifier of the measure.
+     */
+    measureIdentifier: Identifier;
+}
+
+/**
+ * Locates table column by column measure's localId.
+ *
+ * @public
+ */
+export declare interface IMeasureColumnLocatorNext {
+    measureLocatorItem: IMeasureColumnLocatorBodyNext;
+}
+
 /**
  * @public
  */
@@ -219,6 +402,23 @@ export declare interface IMeasureColumnWidthItemBody {
     locators: ColumnLocator[];
 }
 
+/**
+ * Object defining the {@link IMeasureColumnWidthItem} object body.
+ *
+ * @public
+ */
+export declare interface IMeasureColumnWidthItemBodyNext {
+    width: ColumnWidthNext;
+    locators: ColumnLocatorNext[];
+}
+
+/**
+ * @public
+ */
+export declare interface IMeasureColumnWidthItemNext {
+    measureColumnWidthItem: IMeasureColumnWidthItemBodyNext;
+}
+
 /**
  * @public
  */
@@ -258,6 +458,46 @@ export declare interface IMenu {
     aggregationsSubMenuForRows?: boolean;
 }
 
+/**
+ * Configuration for the aggregations menu.
+ *
+ * @public
+ */
+export declare interface IMenuNext {
+    /**
+     * If true, grand totals and subtotals can be added to the table using table menu.
+     *
+     * @remarks
+     * Default: false
+     */
+    aggregations?: boolean;
+    /**
+     * If true, subtotals can be added to the table using table menu.
+     *
+     * @remarks
+     * Default: false
+     */
+    aggregationsSubMenu?: boolean;
+    /**
+     * Specifies which aggregation functions can be selected from the menu.
+     *
+     * @remarks
+     * Note: this option only impacts available menu items. It will not be used to filter totals that
+     * you specify on the pivot table props.
+     *
+     * Default: all available types.
+     */
+    aggregationTypes?: TotalType[];
+    /**
+     * If true, total and subtotals for columns (yes, for columns, although the naming is rows) can be added to the table using table menu.
+     * This will be removed in the future, it's under feature flag control for development purposes.
+     *
+     * @remarks
+     * Default: false
+     */
+    aggregationsSubMenuForRows?: boolean;
+}
+
 /**
  * @public
  */
@@ -275,6 +515,23 @@ export declare interface IMixedValuesColumnWidthItemBody {
     locators: IMeasureColumnLocator[];
 }
 
+/**
+ * Object defining the {@link IMixedValuesColumnWidthItemBody } object body.
+ *
+ * @public
+ */
+export declare interface IMixedValuesColumnWidthItemBodyNext {
+    width: ColumnWidthNext;
+    locators: IMeasureColumnLocatorNext[];
+}
+
+/**
+ * @public
+ */
+export declare interface IMixedValuesColumnWidthItemNext {
+    mixedValuesColumnWidthItem: IMixedValuesColumnWidthItemBodyNext;
+}
+
 /**
  * @public
  */
@@ -406,6 +663,82 @@ export declare interface IPivotTableConfig {
     enableExecutionCancelling?: boolean;
 }
 
+/**
+ * Props for the PivotTableNext component.
+ *
+ * @remarks
+ * PivotTableNext is the new implementation of the pivot table built on AG Grid Enterprise.
+ * It replaces the legacy PivotTable component and offers improved performance, accessibility,
+ * text wrapping, cell selection, and other enhanced features.
+ *
+ * See {@link PivotTableNext} for more information.
+ *
+ * @public
+ */
+export declare interface IPivotTableNextProps extends IVisualizationProps, IVisualizationCallbacks {
+    /**
+     * Backend to use for the pivot table.
+     */
+    backend?: IAnalyticalBackend;
+    /**
+     * Workspace to use for the pivot table.
+     */
+    workspace?: string;
+    /**
+     * Columns to display in the pivot table.
+     */
+    columns?: AttributesOrPlaceholders;
+    /**
+     * Rows to display in the pivot table.
+     */
+    rows?: AttributesOrPlaceholders;
+    /**
+     * Measures to display in the pivot table.
+     */
+    measures?: AttributesMeasuresOrPlaceholders;
+    /**
+     * Filters to apply to the pivot table.
+     */
+    filters?: NullableFiltersOrPlaceholders;
+    /**
+     * Totals to display in the pivot table.
+     */
+    totals?: TotalsOrPlaceholders;
+    /**
+     * Sort by to apply to the pivot table.
+     */
+    sortBy?: SortsOrPlaceholders;
+    /**
+     * Configure drillability; e.g. which parts of the visualization can be interacted with.
+     */
+    drillableItems?: ExplicitDrill[];
+    /**
+     * Configuration for the pivot table.
+     */
+    config?: PivotTableNextConfig;
+    /**
+     * Customize size of page when fetching data from backend.
+     *
+     * @remarks
+     * Default is 100.
+     */
+    pageSize?: number;
+    /**
+     * Specify function to call when user manually resizes a table column.
+     *
+     * @param columnWidths - new widths for columns
+     */
+    onColumnResized?: ColumnResizedCallbackNext;
+    /**
+     * Execution configuration to apply when computing data for the table.
+     */
+    execConfig?: IExecutionConfig;
+    /**
+     * Optional resolution context for composed placeholders.
+     */
+    placeholdersResolutionContext?: any;
+}
+
 /**
  * @public
  */
@@ -471,6 +804,23 @@ export declare interface ISliceMeasureColumnWidthItemBody {
     locators: IMeasureColumnLocator[];
 }
 
+/**
+ * Object defining the {@link ISliceMeasureColumnWidthItem } object body.
+ *
+ * @public
+ */
+export declare interface ISliceMeasureColumnWidthItemBodyNext {
+    width: ColumnWidthNext;
+    locators: IMeasureColumnLocatorNext[];
+}
+
+/**
+ * @public
+ */
+export declare interface ISliceMeasureColumnWidthItemNext {
+    sliceMeasureColumnWidthItem: ISliceMeasureColumnWidthItemBodyNext;
+}
+
 /**
  * Tests whether object is an instance of {@link IMeasureColumnLocator}
  *
@@ -513,6 +863,28 @@ export declare function isTotalColumnLocator(obj: unknown): obj is ITotalColumnL
  */
 export declare function isWeakMeasureColumnWidthItem(obj: unknown): obj is IWeakMeasureColumnWidthItem;
 
+/**
+ * @public
+ */
+export declare interface ITextWrapping {
+    /**
+     * Whether to wrap text in cells (global for all columns).
+     */
+    wrapText?: boolean;
+    /**
+     * Whether to wrap text in column headers (global for all columns).
+     */
+    wrapHeaderText?: boolean;
+    /**
+     * Per-column text wrapping overrides that take precedence over the global settings.
+     *
+     * @remarks
+     * Each item specifies text wrapping for one or more columns identified by locators.
+     * This allows different columns to have different text wrapping settings.
+     */
+    columnOverrides?: IColumnTextWrappingItem[];
+}
+
 /**
  * Locates all columns for a columns for particular total.
  *
@@ -538,6 +910,31 @@ export declare interface ITotalColumnLocatorBody {
     totalFunction: string;
 }
 
+/**
+ * Object defining the {@link ITotalColumnLocator} object body.
+ *
+ * @public
+ */
+export declare interface ITotalColumnLocatorBodyNext {
+    /**
+     * Local identifier of the attribute inside which the subtotal is put
+     */
+    attributeIdentifier: Identifier;
+    /**
+     * Function for the total, such as sum, max, min, ...
+     */
+    totalFunction: string;
+}
+
+/**
+ * Locates all columns for a columns for particular total.
+ *
+ * @public
+ */
+export declare interface ITotalColumnLocatorNext {
+    totalLocatorItem: ITotalColumnLocatorBodyNext;
+}
+
 /**
  * @public
  */
@@ -555,11 +952,39 @@ export declare interface IWeakMeasureColumnWidthItemBody {
     locator: IMeasureColumnLocator;
 }
 
+/**
+ * Object defining the {@link IWeakMeasureColumnWidthItem} object body.
+ *
+ * @public
+ */
+export declare interface IWeakMeasureColumnWidthItemBodyNext {
+    width: IAbsoluteColumnWidthNext;
+    locator: IMeasureColumnLocatorNext;
+}
+
+/**
+ * @public
+ */
+export declare interface IWeakMeasureColumnWidthItemNext {
+    measureColumnWidthItem: IWeakMeasureColumnWidthItemBodyNext;
+}
+
 /**
  * @public
  */
 export declare type MeasureGroupDimension = "columns" | "rows";
 
+/**
+ * Whether to display measures in columns or rows (transposed).
+ *
+ * This affects how execution and result of the table is constructed:
+ * - "columns" - measures are included in the first dimension (top to bottom).
+ * - "rows" - measures are included in the second dimension (left to right).
+ *
+ * @public
+ */
+export declare type MeasureGroupDimensionNext = "columns" | "rows";
+
 /**
  * Creates a new attribute column locator
  *
@@ -659,6 +1084,168 @@ export declare function PivotTable(props: IPivotTableProps): JSX.Element;
  */
 export declare function pivotTableMenuForCapabilities(capabilities: IBackendCapabilities, desiredMenu?: IMenu): IMenu;
 
+/**
+ * PivotTableNext is the new pivot table component built on AG Grid Enterprise.
+ *
+ * This component replaces the legacy PivotTable component and offers:
+ * - Better performance for large datasets
+ * - Configurable text wrapping for long content
+ * - Cell selection and copy capabilities
+ * - Advanced column resizing options
+ *
+ * @remarks
+ * This component uses AG Grid Enterprise. While an AG Grid license is optional,
+ * tables will display a watermark without one. For production use, you can provide
+ * your license via the `agGridToken` prop or using `AgGridTokenProvider`.
+ *
+ * The legacy PivotTable component will be replaced by PivotTableNext in the next major version.
+ * We will also remove all '*next' suffixes from the component names and move this component to
+ * the main package exports.
+ *
+ * @public
+ */
+export declare function PivotTableNext(props: IPivotTableNextProps): JSX.Element;
+
+/**
+ * AG Grid Enterprise license configuration.
+ *
+ * @public
+ */
+export declare interface PivotTableNextAgGridLicenseConfig {
+    /**
+     * AG Grid Enterprise license token. If provided, it will be applied to AG Grid to unlock
+     * enterprise features.
+     */
+    agGridToken?: string;
+}
+
+/**
+ * @public
+ */
+export declare type PivotTableNextCellSelectionConfig = {
+    /**
+     * If true, enables cell selection in the pivot table.
+     *
+     * @remarks
+     * When enabled, users will be able to select cells in the table.
+     * When disabled, cell selection and focus will be suppressed. This is useful
+     * in scenarios like dashboard edit mode where cell interaction should be prevented.
+     *
+     * Default: true
+     */
+    enableCellSelection?: boolean;
+};
+
+/**
+ * @public
+ */
+export declare type PivotTableNextColumnsSizingConfig = {
+    /**
+     * Customize column sizing strategy.
+     */
+    columnSizing?: IColumnSizingNext;
+};
+
+/**
+ * Configuration for the pivot table next.
+ *
+ * @public
+ */
+export declare type PivotTableNextConfig = PivotTableNextTranspositionConfig & PivotTableNextTextWrappingConfig & PivotTableNextColumnsSizingConfig & PivotTableNextMenuConfig & PivotTableNextFormattingConfig & PivotTableNextExecutionCancellingConfig & PivotTableNextLayoutConfig & PivotTableNextCellSelectionConfig & PivotTableNextAgGridLicenseConfig & PivotTableNextExperimentalConfig;
+
+/**
+ * Configuration for execution cancelling.
+ *
+ * @public
+ */
+export declare interface PivotTableNextExecutionCancellingConfig {
+    /**
+     * Whether to enable execution cancelling for data loading.
+     */
+    enableExecutionCancelling?: boolean;
+}
+
+/**
+ * Configuration for pivot table experimental features.
+ *
+ * @public
+ */
+export declare interface PivotTableNextExperimentalConfig {
+    /**
+     * Enable automatic reset of column sizing when container width changes or column structure changes.
+     * This fixes issues where tables with growToFit don't expand to full width after tab switching.
+     *
+     * Default: true
+     */
+    enablePivotTableAutoSizeReset?: boolean;
+}
+
+/**
+ * Configuration for formatting.
+ *
+ * @public
+ */
+export declare interface PivotTableNextFormattingConfig {
+    /**
+     * Customize number segment separators (thousands, decimals)
+     */
+    separators?: ISeparators;
+}
+
+/**
+ * Layout-related configuration for the PivotTableNext component.
+ *
+ * @public
+ */
+export declare interface PivotTableNextLayoutConfig {
+    /**
+     * Customize maximum height of the table in pixels.
+     */
+    maxHeight?: number;
+}
+
+/**
+ * @public
+ */
+export declare type PivotTableNextMenuConfig = {
+    /**
+     * Configuration for the aggregations menu.
+     */
+    menu?: IMenuNext;
+};
+
+/**
+ * @public
+ */
+export declare type PivotTableNextTextWrappingConfig = {
+    /**
+     * Configure text wrapping.
+     */
+    textWrapping?: ITextWrapping;
+};
+
+/**
+ * @public
+ */
+export declare type PivotTableNextTranspositionConfig = {
+    /**
+     * Whether to display measures in columns or rows (transposed).
+     *
+     * This affects how execution and result of the table is constructed:
+     * - "columns" - measures are included in the first dimension (top to bottom).
+     * - "rows" - measures are included in the second dimension (left to right).
+     *
+     * Default Value: "columns"
+     */
+    measureGroupDimension?: MeasureGroupDimensionNext;
+    /**
+     * Whether to display column headers on the top or left.
+     *
+     * Default value: "left"
+     */
+    columnHeadersPosition?: ColumnHeadersPositionNext;
+};
+
 /**
  * Creates width item that will set width for all columns containing values of the provided measure.
  * To prepare width items for columns in tables without measures, pass measureOrId as `null`.