@sisense/sdk-ui 2.16.1 → 2.17.0

package/dist/packages/sdk-ui/src/types.d.ts

@@ -998,6 +998,13 @@ export interface PivotTableStyleOptions {
      * @default false
      */
     alwaysShowResultsPerPage?: boolean;
+    /**
+     * Boolean flag whether to highlight clickable cells with a background color
+     *
+     * @default false
+     * @internal
+     */
+    highlightClickableCells?: boolean;
 }
 /**
  * Common part of IndicatorStyleOptions for all types of indicator
@@ -2171,26 +2178,20 @@ export type DataPoint = {
     seriesValue?: string | number;
     /**
      * A collection of data point entries that represents values for all related `dataOptions`.
-     *
-     * @internal
      */
     entries?: {
+        /** Data point entries for the `category` data options */
         category: DataPointEntry[];
+        /** Data point entries for the `value` data options */
         value: DataPointEntry[];
+        /** Data point entries for the `breakBy` data options */
         breakBy?: DataPointEntry[];
     };
 };
 /**
  * A data point entry that represents a single dimension within a multi-dimensional data point.
- *
- * @internal
  */
 export type DataPointEntry = {
-    /**
-     * The unique identifier of the data point entry.
-     * It represents the path within the `dataOptions` object that identifies the related option.
-     */
-    readonly id: string;
     /** The data option associated with this entry */
     dataOption: Column | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
     /** The attribute associated with this data point entry */
@@ -2198,27 +2199,35 @@ export type DataPointEntry = {
     /** The measure associated with this data point entry */
     measure?: Measure;
     /** The raw value of the data point */
-    value: string | number;
-    /** The formated value of the data point */
+    value?: string | number;
+    /** The formatted value of the data point */
     displayValue?: string;
 };
 /** Data point in a Scatter chart. */
 export type ScatterDataPoint = {
+    /** Value of the x axis */
     x?: string | number;
+    /** Value of the y axis */
     y?: string | number;
+    /** Size of the data point */
     size?: number;
+    /** Value of the break by point */
     breakByPoint?: string;
+    /** Value of the break by color */
     breakByColor?: string;
     /**
      * A collection of data point entries that represents values for all related `dataOptions`.
-     *
-     * @internal
      */
     entries?: {
+        /** Data point entry for the `x` data options */
         x?: DataPointEntry;
+        /** Data point entry for the `y` data options */
         y?: DataPointEntry;
+        /** Data point entry for the `size` data options */
         size?: DataPointEntry;
+        /** Data point entry for the `breakByPoint` data options */
         breakByPoint?: DataPointEntry;
+        /** Data point entry for the `breakByColor` data options */
         breakByColor?: DataPointEntry;
     };
 };
@@ -2242,12 +2251,13 @@ export type BoxplotDataPoint = {
     outlier?: number;
     /**
      * A collection of data point entries that represents values for all related `dataOptions`.
-     *
-     * @internal
      */
     entries?: {
+        /** Data point entries for the `category` data options */
         category: DataPointEntry[];
+        /** Data point entries for the `value` data options */
         value: DataPointEntry[];
+        /** Data point entries for the `outliers` data options */
         outliers: DataPointEntry[];
     };
 };
@@ -2255,13 +2265,15 @@ export type BoxplotDataPoint = {
 export type IndicatorDataPoint = {
     /**
      * A collection of data point entries that represents values for all related `dataOptions`.
-     *
-     * @internal
      */
     entries?: {
+        /** Data point entry for the `value` data options */
         value?: DataPointEntry;
+        /** Data point entry for the `secondary` data options */
         secondary?: DataPointEntry;
+        /** Data point entry for the `min` data options */
         min?: DataPointEntry;
+        /** Data point entry for the `max` data options */
         max?: DataPointEntry;
     };
 };
@@ -2271,11 +2283,11 @@ export type IndicatorDataPoint = {
 export type CalendarHeatmapDataPoint = {
     /**
      * A collection of data point entries that represents values for all related `dataOptions`.
-     *
-     * @internal
      */
     entries?: {
+        /** Data point entry for the `date` data options */
         date: DataPointEntry;
+        /** Data point entry for the `value` data options */
         value?: DataPointEntry;
     };
 };
@@ -2310,12 +2322,13 @@ export type PivotTableDataPoint = {
     isTotalCell: boolean;
     /**
      * A collection of data point entries that represents values for all related `dataOptions`.
-     *
-     * @internal
      */
     entries: {
+        /** Data point entries for the `rows` data options */
         rows?: DataPointEntry[];
+        /** Data point entries for the `columns` data options */
         columns?: DataPointEntry[];
+        /** Data point entries for the `values` data options */
         values?: DataPointEntry[];
     };
 };
@@ -2325,11 +2338,11 @@ export type PivotTableDataPoint = {
 export type AreamapDataPoint = GeoDataElement & {
     /**
      * A collection of data point entries that represents values for all related `dataOptions`.
-     *
-     * @internal
      */
     entries?: {
+        /** Data point entries for the `geo` data options */
         geo: DataPointEntry[];
+        /** Data point entries for the `color` data options */
         color: DataPointEntry[];
     };
 };
@@ -2347,13 +2360,15 @@ export type ScattermapDataPoint = {
     coordinates: Coordinates;
     /**
      * A collection of data point entries that represents values for all related `dataOptions`.
-     *
-     * @internal
      */
     entries?: {
+        /** Data point entries for the `geo` data options */
         geo: DataPointEntry[];
+        /** Data point entry for the `size` data options */
         size?: DataPointEntry;
+        /** Data point entry for the `colorBy` data options */
         colorBy?: DataPointEntry;
+        /** Data point entry for the `details` data options */
         details?: DataPointEntry;
     };
 };

package/dist/packages/sdk-ui/src/widgets/pivot-table-widget.d.ts

@@ -13,11 +13,29 @@ import { PivotTableWidgetProps } from '../props';
  *     rows: [DM.Category.Category],
  *     values: [measureFactory.sum(DM.Commerce.Cost, 'Total Cost')]
  *   }}
+ *   title="Pivot Table Widget Example"
+ *   styleOptions={{
+ *     spaceAround: 'Medium',
+ *     cornerRadius: 'Large',
+ *     shadow: 'Light',
+ *     border: true,
+ *     borderColor: '#e0e0e0',
+ *     backgroundColor: '#ffffff',
+ *     header: {
+ *       hidden: false,
+ *       titleTextColor: '#333333',
+ *       titleAlignment: 'Center',
+ *       dividerLine: true,
+ *       dividerLineColor: '#e0e0e0',
+ *       backgroundColor: '#f5f5f5'
+ *     }
+ *   }}
  * />
  * ```
+ * <img src="media://pivot-widget-example.png" width="800px" />
+ *
  * @param props - Pivot Table Widget properties
  * @returns Widget component representing a pivot table
  * @group Dashboards
- * @beta
  */
 export declare const PivotTableWidget: FunctionComponent<PivotTableWidgetProps>;

package/dist/{types-Clbnx4mQ.cjs → types-Hki4GrUY.cjs}

@@ -1 +1 @@
-"use strict";const a=require("./execute-query-CB4XfUng.cjs");class s extends a.DimensionalElement{constructor(e,r){var i;super((i=e.jaql.title)!==null&&i!==void 0?i:"",r),this.__serializable="JaqlElement",this.expression=e.jaql.dim||e.jaql.formula,this.metadataItem=e,e.jaql.agg?this.aggregation=e.jaql.agg:delete this.aggregation,e.jaql.formula?this.formula=e.jaql.formula:delete this.formula,e.jaql.sort?this.sortType=a.getSortType(e.jaql.sort):delete this.sortType,this.skipValidation=!0}get id(){return this.expression}jaql(e){return e===!0?this.metadataItem.jaql:this.metadataItem}serialize(){const e=super.serialize();return e.metadataItem=this.metadataItem,e.type=this.type,e}}const l={text:a.MetadataTypes.TextAttribute,numeric:a.MetadataTypes.NumericAttribute,datetime:a.MetadataTypes.DateLevel},d=t=>t&&t.__serializable==="JaqlElement";function n(t){var e;return new s(t,(e=l[t.jaql.datatype])!==null&&e!==void 0?e:"numeric")}function o(t){const{jaql:e}=t;if(e.formula)return a.createCalculatedMeasureHelper(e);const r=a.getGranularityFromJaql(e);return"agg"in e&&e.dim&&e.datatype?a.createMeasureHelper({expression:e.dim,dataType:e.datatype,agg:e.agg||"",granularity:r,format:void 0,sort:e.sort,title:e.title,dataSource:e.datasource}):e.dim&&e.datatype?a.createAttributeHelper({expression:e.dim,dataType:e.datatype,granularity:r,sort:e.sort,title:e.title,panel:t.panel,dataSource:e.datasource}):n(t)}const u={jaql:{datasource:{title:"",type:"elasticube"},metadata:[]},queryTitle:"",chartRecommendations:{}},m={model:"",metadata:[],chart:{},queryTitle:""},c=t=>"widgetProps"in t,p=t=>"dashboardOid"in t&&"widgetOid"in t,g=t=>"dashboardProps"in t,y=t=>"dashboardOid"in t;exports.EMPTY_EXPANDED_QUERY_MODEL=u;exports.EMPTY_SIMPLE_QUERY_MODEL=m;exports.JaqlElement=s;exports.createDimensionalElementFromMetadataItem=o;exports.isByIdDashboardCodeParams=y;exports.isByIdWidgetCodeParams=p;exports.isClientSideDashboardCodeParams=g;exports.isClientSideWidgetCodeParams=c;exports.isJaqlElement=d;
+"use strict";const a=require("./execute-query-CdhSHTTA.cjs");class s extends a.DimensionalElement{constructor(e,r){var i;super((i=e.jaql.title)!==null&&i!==void 0?i:"",r),this.__serializable="JaqlElement",this.expression=e.jaql.dim||e.jaql.formula,this.metadataItem=e,e.jaql.agg?this.aggregation=e.jaql.agg:delete this.aggregation,e.jaql.formula?this.formula=e.jaql.formula:delete this.formula,e.jaql.sort?this.sortType=a.getSortType(e.jaql.sort):delete this.sortType,this.skipValidation=!0}get id(){return this.expression}jaql(e){return e===!0?this.metadataItem.jaql:this.metadataItem}serialize(){const e=super.serialize();return e.metadataItem=this.metadataItem,e.type=this.type,e}}const l={text:a.MetadataTypes.TextAttribute,numeric:a.MetadataTypes.NumericAttribute,datetime:a.MetadataTypes.DateLevel},d=t=>t&&t.__serializable==="JaqlElement";function n(t){var e;return new s(t,(e=l[t.jaql.datatype])!==null&&e!==void 0?e:"numeric")}function o(t){const{jaql:e}=t;if(e.formula)return a.createCalculatedMeasureHelper(e);const r=a.getGranularityFromJaql(e);return"agg"in e&&e.dim&&e.datatype?a.createMeasureHelper({expression:e.dim,dataType:e.datatype,agg:e.agg||"",granularity:r,format:void 0,sort:e.sort,title:e.title,dataSource:e.datasource}):e.dim&&e.datatype?a.createAttributeHelper({expression:e.dim,dataType:e.datatype,granularity:r,sort:e.sort,title:e.title,panel:t.panel,dataSource:e.datasource}):n(t)}const u={jaql:{datasource:{title:"",type:"elasticube"},metadata:[]},queryTitle:"",chartRecommendations:{}},m={model:"",metadata:[],chart:{},queryTitle:""},c=t=>"widgetProps"in t,p=t=>"dashboardOid"in t&&"widgetOid"in t,g=t=>"dashboardProps"in t,y=t=>"dashboardOid"in t;exports.EMPTY_EXPANDED_QUERY_MODEL=u;exports.EMPTY_SIMPLE_QUERY_MODEL=m;exports.JaqlElement=s;exports.createDimensionalElementFromMetadataItem=o;exports.isByIdDashboardCodeParams=y;exports.isByIdWidgetCodeParams=p;exports.isClientSideDashboardCodeParams=g;exports.isClientSideWidgetCodeParams=c;exports.isJaqlElement=d;

package/dist/{types-D1mqt0Mg.js → types-ofTjqFFK.js}

@@ -1,4 +1,4 @@
-import { f as i, g as l, h as n, i as o, D as d, k as u, M as s } from "./execute-query-CFK2R_1S.js";
+import { f as i, g as l, h as n, i as o, D as d, k as u, M as s } from "./execute-query-l7jejslh.js";
 class m extends d {
   constructor(e, t) {
     var r;