@gooddata/sdk-ui-pivot 11.52.0-alpha.5 → 11.52.0-alpha.7

package/esm/CorePivotTable.d.ts

@@ -1,8 +1,6 @@
-import { Component } from "react";
 import { type ICorePivotTableProps } from "./publicTypes.js";
-import { type ICorePivotTableState } from "./tableState.js";
 /**
- * This class implements pivot table using the community version of ag-grid.
+ * This component implements pivot table using the community version of ag-grid.
  *
  * Bear in mind that this is not a typical, standard React component implementation; the main reason
  * behind that is that while ag-grid comes with a React component the ag-grid itself is not a React component
@@ -12,10 +10,14 @@ import { type ICorePivotTableState } from "./tableState.js";
  * Instead of looking at this implementation as a typical React component, look at it like a adapter between
  * React and ag-grid which is used to render data obtained using GD executions.
  *
- * The code in this class is built to reflect the adapter nature of the integration. The responsibility of this
+ * The code in this component is built to reflect the adapter nature of the integration. The responsibility of this
  * component is to correctly handle the component lifecycle and orchestrate integration of React and ag-grid, React
  * and GoodData, React and GoodData and ag-grid.
  *
+ * Note on the implementation: because the table is driven imperatively, all the non-react state lives in refs and
+ * all the functions that the table hands over to its sub-components are stable for the entire lifetime of the
+ * component; they read the current props, state and internal state through refs.
+ *
  * Lifecycle
  * ---------
  *
@@ -42,7 +44,7 @@ import { type ICorePivotTableState } from "./tableState.js";
  * prepared execution, add the extra settings and re-drive the execution. Once done, it will update the internal
  * state and ping ag-grid API to re-render the table.
  *
- * In case the client changes props (say modifying the prepared execution) the componentDidUpdate will determine
+ * In case the client changes props (say modifying the prepared execution) the update effect will determine
  * whether the full reinitialization is in order. If so the entire existing ag-grid and all our internal state
  * is thrown out and table is initialized from scratch.
  *
@@ -108,147 +110,7 @@ import { type ICorePivotTableState } from "./tableState.js";
  *
  * @internal
  */
-export declare class CorePivotTableAgImpl extends Component<ICorePivotTableProps, ICorePivotTableState> {
-    static defaultProps: Pick<ICorePivotTableProps, "ErrorComponent" | "LoadingComponent" | "afterRender" | "config" | "drillableItems" | "locale" | "onColumnResized" | "onDataView" | "onDrill" | "onError" | "onExportReady" | "onLoadingChanged" | "pageSize" | "pushData">;
-    private readonly errorMap;
-    private containerRef;
-    private pivotTableId;
-    private internal;
-    private boundAgGridCallbacks;
-    private gridEventHandlers;
-    private dataRenderHandlers;
-    private scrollEventHandlers;
-    private resizeEventHandlers;
-    private sortingEventHandlers;
-    private aggregationEventHandlers;
-    private dataLoadingEventHandlers;
-    private configAccessors;
-    private configDelegates;
-    private stickyRowManager;
-    private heightCalculationManager;
-    private executionAbortManager;
-    private componentUpdateAnalyzer;
-    constructor(props: ICorePivotTableProps);
-    /**
-     * Starts initialization of table that will show results of the provided prepared execution. If there is
-     * already an initialization in progress for the table, this will abandon the previous initialization
-     * and start a new one.
-     *
-     * During the initialization the code drives the execution and obtains the first page of data. Once that
-     * is done, the initializer will construct the {@link TableFacade} with all the essential non-react
-     * table & data state in it.
-     *
-     * After the initializer completes this, the table facade and the table itself is ready to render the
-     * ag-grid component.
-     *
-     * @param execution - prepared execution to drive
-     */
-    private initialize;
-    /**
-     * Completely re-initializes the table in order to show data for the provided prepared execution. At this point
-     * code has determined that the table layout for the other prepared execution differs from what is currently
-     * shown and the only reasonable thing to do is to throw everything away and start from scratch.
-     *
-     * This will reset all React state and non-react state and start table initialization process.
-     */
-    private reinitialize;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    componentDidUpdate(prevProps: ICorePivotTableProps): void;
-    private stopEventWhenResizeHeader;
-    private setContainerRef;
-    private renderLoading;
-    render(): import("react/jsx-runtime").JSX.Element;
-    private initializeEventHandlers;
-    private onGridReady;
-    private onFirstDataRendered;
-    private onModelUpdated;
-    private onGridColumnsChanged;
-    private onGridSizeChanged;
-    private onGridColumnResized;
-    private onSortChanged;
-    private onPinnedRowDataChanged;
-    private onBodyScroll;
-    private onContainerMouseDown;
-    private onPageLoaded;
-    /**
-     * This will be called when user changes sorts or adds totals. This means complete re-execution with
-     * new sorts or totals. Loading indicators will be shown instead of all rendered rows thanks to the
-     * LoadingRenderer used in all cells of the left-most column.
-     *
-     * The table must take care to remove the sticky (top-pinned) row - it is treated differently by
-     * ag-grid and will be literally sticking there on its own with the loading indicators.
-     *
-     * Once transformation finishes - indicated by call to onPageLoaded, table can re-instance the sticky row.
-     *
-     * @param newExecution - the new execution which is being run and will be used to populate the table
-     */
-    private onExecutionTransformed;
-    private onMenuAggregationClick;
-    private onLoadingChanged;
-    private onError;
-    private growToFit;
-    private autoresizeColumns;
-    private shouldAutoResizeColumns;
-    private startWatchingTableRendered;
-    private stopWatchingTableRendered;
-    private updateStickyRow;
-    private updateStickyRowContent;
-    private updateDesiredHeight;
-    private initializeConfigAccessors;
-    private getLastSortedColId;
-    private setLastSortedColId;
-    private getColumnTotals;
-    private getRowTotals;
-    private getExecutionDefinition;
-    private getGroupRows;
-    private getMeasureGroupDimension;
-    private getColumnHeadersPosition;
-    private getMenuConfig;
-    private getDefaultWidth;
-    private isColumnAutoresizeEnabled;
-    private isGrowToFitEnabled;
-    private getColumnWidths;
-    private hasColumnWidths;
-    private getDefaultWidthFromProps;
-    /**
-     * All pushData calls done by the table must go through this guard.
-     *
-     * TODO: The guard should ensure a 'disconnect' between push data handling and the calling function processing.
-     *  When the pushData is handled by the application, it MAY (and in our case it DOES) trigger processing that
-     *  lands back in the table. This opens additional set of invariants to check / be prepared for in order to
-     *  optimize the renders and re-renders.
-     */
-    private pushDataGuard;
-    /**
-     * Wraps the provided callback function with a guard that checks whether the current table state is the same
-     * as the state snapshot at the time of callback creation. If the state differs, the wrapped function WILL NOT
-     * be called.
-     *
-     * @param callback - function to wrap with state guard
-     */
-    private stateBoundCallback;
-    /**
-     * All callback functions that the table passes to ag-grid must be bound to the current internal state of the table. The
-     * callback functions MUST be noop if the internal state at the time of call is different from the internal state
-     * at the time of creation.
-     *
-     * This is essential to prevent errors stemming for racy behavior triggered by ag-grid. ag-grid often triggers
-     * event callbacks using setTimeout(). It can happen, that once the event is actually processed the ag-grid table
-     * which caused it is unmounted. Doing anything with the unmounted table's gridApi leads to errors.
-     *
-     * Without this, table may trigger ag-grid errors such as this:
-     *
-     * https://github.com/ag-grid/ag-grid/issues/3457
-     *
-     * or this:
-     *
-     * https://github.com/ag-grid/ag-grid/issues/3334
-     */
-    private createBoundAgGridCallbacks;
-    private getTableMethods;
-    private getResizingConfig;
-}
+export declare function CorePivotTableAgImpl(props: ICorePivotTableProps): import("react/jsx-runtime").JSX.Element;
 /**
  * @internal
  */

package/esm/CorePivotTable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CorePivotTable.d.ts","sourceRoot":"","sources":["../src/CorePivotTable.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAsB,SAAS,EAAsC,MAAM,OAAO,CAAC;AA8D1F,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,KAAK,oBAAoB,EAAsB,MAAM,iBAAiB,CAAC;AAQhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0GG;AACH,qBAAa,oBAAqB,SAAQ,SAAS,CAAC,oBAAoB,EAAE,oBAAoB,CAAC;IAC3F,OAAc,YAAY,yPAA6B;IAEvD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAoB;IAC7C,OAAO,CAAC,YAAY,CAA6B;IACjD,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,QAAQ,CAAqB;IACrC,OAAO,CAAC,oBAAoB,CAAuB;IAGnD,OAAO,CAAC,iBAAiB,CAAqB;IAC9C,OAAO,CAAC,kBAAkB,CAAsB;IAChD,OAAO,CAAC,mBAAmB,CAAuB;IAClD,OAAO,CAAC,mBAAmB,CAAuB;IAClD,OAAO,CAAC,oBAAoB,CAAwB;IACpD,OAAO,CAAC,wBAAwB,CAA4B;IAC5D,OAAO,CAAC,wBAAwB,CAA4B;IAG5D,OAAO,CAAC,eAAe,CAAwB;IAC/C,OAAO,CAAC,eAAe,CAAmB;IAG1C,OAAO,CAAC,gBAAgB,CAAoB;IAG5C,OAAO,CAAC,wBAAwB,CAA4B;IAG5D,OAAO,CAAC,qBAAqB,CAAwB;IAGrD,OAAO,CAAC,uBAAuB,CAA2B;IAE1D,YAAY,KAAK,EAAE,oBAAoB,EA6BtC;IAMD;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,UAAU,CAwBhB;IAEF;;;;;;OAMG;IACH,OAAO,CAAC,YAAY,CAmBlB;IAEc,iBAAiB,IAAI,IAAI,CAExC;IAEe,oBAAoB,IAAI,IAAI,CAQ3C;IAEe,kBAAkB,CAAC,SAAS,EAAE,oBAAoB,GAAG,IAAI,CA2DxE;IAED,OAAO,CAAC,yBAAyB;IAajC,OAAO,CAAC,eAAe,CAMrB;IAEF,OAAO,CAAC,aAAa;IAKL,MAAM,4CAkErB;IAMD,OAAO,CAAC,uBAAuB,CA0D7B;IAMF,OAAO,CAAC,WAAW,CAEjB;IAEF,OAAO,CAAC,mBAAmB,CAEzB;IAEF,OAAO,CAAC,cAAc,CAEpB;IAEF,OAAO,CAAC,oBAAoB,CAE1B;IAEF,OAAO,CAAC,iBAAiB,CAEvB;IAEF,OAAO,CAAC,mBAAmB,CAEzB;IAEF,OAAO,CAAC,aAAa,CAEnB;IAEF,OAAO,CAAC,sBAAsB,CAE5B;IAEF,OAAO,CAAC,YAAY,CAElB;IAEF,OAAO,CAAC,oBAAoB,CAE1B;IAEF,OAAO,CAAC,YAAY,CAElB;IAEF;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,sBAAsB,CAe5B;IAEF,OAAO,CAAC,sBAAsB,CAE5B;IAEF,OAAO,CAAC,gBAAgB,CAEtB;IAEF,OAAO,CAAC,OAAO,CAEb;IAMF,OAAO,CAAC,SAAS,CAcf;IAEF,OAAO,CAAC,iBAAiB,CAiBvB;IAEF,OAAO,CAAC,uBAAuB,CAE7B;IAEF,OAAO,CAAC,0BAA0B,CAqBhC;IAEF,OAAO,CAAC,yBAAyB,CAG/B;IAMF,OAAO,CAAC,eAAe,CAErB;IAEF,OAAO,CAAC,sBAAsB,CAE5B;IAMF,OAAO,CAAC,mBAAmB,CAEzB;IAMF,OAAO,CAAC,yBAAyB,CAiC/B;IAMF,OAAO,CAAC,kBAAkB,CAExB;IAEF,OAAO,CAAC,kBAAkB,CAExB;IAGF,OAAO,CAAC,eAAe,CAAgD;IACvE,OAAO,CAAC,YAAY,CAA6C;IACjE,OAAO,CAAC,sBAAsB,CAAuD;IACrF,OAAO,CAAC,YAAY,CAA6C;IACjE,OAAO,CAAC,wBAAwB,CAAyD;IACzF,OAAO,CAAC,wBAAwB,CAAyD;IACzF,OAAO,CAAC,aAAa,CAA8C;IACnE,OAAO,CAAC,eAAe,CAAgD;IACvE,OAAO,CAAC,yBAAyB,CAA0D;IAC3F,OAAO,CAAC,kBAAkB,CACyB;IACnD,OAAO,CAAC,eAAe,CAAgF;IACvG,OAAO,CAAC,eAAe,CAAgD;IACvE,OAAO,CAAC,wBAAwB,CACyB;IAEzD;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa,CASnB;IAEF;;;;;;OAMG;IAEH,OAAO,CAAC,kBAAkB,CAExB;IAEF;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,0BAA0B,CAiBhC;IAEF,OAAO,CAAC,eAAe,CAuBrB;IAEF,OAAO,CAAC,iBAAiB,CAiBvB;CACL;AAID;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,oBAAoB,2CAQzD"}
+{"version":3,"file":"CorePivotTable.d.ts","sourceRoot":"","sources":["../src/CorePivotTable.tsx"],"names":[],"mappings":"AAyEA,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AA2E7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8GG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,oBAAoB,2CA29B/D;AAID;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,oBAAoB,2CAQzD"}