Skip to content

Commit

Permalink
Release v1.17.0
Browse files Browse the repository at this point in the history
  • Loading branch information
compose-sdk-release-bot committed Aug 20, 2024
1 parent 42c4a69 commit a376eb6
Show file tree
Hide file tree
Showing 245 changed files with 9,825 additions and 7,984 deletions.
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# Changelog

## [1.17.0] - 2024-08-20

### Added
- Move components `DashboardById` and `Dashboard` to internal alpha for React, Angular, and Vue
- Support external usage tracking in `AppConfig.trackingConfig.onTrackingEvent`
- Refactor `ChartWidget` to reuse `DrilldownWidget` internally
- Support drill down for scatter chart widgets

### Changed
- Mark internal property `enableTracking?` as `@deprecated` in `SisenseContextProviderProps` – use `AppConfig.trackingConfig.enabled` instead
- Extend `ThemeSettings` to support animation-related config
- Improve dashboard rendering: locked filters in cross filtering, resetting levels of `CascadingFilterTile`, highlight of all categories in cartesian charts, dashboard theme setting, matching theme for widget header info panel
- Refactor component `Table` to reduce computations and re-renders
- Fix issues of charts: legend position of funnel chart, number formatting for indicator's secondary value
- Improve `SisenseContextProvider` in React: support of pending `token` or `wat` for delayed authentication and custom error handling
- Improve testing: disabling animation for e2e tests

## [1.16.0] - 2024-08-06

### Added
Expand Down
17 changes: 17 additions & 0 deletions docs-md/sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# Changelog

## [1.17.0] - 2024-08-20

### Added
- Move components `DashboardById` and `Dashboard` to internal alpha for React, Angular, and Vue
- Support external usage tracking in `AppConfig.trackingConfig.onTrackingEvent`
- Refactor `ChartWidget` to reuse `DrilldownWidget` internally
- Support drill down for scatter chart widgets

### Changed
- Mark internal property `enableTracking?` as `@deprecated` in `SisenseContextProviderProps` – use `AppConfig.trackingConfig.enabled` instead
- Extend `ThemeSettings` to support animation-related config
- Improve dashboard rendering: locked filters in cross filtering, resetting levels of `CascadingFilterTile`, highlight of all categories in cartesian charts, dashboard theme setting, matching theme for widget header info panel
- Refactor component `Table` to reduce computations and re-renders
- Fix issues of charts: legend position of funnel chart, number formatting for indicator's secondary value
- Improve `SisenseContextProvider` in React: support of pending `token` or `wat` for delayed authentication and custom error handling
- Improve testing: disabling animation for e2e tests

## [1.16.0] - 2024-08-06

### Added
Expand Down
5 changes: 4 additions & 1 deletion docs-md/sdk/modules/sdk-data/interfaces/interface.Cell.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ or [query result data set](interface.QueryResultData.md).

> **blur**?: `boolean`
Boolean flag whether the data value should be blurred when visualized in a chart
Boolean flag representing three states that can be visualized in a chart:
- `true`: the data value is in blur state
- `false`: the data value is in highlight state
- if not specified, the data value is neither in highlight nor blur state

***

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: DashboardByIdComponent
---

# Class DashboardByIdComponent <Badge type="fusionEmbed" text="Fusion Embed" /> <Badge type="alpha" text="Alpha" />

An Angular component used for easily rendering a dashboard by its ID created in a Sisense Fusion instance.

**Note:** Dashboard extensions based on JS scripts and add-ons in Fusion are not supported.

## Example

```html
<csdk-dashboard-by-id
[dashboardOid]="dashboardOid"
/>
```
```ts
import { Component } from '@angular/core';

@Component({
selector: 'app-dashboard',
templateUrl: './dashboard.component.html',
styleUrls: ['./dashboard.component.scss'],
})
export class DashboardComponent {
dashboardOid: string = '60f3e3e3e4b0e3e3e4b0e3e3';
}
```

## Implements

- `AfterViewInit`
- `OnChanges`
- `OnDestroy`

## Constructors

### constructor

> **new DashboardByIdComponent**(`sisenseContextService`, `themeService`): [`DashboardByIdComponent`](class.DashboardByIdComponent.md)
Constructor for the `DashboardById` component.

#### Parameters

| Parameter | Type | Description |
| :------ | :------ | :------ |
| `sisenseContextService` | [`SisenseContextService`](../contexts/class.SisenseContextService.md) | Sisense context service |
| `themeService` | [`ThemeService`](../contexts/class.ThemeService.md) | Theme service |

#### Returns

[`DashboardByIdComponent`](class.DashboardByIdComponent.md)

## Properties

### Constructor

#### sisenseContextService

> **sisenseContextService**: [`SisenseContextService`](../contexts/class.SisenseContextService.md)
Sisense context service

***

#### themeService

> **themeService**: [`ThemeService`](../contexts/class.ThemeService.md)
Theme service

### Other

#### dashboardOid

> **dashboardOid**: `string`
The OID of the dashboard to render.
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
---
title: DashboardComponent
---

# Class DashboardComponent <Badge type="fusionEmbed" text="Fusion Embed" /> <Badge type="alpha" text="Alpha" />

An Angular component used for easily rendering a dashboard created in Sisense Fusion.

**Note:** Dashboard extensions based on JS scripts and add-ons in Fusion are not supported.

## Example

```html
<csdk-dashboard
*ngIf="dashboard"
[title]="dashboard!.title"
[layout]="dashboard!.layout"
[widgets]="dashboard!.widgets"
[filters]="dashboard!.filters"
[defaultDataSource]="dashboard!.dataSource"
[widgetFilterOptions]="dashboard!.widgetFilterOptions"
/>
```
```ts
import { Component } from '@angular/core';
import { type DashboardModel, DashboardService } from '@sisense/sdk-ui-angular';

@Component({
selector: 'app-dashboard',
templateUrl: './dashboard.component.html',
styleUrls: ['./dashboard.component.scss'],
})
export class DashboardComponent {

dashboard: DashboardModel | null = null;

constructor(private dashboardService: DashboardService) {}

async ngOnInit(): Promise<void> {
this.dashboard = await this.dashboardService.getDashboardModel('60f3e3e3e4b0e3e3e4b0e3e3', { includeWidgets: true, includeFilters: true });
}
```
## Implements
- `AfterViewInit`
- `OnChanges`
- `OnDestroy`
## Constructors
### constructor
> **new DashboardComponent**(`sisenseContextService`, `themeService`): [`DashboardComponent`](class.DashboardComponent.md)
Constructor for the `Dashboard` component.
#### Parameters
| Parameter | Type | Description |
| :------ | :------ | :------ |
| `sisenseContextService` | [`SisenseContextService`](../contexts/class.SisenseContextService.md) | Sisense context service |
| `themeService` | [`ThemeService`](../contexts/class.ThemeService.md) | Theme service |
#### Returns
[`DashboardComponent`](class.DashboardComponent.md)
## Properties
### Constructor
#### sisenseContextService
> **sisenseContextService**: [`SisenseContextService`](../contexts/class.SisenseContextService.md)
Sisense context service
***
#### themeService
> **themeService**: [`ThemeService`](../contexts/class.ThemeService.md)
Theme service
### Other
#### defaultDataSource
> **defaultDataSource**: `undefined` \| [`DataSource`](../../sdk-data/type-aliases/type-alias.DataSource.md)
The default data source to use for the dashboard
***
#### filters
> **filters**: [`Filter`](../../sdk-data/interfaces/interface.Filter.md)[]
The dashboard filters to be applied to each of the widgets based on the widget filter options
***
#### layout
> **layout**: [`Layout`](../interfaces/interface.Layout.md)
The layout of the dashboard
***
#### styleOptions
> **styleOptions**: [`DashboardStyleOptions`](../../sdk-ui/type-aliases/type-alias.DashboardStyleOptions.md)
The style options for the dashboard
***
#### title
> **title**: `string`
The title of the dashboard
***
#### widgetFilterOptions
> **widgetFilterOptions**: `undefined` \| [`WidgetFilterOptions`](../type-aliases/type-alias.WidgetFilterOptions.md)
The filter options for each of the widgets
***
#### widgets
> **widgets**: [`WidgetModel`](class.WidgetModel.md)[]
The widgets to render in the dashboard
2 changes: 2 additions & 0 deletions docs-md/sdk/modules/sdk-ui-angular/fusion-embed/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ title: Fusion Embed

Angular modules, services, and components for working with Fusion Embed dashboards, widgets, queries, and formulas

- [DashboardByIdComponent](class.DashboardByIdComponent.md) <Badge type="fusionEmbed" text="Fusion Embed" /> <Badge type="alpha" text="Alpha" />
- [DashboardComponent](class.DashboardComponent.md) <Badge type="fusionEmbed" text="Fusion Embed" /> <Badge type="alpha" text="Alpha" />
- [DashboardModel](class.DashboardModel.md) <Badge type="fusionEmbed" text="Fusion Embed" />
- [DashboardService](class.DashboardService.md) <Badge type="fusionEmbed" text="Fusion Embed" />
- [DashboardWidgetComponent](class.DashboardWidgetComponent.md) <Badge type="fusionEmbed" text="Fusion Embed" />
Expand Down
2 changes: 2 additions & 0 deletions docs-md/sdk/modules/sdk-ui-angular/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ Angular query service

Angular modules, services, and components for working with Fusion Embed dashboards, widgets, queries, and formulas

- [DashboardByIdComponent](fusion-embed/class.DashboardByIdComponent.md) <Badge type="fusionEmbed" text="Fusion Embed" /> <Badge type="alpha" text="Alpha" />
- [DashboardComponent](fusion-embed/class.DashboardComponent.md) <Badge type="fusionEmbed" text="Fusion Embed" /> <Badge type="alpha" text="Alpha" />
- [DashboardModel](fusion-embed/class.DashboardModel.md) <Badge type="fusionEmbed" text="Fusion Embed" />
- [DashboardService](fusion-embed/class.DashboardService.md) <Badge type="fusionEmbed" text="Fusion Embed" />
- [DashboardWidgetComponent](fusion-embed/class.DashboardWidgetComponent.md) <Badge type="fusionEmbed" text="Fusion Embed" />
Expand Down
1 change: 1 addition & 0 deletions docs-md/sdk/modules/sdk-ui-angular/interfaces/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ TypeScript interfaces for components and services listed above
- [GetDashboardModelOptions](interface.GetDashboardModelOptions.md)
- [GetDashboardModelsOptions](interface.GetDashboardModelsOptions.md)
- [IndicatorChartDataOptions](interface.IndicatorChartDataOptions.md)
- [Layout](interface.Layout.md)
- [LineStyleOptions](interface.LineStyleOptions.md)
- [Member](interface.Member.md)
- [NumericBarIndicatorStyleOptions](interface.NumericBarIndicatorStyleOptions.md)
Expand Down
22 changes: 22 additions & 0 deletions docs-md/sdk/modules/sdk-ui-angular/interfaces/interface.Layout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Layout
---

# Interface Layout

Layout of a dashboard.

## Properties

### columns

> **columns**: \{
`rows`: \{
`cells`: \{
`height`: `string` \| `number`;
`widgetId`: `string`;
`widthPercentage`: `number`;
}[];
}[];
`widthPercentage`: `number`;
}[]
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,18 @@ Set to `true` to use SSO authentication. When `true`, this overrides any other a

#### token

> **token**?: `string`
> **token**?: `null` \| `string`
Token for [bearer authentication](https://sisense.dev/guides/restApi/using-rest-api.html).

To signify that the token is pending (e.g., being generated), set the value to `null`. This is supported for React and Vue only.

***

#### wat

> **wat**?: `string`
> **wat**?: `null` \| `string`
[Web Access Token](https://docs.sisense.com/main/SisenseLinux/using-web-access-token.htm).

To signify that the token is pending (e.g., being generated), set the value to `null`. This is supported for React and Vue only.
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,14 @@ Also, see [StyledMeasureColumn](interface.StyledMeasureColumn.md).

## Properties

### color

> **color**?: [`DataColorOptions`](../type-aliases/type-alias.DataColorOptions.md)
All possible color options for data.

***

### column

> **column**: [`Column`](../../sdk-data/interfaces/interface.Column.md)
Expand Down
1 change: 1 addition & 0 deletions docs-md/sdk/modules/sdk-ui-angular/type-aliases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ TypeScript type aliases for components and services listed above
- [UniformDataColorOptions](type-alias.UniformDataColorOptions.md)
- [ValueToColorMap](type-alias.ValueToColorMap.md)
- [WidgetDataOptions](type-alias.WidgetDataOptions.md)
- [WidgetFilterOptions](type-alias.WidgetFilterOptions.md)
- [WidgetStyleOptions](type-alias.WidgetStyleOptions.md)
- [WidgetType](type-alias.WidgetType.md)
- [X2Title](type-alias.X2Title.md)
Loading

0 comments on commit a376eb6

Please sign in to comment.