Release v1.19.0

sisense · Sep 18, 2024 · 7afd584 · 7afd584
1 parent 38deaac
commit 7afd584
Show file tree

Hide file tree

Showing 194 changed files with 8,915 additions and 2,576 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,18 @@
 # Changelog
 
+## [1.19.0] - 2024-09-17
+
+### Added
+- Support loading of fonts from Fusion
+- Support dashboard rendering of text widgets and chart plugins
+
+### Changed
+- Fix missing spaces in headings for `MemberFilterTile`, `Table`, and `PivotTable`
+- Extend `DataPoint` types with metadata
+- Fix rendering of charts without values to match Fusion
+- Fix pivot table error due to invalid datetime formatting
+- Improve type guards for narrowing filter types
+
 ## [1.18.1] - 2024-09-04
 
 ### Added
@@ -11,7 +24,6 @@
 ### Added
 
 - Add auto zoom feature to `DashboardWidget`
-- Support forecast and trend in Fusion widgets
 
 ### Changed
 

diff --git a/docs-md/sdk/CHANGELOG.md b/docs-md/sdk/CHANGELOG.md
@@ -1,5 +1,18 @@
 # Changelog
 
+## [1.19.0] - 2024-09-17
+
+### Added
+- Support loading of fonts from Fusion
+- Support dashboard rendering of text widgets and chart plugins
+
+### Changed
+- Fix missing spaces in headings for `MemberFilterTile`, `Table`, and `PivotTable`
+- Extend `DataPoint` types with metadata
+- Fix rendering of charts without values to match Fusion
+- Fix pivot table error due to invalid datetime formatting
+- Improve type guards for narrowing filter types
+
 ## [1.18.1] - 2024-09-04
 
 ### Added
@@ -11,7 +24,6 @@
 ### Added
 
 - Add auto zoom feature to `DashboardWidget`
-- Support forecast and trend in Fusion widgets
 
 ### Changed
 

diff --git a/docs-md/sdk/guides/charts/guide-external-charts.md b/docs-md/sdk/guides/charts/guide-external-charts.md
@@ -44,7 +44,7 @@ In this snippet, we’re querying the Sample ECommerce model to get total cost a
 
 ```ts
 import * as DM from '../../sample-ecommerce';
-import { measures } from '@sisense/sdk-data';
+import { measureFactory } from '@sisense/sdk-data';
 import { QueryService } from '@sisense/sdk-ui-angular';
 
 //...
@@ -56,8 +56,8 @@ async ngOnInit(): Promise<void> {
     dataSource: DM.DataSource,
     dimensions: [DM.Commerce.AgeRange],
     measures: [
-      measures.sum(DM.Commerce.Cost, 'Total Cost'),
-      measures.sum(DM.Commerce.Revenue, 'Total Revenue'),
+      measureFactory.sum(DM.Commerce.Cost, 'Total Cost'),
+      measureFactory.sum(DM.Commerce.Revenue, 'Total Revenue'),
     ],
   });
   //..
@@ -206,7 +206,7 @@ When we put the steps together, the code for populating our 3rd party chart with
 ```ts
 import { useExecuteQuery } from '@sisense/sdk-ui';
 import * as DM from '../sample-ecommerce';
-import { measures } from '@sisense/sdk-data';
+import { measureFactory } from '@sisense/sdk-data';
 
 import Plot from 'react-plotly.js';
 
@@ -215,7 +215,7 @@ function MyPlotlyChart() {
   const { data, isLoading, isError } = useExecuteQuery({
     dataSource: DM.DataSource,
     dimensions: [DM.Commerce.AgeRange],
-    measures: [measures.sum(DM.Commerce.Cost, 'Total Cost'), measures.sum(DM.Commerce.Revenue, 'Total Revenue')],
+    measures: [measureFactory.sum(DM.Commerce.Cost, 'Total Cost'), measureFactory.sum(DM.Commerce.Revenue, 'Total Revenue')],
   });
 
   if (isLoading) {
@@ -273,7 +273,7 @@ export default MyPlotlyChart;
 ```ts
 import { Component } from '@angular/core';
 import * as DM from '../../sample-ecommerce';
-import { measures } from '@sisense/sdk-data';
+import { measureFactory } from '@sisense/sdk-data';
 import { QueryService } from '@sisense/sdk-ui-angular';
 
 import { PlotData } from 'plotly.js-dist-min';
@@ -293,8 +293,8 @@ export class AnalyticsComponent {
       dataSource: DM.DataSource,
       dimensions: [DM.Commerce.AgeRange],
       measures: [
-        measures.sum(DM.Commerce.Cost, 'Total Cost'),
-        measures.sum(DM.Commerce.Revenue, 'Total Revenue'),
+        measureFactory.sum(DM.Commerce.Cost, 'Total Cost'),
+        measureFactory.sum(DM.Commerce.Revenue, 'Total Revenue'),
       ],
     });
 

diff --git a/docs-md/sdk/guides/migration-guide-1.0.0.md b/docs-md/sdk/guides/migration-guide-1.0.0.md
@@ -207,8 +207,8 @@ AFTER
 <ExecuteQuery
   dataSource={DM.DataSource}
   dimensions={[DM.Commerce.AgeRange]}
-  measures={[measures.sum(DM.Commerce.Revenue)]}
-  filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
+  measures={[measureFactory.sum(DM.Commerce.Revenue)]}
+  filters={[filterFactory.greaterThan(DM.Commerce.Revenue, 1000)]}
 >
   {
     ( { data, isLoading, isError } ) => {

diff --git a/.../sdk-data/factories/namespace.filterFactory/functions/function.bottomRanking.md b/.../sdk-data/factories/namespace.filterFactory/functions/function.bottomRanking.md
@@ -31,7 +31,7 @@ Filter for age ranges with the bottom 3 lowest total revenue in the Sample EComm
 ```ts
 filterFactory.bottomRanking(
   DM.Commerce.AgeRange,
-  measures.sum(DM.Commerce.Revenue),
+  measureFactory.sum(DM.Commerce.Revenue),
   3
 )
 ```
diff --git a/...sdk-data/factories/namespace.filterFactory/functions/function.measureBetween.md b/...sdk-data/factories/namespace.filterFactory/functions/function.measureBetween.md
@@ -31,7 +31,7 @@ Filter for categories that have an average revenue greater than or equal to 50 a
 or equal to 100 in the Sample ECommerce data model.
 ```ts
 filterFactory.measureBetween(
-  measures.average(DM.Commerce.Revenue),
+  measureFactory.average(DM.Commerce.Revenue),
   50,
   100
 )

diff --git a/.../factories/namespace.filterFactory/functions/function.measureBetweenNotEqual.md b/.../factories/namespace.filterFactory/functions/function.measureBetweenNotEqual.md
@@ -31,7 +31,7 @@ Filter for categories that have an average revenue greater than 50 and less than
 100 in the Sample ECommerce data model.
 ```ts
 filterFactory.measureBetweenNotEqual(
-  measures.average(DM.Commerce.Revenue),
+  measureFactory.average(DM.Commerce.Revenue),
   50,
   100
 )

diff --git a/.../sdk-data/factories/namespace.filterFactory/functions/function.measureEquals.md b/.../sdk-data/factories/namespace.filterFactory/functions/function.measureEquals.md
@@ -26,7 +26,7 @@ A filter instance
 Filter for categories that have an average revenue equal 50 in the Sample ECommerce data model.
 ```ts
 filterFactory.measureEquals(
-  measures.average(DM.Commerce.Revenue),
+  measureFactory.average(DM.Commerce.Revenue),
   50
 )
 ```
diff --git a/...data/factories/namespace.filterFactory/functions/function.measureGreaterThan.md b/...data/factories/namespace.filterFactory/functions/function.measureGreaterThan.md
@@ -27,7 +27,7 @@ Filter for categories that have an average revenue greater than
 to 50 in the Sample ECommerce data model.
 ```ts
 filterFactory.measureGreaterThan(
-  measures.average(DM.Commerce.Revenue),
+  measureFactory.average(DM.Commerce.Revenue),
   50
 )
 ```
diff --git a/...ctories/namespace.filterFactory/functions/function.measureGreaterThanOrEqual.md b/...ctories/namespace.filterFactory/functions/function.measureGreaterThanOrEqual.md
@@ -27,7 +27,7 @@ Filter for categories that have an average revenue greater than
 or equal to 50 in the Sample ECommerce data model.
 ```ts
 filterFactory.measureGreaterThanOrEqual(
-  measures.average(DM.Commerce.Revenue),
+  measureFactory.average(DM.Commerce.Revenue),
   50
 )
 ```
diff --git a/...dk-data/factories/namespace.filterFactory/functions/function.measureLessThan.md b/...dk-data/factories/namespace.filterFactory/functions/function.measureLessThan.md
@@ -26,7 +26,7 @@ A filter instance
 Filter for categories that have an average revenue less than 100 in the Sample ECommerce data model.
 ```ts
 filterFactory.measureLessThan(
-  measures.average(DM.Commerce.Revenue),
+  measureFactory.average(DM.Commerce.Revenue),
   100
 )
 ```
diff --git a/.../factories/namespace.filterFactory/functions/function.measureLessThanOrEqual.md b/.../factories/namespace.filterFactory/functions/function.measureLessThanOrEqual.md
@@ -27,7 +27,7 @@ Filter for categories that have an average revenue less than
 or equal to 100 in the Sample ECommerce data model.
 ```ts
 filterFactory.measureLessThanOrEqual(
-  measures.average(DM.Commerce.Revenue),
+  measureFactory.average(DM.Commerce.Revenue),
   100
 )
 ```
diff --git a/...les/sdk-data/factories/namespace.filterFactory/functions/function.topRanking.md b/...les/sdk-data/factories/namespace.filterFactory/functions/function.topRanking.md
@@ -31,7 +31,7 @@ Filter for age ranges with the top 3 highest total revenue in the Sample ECommer
 ```ts
 filterFactory.topRanking(
   DM.Commerce.AgeRange,
-  measures.sum(DM.Commerce.Revenue),
+  measureFactory.sum(DM.Commerce.Revenue),
   3
 )
 ```
diff --git a/...sdk-data/factories/namespace.measureFactory/functions/function.measuredValue.md b/...sdk-data/factories/namespace.measureFactory/functions/function.measuredValue.md
@@ -41,7 +41,7 @@ where the cost is greater than 100. Additional filtering on the cost will not af
 ```ts
 measureFactory.measuredValue(
   measureFactory.sum(DM.Commerce.Cost),
-  [filters.greaterThan(DM.Commerce.Cost, 100)],
+  [filterFactory.greaterThan(DM.Commerce.Cost, 100)],
   'Cost Greater Than 100'
 ),
 ```
diff --git a/docs-md/sdk/modules/sdk-data/interfaces/interface.Filter.md b/docs-md/sdk/modules/sdk-data/interfaces/interface.Filter.md
@@ -16,6 +16,14 @@ Attribute this filter instance is filtering
 
 ***
 
+### filterType
+
+> **`readonly`** **filterType**: `string`
+
+Filter type
+
+***
+
 ### guid
 
 > **`readonly`** **guid**: `string`

diff --git a/docs-md/sdk/modules/sdk-data/type-aliases/index.md b/docs-md/sdk/modules/sdk-data/type-aliases/index.md
@@ -4,6 +4,7 @@ title: Type Aliases
 
 # Type Aliases
 
+- [AnyObject](type-alias.AnyObject.md)
 - [DataSource](type-alias.DataSource.md)
 - [DataSourceInfo](type-alias.DataSourceInfo.md)
 - [FilterRelationsJaqlIdNode](type-alias.FilterRelationsJaqlIdNode.md)

diff --git a/docs-md/sdk/modules/sdk-data/type-aliases/type-alias.AnyObject.md b/docs-md/sdk/modules/sdk-data/type-aliases/type-alias.AnyObject.md
@@ -0,0 +1,9 @@
+---
+title: AnyObject
+---
+
+# Type alias AnyObject
+
+> **AnyObject**: `Record`\< `string`, `any` \>
+
+Abstract object with any unknown values
diff --git a/docs-md/sdk/modules/sdk-ui-angular/fusion-embed/class.WidgetModel.md b/docs-md/sdk/modules/sdk-ui-angular/fusion-embed/class.WidgetModel.md
@@ -134,6 +134,29 @@ Note: this method is not supported for chart and pivot widgets.
 Use [getChartProps](class.WidgetModel.md#getchartprops) instead for getting props for the `<Chart>`  component.
 Use [getPivotTableProps](class.WidgetModel.md#getpivottableprops) instead for getting props for the `<PivotTable>`  component.
 
+***
+
+### getTextWidgetProps
+
+> **getTextWidgetProps**(): [`TextWidgetProps`](../../sdk-ui/type-aliases/type-alias.TextWidgetProps.md)
+
+Returns the props to be used for rendering a text widget.
+
+#### Returns
+
+[`TextWidgetProps`](../../sdk-ui/type-aliases/type-alias.TextWidgetProps.md)
+
+#### Example
+
+```ts
+<TextWidget {...widget.getTextWidgetProps()} />
+```
+
+Note: this method is not supported for chart, table, or pivot widgets.
+Use [getChartWidgetProps](class.WidgetModel.md#getchartwidgetprops) instead for getting props for the `<ChartWidget>`  component.
+Use getTableWidgetProps instead for getting props for the `<TableWidget>`  component.
+Use getPivotTableWidgetProps instead for getting props for the `<PivotTableWidget>`  component.
+
 ## Properties
 
 ### chartType

diff --git a/docs-md/sdk/modules/sdk-ui-angular/type-aliases/type-alias.BoxplotDataPoint.md b/docs-md/sdk/modules/sdk-ui-angular/type-aliases/type-alias.BoxplotDataPoint.md
@@ -12,23 +12,23 @@ Data point in a Boxplot chart.
 
 ### `boxMax`
 
-**boxMax**: `number`
+**boxMax**?: `number`
 
 Value of the box maximum
 
 ***
 
 ### `boxMedian`
 
-**boxMedian**: `number`
+**boxMedian**?: `number`
 
 Value of the box median
 
 ***
 
 ### `boxMin`
 
-**boxMin**: `number`
+**boxMin**?: `number`
 
 Value of the box minimum
 
@@ -50,16 +50,24 @@ Value of the category for the data point
 
 ***
 
+### `outlier`
+
+**outlier**?: `number`
+
+Value of the outlier
+
+***
+
 ### `whiskerMax`
 
-**whiskerMax**: `number`
+**whiskerMax**?: `number`
 
 Value of the box maximal whisker
 
 ***
 
 ### `whiskerMin`
 
-**whiskerMin**: `number`
+**whiskerMin**?: `number`
 
 Value of the box minimal whisker
diff --git a/docs-md/sdk/modules/sdk-ui-angular/type-aliases/type-alias.Navigator.md b/docs-md/sdk/modules/sdk-ui-angular/type-aliases/type-alias.Navigator.md
@@ -20,4 +20,16 @@ Boolean flag that defines if navigator should be shown on the chart
 
 ### `scrollerLocation`
 
-**scrollerLocation**?: [`AutoZoomNavigatorScrollerLocation`](../../sdk-ui/type-aliases/type-alias.AutoZoomNavigatorScrollerLocation.md)
+**scrollerLocation**?: `object`
+
+The scroll location of the navigator scroller / auto zoom feature
+
+> #### `scrollerLocation.max`
+>
+> **max**: `number`
+>
+> #### `scrollerLocation.min`
+>
+> **min**: `number`
+>
+>
diff --git a/docs-md/sdk/modules/sdk-ui-angular/type-aliases/type-alias.WidgetDataOptions.md b/docs-md/sdk/modules/sdk-ui-angular/type-aliases/type-alias.WidgetDataOptions.md
@@ -4,6 +4,6 @@ title: WidgetDataOptions
 
 # Type alias WidgetDataOptions
 
-> **WidgetDataOptions**: [`ChartDataOptions`](type-alias.ChartDataOptions.md) \| [`PivotTableDataOptions`](../interfaces/interface.PivotTableDataOptions.md)
+> **WidgetDataOptions**: [`ChartDataOptions`](type-alias.ChartDataOptions.md) \| [`PivotTableDataOptions`](../interfaces/interface.PivotTableDataOptions.md) \| [`EmptyObject`](../../sdk-ui/type-aliases/type-alias.EmptyObject.md)
 
 Widget data options.
diff --git a/docs-md/sdk/modules/sdk-ui-angular/type-aliases/type-alias.WidgetStyleOptions.md b/docs-md/sdk/modules/sdk-ui-angular/type-aliases/type-alias.WidgetStyleOptions.md
@@ -4,6 +4,6 @@ title: WidgetStyleOptions
 
 # Type alias WidgetStyleOptions
 
-> **WidgetStyleOptions**: [`ChartStyleOptions`](type-alias.ChartStyleOptions.md) \| [`TableStyleOptions`](../interfaces/interface.TableStyleOptions.md) & [`WidgetContainerStyleOptions`](../../sdk-ui/interfaces/interface.WidgetContainerStyleOptions.md)
+> **WidgetStyleOptions**: [`ChartStyleOptions`](type-alias.ChartStyleOptions.md) \| [`TableStyleOptions`](../interfaces/interface.TableStyleOptions.md) \| [`TextWidgetStyleOptions`](../../sdk-ui/type-aliases/type-alias.TextWidgetStyleOptions.md) & [`WidgetContainerStyleOptions`](../../sdk-ui/interfaces/interface.WidgetContainerStyleOptions.md)
 
 Complete set of configuration options that define functional style of the various elements of the charts as well as the look and feel of widget itself and widget header.
diff --git a/docs-md/sdk/modules/sdk-ui-angular/type-aliases/type-alias.WidgetType.md b/docs-md/sdk/modules/sdk-ui-angular/type-aliases/type-alias.WidgetType.md
@@ -4,6 +4,6 @@ title: WidgetType
 
 # Type alias WidgetType
 
-> **WidgetType**: [`CartesianWidgetType`](type-alias.CartesianWidgetType.md) \| [`CategoricalWidgetType`](type-alias.CategoricalWidgetType.md) \| `"chart/scatter"` \| `"indicator"` \| [`TabularWidgetType`](type-alias.TabularWidgetType.md) \| `"chart/boxplot"` \| `"map/scatter"` \| `"map/area"` \| `"plugin"`
+> **WidgetType**: [`CartesianWidgetType`](type-alias.CartesianWidgetType.md) \| [`CategoricalWidgetType`](type-alias.CategoricalWidgetType.md) \| `"chart/scatter"` \| `"indicator"` \| [`TabularWidgetType`](type-alias.TabularWidgetType.md) \| `"chart/boxplot"` \| `"map/scatter"` \| `"map/area"` \| [`TextWidgetType`](../../sdk-ui/type-aliases/type-alias.TextWidgetType.md) \| `"plugin"`
 
 The type of a widget on a dashboard.