-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
compose-sdk-release-bot
committed
Aug 20, 2024
1 parent
42c4a69
commit a376eb6
Showing
245 changed files
with
9,825 additions
and
7,984 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
80 changes: 80 additions & 0 deletions
80
docs-md/sdk/modules/sdk-ui-angular/fusion-embed/class.DashboardByIdComponent.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
141 changes: 141 additions & 0 deletions
141
docs-md/sdk/modules/sdk-ui-angular/fusion-embed/class.DashboardComponent.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22
docs-md/sdk/modules/sdk-ui-angular/interfaces/interface.Layout.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`; | ||
}[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.