@gooddata/sdk-ui 10.35.0-alpha.39 → 10.35.0-alpha.40

package/esm/sdk-ui.d.ts

@@ -70,6 +70,7 @@ import { IWorkspaceSettings } from '@gooddata/sdk-backend-spi';
 import { MessageDescriptor } from 'react-intl';
 import { ObjRef } from '@gooddata/sdk-model';
 import { default as React_2 } from 'react';
+import { TotalType } from '@gooddata/sdk-model';
 import { ValueOrUpdateCallback } from '@gooddata/sdk-backend-base';
 import { WithIntlProps } from 'react-intl';
 import { WrappedComponentProps } from 'react-intl';
@@ -1537,6 +1538,11 @@ export declare interface IDataAccessMethods {
      * @returns collection of data slices that are available in the data view
      */
     slices(): IDataSliceCollection;
+    /**
+     * @returns data as a table data.
+     * @alpha
+     */
+    asTable(): ITableData;
 }
 
 /**
@@ -3096,6 +3102,306 @@ export declare function isUnauthorized(obj: unknown): obj is UnauthorizedSdkErro
  */
 export declare function isUnknownSdkError(obj: unknown): obj is UnexpectedSdkError;
 
+/**
+ * @alpha
+ */
+export declare interface ITableAttributeColumnDefinition {
+    type: "attribute";
+    columnIndex: number;
+    rowHeaderIndex: number;
+    attributeDescriptor: IAttributeDescriptor;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableAttributeHeaderValue {
+    type: "attributeHeader";
+    formattedValue: string | null;
+    value: IResultAttributeHeader;
+    rowIndex: number;
+    columnIndex: number;
+    rowDefinition: ITableRowDefinition;
+    columnDefinition: ITableAttributeColumnDefinition;
+}
+
+/**
+ * @alpha
+ */
+export declare type ITableColumnDefinition = ITableAttributeColumnDefinition | ITableValueColumnDefinition | ITableMeasureGroupHeaderColumnDefinition | ITableMeasureGroupValueColumnDefinition | ITableSubtotalColumnDefinition | ITableGrandTotalColumnDefinition;
+
+/**
+ * @alpha
+ */
+export declare type ITableData = {
+    columnDefinitions: ITableColumnDefinition[];
+    rowDefinitions: ITableRowDefinition[];
+    data: ITableDataValue[][];
+    isPivoted: boolean;
+    isTransposed: boolean;
+};
+
+/**
+ * @alpha
+ */
+export declare interface ITableDataAttributeScope {
+    type: "attributeScope";
+    descriptor: IAttributeDescriptor;
+    header: IResultAttributeHeader;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableDataAttributeTotalScope {
+    type: "attributeTotalScope";
+    descriptor: IAttributeDescriptor;
+    header: IResultTotalHeader;
+}
+
+/**
+ * @alpha
+ */
+export declare type ITableDataHeaderScope = ITableDataAttributeScope | ITableDataAttributeTotalScope | ITableDataMeasureScope | ITableDataMeasureTotalScope | ITableDataMeasureGroupScope;
+
+/**
+ * @alpha
+ */
+export declare interface ITableDataMeasureGroupScope {
+    type: "measureGroupScope";
+    descriptor: IMeasureGroupDescriptor;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableDataMeasureScope {
+    type: "measureScope";
+    descriptor: IMeasureDescriptor;
+    header: IResultMeasureHeader;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableDataMeasureTotalScope {
+    type: "measureTotalScope";
+    descriptor: IMeasureDescriptor;
+    header: IResultTotalHeader;
+}
+
+/**
+ * @alpha
+ */
+export declare type ITableDataValue = ITableAttributeHeaderValue | ITableMeasureHeaderValue | ITableTotalHeaderValue | ITableMeasureValue | ITableSubtotalMeasureValue | ITableGrandTotalHeaderValue | ITableGrandTotalMeasureValue | ITableGrandTotalSubtotalMeasureValue | ITableOverallTotalMeasureValue;
+
+/**
+ * @alpha
+ */
+export declare interface ITableGrandTotalColumnDefinition {
+    type: "grandTotal";
+    columnIndex: number;
+    columnHeaderIndex: number;
+    columnScope: ITableDataHeaderScope[];
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableGrandTotalHeaderValue {
+    type: "grandTotalHeader";
+    formattedValue: string | null;
+    rowIndex: number;
+    columnIndex: number;
+    rowDefinition: ITableRowDefinition;
+    columnDefinition: ITableColumnDefinition;
+    grandTotalInfo?: {
+        type: TotalType;
+        measure: IMeasureDescriptor;
+        attribute: IAttributeDescriptor;
+    };
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableGrandTotalMeasureValue {
+    type: "grandTotalValue";
+    formattedValue: string | null;
+    value: DataValue;
+    rowIndex: number;
+    columnIndex: number;
+    rowDefinition: ITableRowDefinition;
+    columnDefinition: ITableColumnDefinition;
+    grandTotalInfo?: {
+        type: TotalType;
+        measure: IMeasureDescriptor;
+        attribute: IAttributeDescriptor;
+    };
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableGrandTotalRowDefinition {
+    type: "grandTotal";
+    rowIndex: number;
+    attributeDescriptor: IAttributeDescriptor;
+    measureDescriptors: IMeasureDescriptor[];
+    totalType: TotalType;
+    rowGrandTotalIndex: number;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableGrandTotalSubtotalMeasureValue {
+    type: "grandTotalSubtotalValue";
+    formattedValue: string | null;
+    value: DataValue;
+    rowIndex: number;
+    columnIndex: number;
+    rowDefinition: ITableRowDefinition;
+    columnDefinition: ITableColumnDefinition;
+    grandTotalInfo?: {
+        type: TotalType;
+        measure: IMeasureDescriptor;
+        attribute: IAttributeDescriptor;
+    };
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableMeasureGroupHeaderColumnDefinition {
+    type: "measureGroupHeader";
+    columnIndex: number;
+    measureGroupDescriptor: IMeasureGroupDescriptor;
+    attributeDescriptors: IAttributeDescriptor[];
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableMeasureGroupValueColumnDefinition {
+    type: "measureGroupValue";
+    columnIndex: number;
+    measureGroupDescriptor: IMeasureGroupDescriptor;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableMeasureHeaderValue {
+    type: "measureHeader";
+    formattedValue: string | null;
+    value: IResultMeasureHeader;
+    rowIndex: number;
+    columnIndex: number;
+    rowDefinition: ITableRowDefinition;
+    columnDefinition: ITableColumnDefinition;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableMeasureValue {
+    type: "value";
+    formattedValue: string | null;
+    value: DataValue;
+    rowIndex: number;
+    columnIndex: number;
+    rowDefinition: ITableValueRowDefinition | ITableSubtotalRowDefinition;
+    columnDefinition: ITableValueColumnDefinition | ITableMeasureGroupValueColumnDefinition;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableOverallTotalMeasureValue {
+    type: "overallTotalValue";
+    formattedValue: string | null;
+    value: DataValue;
+    rowIndex: number;
+    columnIndex: number;
+    rowDefinition: ITableGrandTotalRowDefinition;
+    columnDefinition: ITableGrandTotalColumnDefinition;
+    grandTotalInfo?: {
+        type: TotalType;
+        measure: IMeasureDescriptor;
+        attribute: IAttributeDescriptor;
+    };
+}
+
+/**
+ * @alpha
+ */
+export declare type ITableRowDefinition = ITableValueRowDefinition | ITableSubtotalRowDefinition | ITableGrandTotalRowDefinition;
+
+/**
+ * @alpha
+ */
+export declare interface ITableSubtotalColumnDefinition {
+    type: "subtotal";
+    columnIndex: number;
+    columnHeaderIndex: number;
+    columnScope: ITableDataHeaderScope[];
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableSubtotalMeasureValue {
+    type: "subtotalValue";
+    formattedValue: string | null;
+    value: DataValue;
+    rowIndex: number;
+    columnIndex: number;
+    rowDefinition: ITableValueRowDefinition | ITableSubtotalRowDefinition;
+    columnDefinition: ITableValueColumnDefinition | ITableSubtotalColumnDefinition;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableSubtotalRowDefinition {
+    type: "subtotal";
+    rowIndex: number;
+    rowScope: ITableDataHeaderScope[];
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableTotalHeaderValue {
+    type: "totalHeader";
+    formattedValue: string | null;
+    value: IResultTotalHeader;
+    rowIndex: number;
+    columnIndex: number;
+    rowDefinition: ITableRowDefinition;
+    columnDefinition: ITableColumnDefinition;
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableValueColumnDefinition {
+    type: "value";
+    columnIndex: number;
+    columnHeaderIndex: number;
+    columnScope: ITableDataHeaderScope[];
+}
+
+/**
+ * @alpha
+ */
+export declare interface ITableValueRowDefinition {
+    type: "value";
+    rowIndex: number;
+    rowScope: ITableDataHeaderScope[];
+}
+
 /**
  * @internal
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-ui",
-  "version": "10.35.0-alpha.39",
+  "version": "10.35.0-alpha.40",
   "description": "GoodData.UI SDK - Core",
   "repository": {
     "type": "git",
@@ -43,9 +43,9 @@
     "tslib": "^2.5.0",
     "uuid": "^8.3.2",
     "react-fast-compare": "^3.2.0",
-    "@gooddata/sdk-backend-spi": "10.35.0-alpha.39",
-    "@gooddata/sdk-model": "10.35.0-alpha.39",
-    "@gooddata/util": "10.35.0-alpha.39"
+    "@gooddata/sdk-backend-spi": "10.35.0-alpha.40",
+    "@gooddata/util": "10.35.0-alpha.40",
+    "@gooddata/sdk-model": "10.35.0-alpha.40"
   },
   "peerDependencies": {
     "react": "^16.10.0 || ^17.0.0 || ^18.0.0",
@@ -97,10 +97,10 @@
     "typescript": "5.8.3",
     "vitest": "3.2.4",
     "vitest-dom": "0.1.1",
-    "@gooddata/i18n-toolkit": "10.35.0-alpha.39",
-    "@gooddata/reference-workspace": "10.35.0-alpha.39",
-    "@gooddata/sdk-backend-base": "10.35.0-alpha.39",
-    "@gooddata/sdk-backend-mockingbird": "10.35.0-alpha.39"
+    "@gooddata/reference-workspace": "10.35.0-alpha.40",
+    "@gooddata/i18n-toolkit": "10.35.0-alpha.40",
+    "@gooddata/sdk-backend-base": "10.35.0-alpha.40",
+    "@gooddata/sdk-backend-mockingbird": "10.35.0-alpha.40"
   },
   "scripts": {
     "clean": "rm -rf ci dist esm coverage *.log tsconfig.tsbuildinfo",