@sisense/sdk-ui-angular 1.13.0 → 1.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,87 @@
1
+ import { AfterViewInit, ElementRef, OnChanges, OnDestroy } from '@angular/core';
2
+ import { type DashboardByIdProps } from '@sisense/sdk-ui-preact';
3
+ import { SisenseContextService } from '../../services/sisense-context.service';
4
+ import { ThemeService } from '../../services/theme.service';
5
+ import * as i0 from "@angular/core";
6
+ /**
7
+ * An Angular component used for easily rendering a dashboard by its ID created in a Sisense Fusion instance.
8
+ *
9
+ * @example
10
+ * ```html
11
+ * <csdk-dashboard-by-id
12
+ * [dashboardOid]="dashboardOid"
13
+ * />
14
+ * ```
15
+ * ```ts
16
+ * import { Component } from '@angular/core';
17
+ *
18
+ * @Component({
19
+ * selector: 'app-dashboard',
20
+ * templateUrl: './dashboard.component.html',
21
+ * styleUrls: ['./dashboard.component.scss'],
22
+ * })
23
+ * export class DashboardComponent {
24
+ * dashboardOid: string = '60f3e3e3e4b0e3e3e4b0e3e3';
25
+ * }
26
+ * ```
27
+ * @group Fusion Embed
28
+ * @fusionEmbed
29
+ * @internal
30
+ */
31
+ export declare class DashboardByIdComponent implements AfterViewInit, OnChanges, OnDestroy {
32
+ /**
33
+ * Sisense context service
34
+ *
35
+ * @category Constructor
36
+ */
37
+ sisenseContextService: SisenseContextService;
38
+ /**
39
+ * Theme service
40
+ *
41
+ * @category Constructor
42
+ */
43
+ themeService: ThemeService;
44
+ /**
45
+ * @internal
46
+ */
47
+ preactRef: ElementRef<HTMLDivElement>;
48
+ /**
49
+ * {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.dashboardOid}
50
+ */
51
+ dashboardOid: DashboardByIdProps['dashboardOid'];
52
+ private componentAdapter;
53
+ /**
54
+ * Constructor for the `DashboardById` component.
55
+ *
56
+ * @param sisenseContextService - Sisense context service
57
+ * @param themeService - Theme service
58
+ */
59
+ constructor(
60
+ /**
61
+ * Sisense context service
62
+ *
63
+ * @category Constructor
64
+ */
65
+ sisenseContextService: SisenseContextService,
66
+ /**
67
+ * Theme service
68
+ *
69
+ * @category Constructor
70
+ */
71
+ themeService: ThemeService);
72
+ /**
73
+ * @internal
74
+ */
75
+ ngAfterViewInit(): void;
76
+ /**
77
+ * @internal
78
+ */
79
+ ngOnChanges(): void;
80
+ private createPreactComponent;
81
+ /**
82
+ * @internal
83
+ */
84
+ ngOnDestroy(): void;
85
+ static ɵfac: i0.ɵɵFactoryDeclaration<DashboardByIdComponent, never>;
86
+ static ɵcmp: i0.ɵɵComponentDeclaration<DashboardByIdComponent, "csdk-dashboard-by-id", never, { "dashboardOid": "dashboardOid"; }, {}, never, never, false, never>;
87
+ }
@@ -0,0 +1,120 @@
1
+ import { AfterViewInit, ElementRef, OnChanges, OnDestroy } from '@angular/core';
2
+ import { type DashboardProps } from '@sisense/sdk-ui-preact';
3
+ import { SisenseContextService } from '../../services/sisense-context.service';
4
+ import { ThemeService } from '../../services/theme.service';
5
+ import * as i0 from "@angular/core";
6
+ /**
7
+ * An Angular component used for easily rendering a dashboard.
8
+ *
9
+ * @example
10
+ * ```html
11
+ * <csdk-dashboard
12
+ * *ngIf="dashboard"
13
+ * [title]="dashboard!.title"
14
+ * [layout]="dashboard!.layout"
15
+ * [widgets]="dashboard!.widgets"
16
+ * [filters]="dashboard!.filters"
17
+ * [defaultDataSource]="dashboard!.dataSource"
18
+ * [widgetFilterOptions]="dashboard!.widgetFilterOptions"
19
+ * />
20
+ * ```
21
+ * ```ts
22
+ * import { Component } from '@angular/core';
23
+ * import { type DashboardModel, DashboardService } from '@sisense/sdk-ui-angular';
24
+ *
25
+ * @Component({
26
+ * selector: 'app-dashboard',
27
+ * templateUrl: './dashboard.component.html',
28
+ * styleUrls: ['./dashboard.component.scss'],
29
+ * })
30
+ * export class DashboardComponent {
31
+ *
32
+ * dashboard: DashboardModel | null = null;
33
+ *
34
+ * constructor(private dashboardService: DashboardService) {}
35
+ *
36
+ * async ngOnInit(): Promise<void> {
37
+ * this.dashboard = await this.dashboardService.getDashboardModel('60f3e3e3e4b0e3e3e4b0e3e3', { includeWidgets: true, includeFilters: true });
38
+ * }
39
+ * ```
40
+ * @group Fusion Embed
41
+ * @fusionEmbed
42
+ * @internal
43
+ */
44
+ export declare class DashboardComponent implements AfterViewInit, OnChanges, OnDestroy {
45
+ /**
46
+ * Sisense context service
47
+ *
48
+ * @category Constructor
49
+ */
50
+ sisenseContextService: SisenseContextService;
51
+ /**
52
+ * Theme service
53
+ *
54
+ * @category Constructor
55
+ */
56
+ themeService: ThemeService;
57
+ /**
58
+ * @internal
59
+ */
60
+ preactRef: ElementRef<HTMLDivElement>;
61
+ /**
62
+ * {@inheritDoc @sisense/sdk-ui!DashboardProps.title}
63
+ */
64
+ title: DashboardProps['title'];
65
+ /**
66
+ * {@inheritDoc @sisense/sdk-ui!DashboardProps.layout}
67
+ */
68
+ layout: DashboardProps['layout'];
69
+ /**
70
+ * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
71
+ */
72
+ widgets: DashboardProps['widgets'];
73
+ /**
74
+ * {@inheritDoc @sisense/sdk-ui!DashboardProps.filters}
75
+ */
76
+ filters: DashboardProps['filters'];
77
+ /**
78
+ * {@inheritDoc @sisense/sdk-ui!DashboardProps.defaultDataSource}
79
+ */
80
+ defaultDataSource: DashboardProps['defaultDataSource'];
81
+ /**
82
+ * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgetFilterOptions}
83
+ */
84
+ widgetFilterOptions: DashboardProps['widgetFilterOptions'];
85
+ private componentAdapter;
86
+ /**
87
+ * Constructor for the `Dashboard` component.
88
+ *
89
+ * @param sisenseContextService - Sisense context service
90
+ * @param themeService - Theme service
91
+ */
92
+ constructor(
93
+ /**
94
+ * Sisense context service
95
+ *
96
+ * @category Constructor
97
+ */
98
+ sisenseContextService: SisenseContextService,
99
+ /**
100
+ * Theme service
101
+ *
102
+ * @category Constructor
103
+ */
104
+ themeService: ThemeService);
105
+ /**
106
+ * @internal
107
+ */
108
+ ngAfterViewInit(): void;
109
+ /**
110
+ * @internal
111
+ */
112
+ ngOnChanges(): void;
113
+ private createPreactComponent;
114
+ /**
115
+ * @internal
116
+ */
117
+ ngOnDestroy(): void;
118
+ static ɵfac: i0.ɵɵFactoryDeclaration<DashboardComponent, never>;
119
+ static ɵcmp: i0.ɵɵComponentDeclaration<DashboardComponent, "csdk-dashboard", never, { "title": "title"; "layout": "layout"; "widgets": "widgets"; "filters": "filters"; "defaultDataSource": "defaultDataSource"; "widgetFilterOptions": "widgetFilterOptions"; }, {}, never, never, false, never>;
120
+ }
@@ -0,0 +1,2 @@
1
+ export * from './dashboard-by-id.component';
2
+ export * from './dashboard.component';
@@ -1,5 +1,6 @@
1
1
  export * from './filters';
2
2
  export * from './charts';
3
3
  export * from './widgets';
4
+ export * from './dashboard';
4
5
  export * from './drilldown-breadcrumbs.component';
5
6
  export * from './context-menu.component';
@@ -1,2 +1,2 @@
1
1
  export { boxWhiskerProcessResult } from '@sisense/sdk-ui-preact';
2
- export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, RangeChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, RangeChartDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, DashboardWidgetStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, AppConfig, DateConfig, ContextMenuProps, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, CriteriaFilterType, Member, FilterVariant, } from '@sisense/sdk-ui-preact';
2
+ export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, RangeChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, RangeChartDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, DashboardWidgetStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, Layout, WidgetFilterOptions, AppConfig, DateConfig, ContextMenuProps, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, CriteriaFilterType, Member, FilterVariant, } from '@sisense/sdk-ui-preact';
@@ -26,8 +26,10 @@ import * as i24 from "./components/charts/boxplot-chart.component";
26
26
  import * as i25 from "./components/charts/scattermap-chart.component";
27
27
  import * as i26 from "./components/charts/areamap-chart.component";
28
28
  import * as i27 from "./components/charts/pivot-table.component";
29
- import * as i28 from "@angular/common";
30
- import * as i29 from "./decorators/decorators.module";
29
+ import * as i28 from "./components/dashboard/dashboard-by-id.component";
30
+ import * as i29 from "./components/dashboard/dashboard.component";
31
+ import * as i30 from "@angular/common";
32
+ import * as i31 from "./decorators/decorators.module";
31
33
  /**
32
34
  * SDK UI Module, which is a container for components.
33
35
  *
@@ -58,6 +60,6 @@ import * as i29 from "./decorators/decorators.module";
58
60
  */
59
61
  export declare class SdkUiModule {
60
62
  static ɵfac: i0.ɵɵFactoryDeclaration<SdkUiModule, never>;
61
- static ɵmod: i0.ɵɵNgModuleDeclaration<SdkUiModule, [typeof i1.BasicMemberFilterTileComponent, typeof i2.ChartComponent, typeof i3.TableComponent, typeof i4.ChartWidgetComponent, typeof i5.ColumnChartComponent, typeof i6.BarChartComponent, typeof i7.AreaChartComponent, typeof i8.AreaRangeChartComponent, typeof i9.LineChartComponent, typeof i10.IndicatorChartComponent, typeof i11.ScatterChartComponent, typeof i12.PieChartComponent, typeof i13.FunnelChartComponent, typeof i14.PolarChartComponent, typeof i15.TreemapChartComponent, typeof i16.SunburstChartComponent, typeof i17.TableWidgetComponent, typeof i18.DashboardWidgetComponent, typeof i19.MemberFilterTileComponent, typeof i20.DrilldownWidgetComponent, typeof i21.DateRangeFilterTileComponent, typeof i22.DrilldownBreadcrumbsComponent, typeof i23.ContextMenuComponent, typeof i24.BoxplotChartComponent, typeof i25.ScattermapChartComponent, typeof i26.AreamapChartComponent, typeof i27.PivotTableComponent], [typeof i28.CommonModule, typeof i29.DecoratorsModule], [typeof i1.BasicMemberFilterTileComponent, typeof i2.ChartComponent, typeof i3.TableComponent, typeof i4.ChartWidgetComponent, typeof i5.ColumnChartComponent, typeof i6.BarChartComponent, typeof i7.AreaChartComponent, typeof i8.AreaRangeChartComponent, typeof i9.LineChartComponent, typeof i10.IndicatorChartComponent, typeof i11.ScatterChartComponent, typeof i12.PieChartComponent, typeof i13.FunnelChartComponent, typeof i14.PolarChartComponent, typeof i15.TreemapChartComponent, typeof i16.SunburstChartComponent, typeof i17.TableWidgetComponent, typeof i18.DashboardWidgetComponent, typeof i19.MemberFilterTileComponent, typeof i20.DrilldownWidgetComponent, typeof i21.DateRangeFilterTileComponent, typeof i22.DrilldownBreadcrumbsComponent, typeof i23.ContextMenuComponent, typeof i24.BoxplotChartComponent, typeof i25.ScattermapChartComponent, typeof i26.AreamapChartComponent, typeof i27.PivotTableComponent]>;
63
+ static ɵmod: i0.ɵɵNgModuleDeclaration<SdkUiModule, [typeof i1.BasicMemberFilterTileComponent, typeof i2.ChartComponent, typeof i3.TableComponent, typeof i4.ChartWidgetComponent, typeof i5.ColumnChartComponent, typeof i6.BarChartComponent, typeof i7.AreaChartComponent, typeof i8.AreaRangeChartComponent, typeof i9.LineChartComponent, typeof i10.IndicatorChartComponent, typeof i11.ScatterChartComponent, typeof i12.PieChartComponent, typeof i13.FunnelChartComponent, typeof i14.PolarChartComponent, typeof i15.TreemapChartComponent, typeof i16.SunburstChartComponent, typeof i17.TableWidgetComponent, typeof i18.DashboardWidgetComponent, typeof i19.MemberFilterTileComponent, typeof i20.DrilldownWidgetComponent, typeof i21.DateRangeFilterTileComponent, typeof i22.DrilldownBreadcrumbsComponent, typeof i23.ContextMenuComponent, typeof i24.BoxplotChartComponent, typeof i25.ScattermapChartComponent, typeof i26.AreamapChartComponent, typeof i27.PivotTableComponent, typeof i28.DashboardByIdComponent, typeof i29.DashboardComponent], [typeof i30.CommonModule, typeof i31.DecoratorsModule], [typeof i1.BasicMemberFilterTileComponent, typeof i2.ChartComponent, typeof i3.TableComponent, typeof i4.ChartWidgetComponent, typeof i5.ColumnChartComponent, typeof i6.BarChartComponent, typeof i7.AreaChartComponent, typeof i8.AreaRangeChartComponent, typeof i9.LineChartComponent, typeof i10.IndicatorChartComponent, typeof i11.ScatterChartComponent, typeof i12.PieChartComponent, typeof i13.FunnelChartComponent, typeof i14.PolarChartComponent, typeof i15.TreemapChartComponent, typeof i16.SunburstChartComponent, typeof i17.TableWidgetComponent, typeof i18.DashboardWidgetComponent, typeof i19.MemberFilterTileComponent, typeof i20.DrilldownWidgetComponent, typeof i21.DateRangeFilterTileComponent, typeof i22.DrilldownBreadcrumbsComponent, typeof i23.ContextMenuComponent, typeof i24.BoxplotChartComponent, typeof i25.ScattermapChartComponent, typeof i26.AreamapChartComponent, typeof i27.PivotTableComponent, typeof i28.DashboardByIdComponent, typeof i29.DashboardComponent]>;
62
64
  static ɵinj: i0.ɵɵInjectorDeclaration<SdkUiModule>;
63
65
  }
@@ -42,6 +42,8 @@ export declare const THEME_CONFIG_TOKEN: InjectionToken<ThemeConfig>;
42
42
  /**
43
43
  * Service for working with Sisense Fusion themes.
44
44
  *
45
+ * If no theme service is used, the current Fusion theme is applied by default.
46
+ *
45
47
  * @group Contexts
46
48
  */
47
49
  export declare class ThemeService {
package/dist/package.json CHANGED
@@ -11,7 +11,7 @@
11
11
  "Sisense",
12
12
  "Compose SDK"
13
13
  ],
14
- "version": "1.13.0",
14
+ "version": "1.14.0",
15
15
  "author": "Sisense",
16
16
  "license": "SEE LICENSE IN LICENSE.md",
17
17
  "main": "dist",
package/dist/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- declare const _default: "1.13.0";
1
+ declare const _default: "1.14.0";
2
2
  export default _default;
package/package.json CHANGED
@@ -11,7 +11,7 @@
11
11
  "Sisense",
12
12
  "Compose SDK"
13
13
  ],
14
- "version": "1.13.0",
14
+ "version": "1.14.0",
15
15
  "author": "Sisense",
16
16
  "license": "SEE LICENSE IN LICENSE.md",
17
17
  "main": "dist",
@@ -45,9 +45,9 @@
45
45
  "@angular/core": "^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0"
46
46
  },
47
47
  "dependencies": {
48
- "@sisense/sdk-data": "^1.13.0",
49
- "@sisense/sdk-tracking": "^1.13.0",
50
- "@sisense/sdk-ui-preact": "^1.13.0",
48
+ "@sisense/sdk-data": "^1.14.0",
49
+ "@sisense/sdk-tracking": "^1.14.0",
50
+ "@sisense/sdk-ui-preact": "^1.14.0",
51
51
  "rxjs": "^7.8.1",
52
52
  "ts-deepmerge": "^6.2.0",
53
53
  "tslib": "^2.3.0"