@sisense/sdk-ui-angular 1.19.0 → 1.20.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.
@@ -29,7 +29,7 @@ import * as i0 from "@angular/core";
29
29
  * ```
30
30
  * @group Fusion Embed
31
31
  * @fusionEmbed
32
- * @alpha
32
+ * @beta
33
33
  */
34
34
  export declare class DashboardByIdComponent implements AfterViewInit, OnChanges, OnDestroy {
35
35
  /**
@@ -13,16 +13,17 @@ import * as i0 from "@angular/core";
13
13
  * <csdk-dashboard
14
14
  * *ngIf="dashboard"
15
15
  * [title]="dashboard!.title"
16
- * [layout]="dashboard!.layout"
16
+ * [layoutOptions]="dashboard!.layoutOptions"
17
17
  * [widgets]="dashboard!.widgets"
18
18
  * [filters]="dashboard!.filters"
19
19
  * [defaultDataSource]="dashboard!.dataSource"
20
- * [widgetFilterOptions]="dashboard!.widgetFilterOptions"
20
+ * [widgetsOptions]="dashboard!.widgetsOptions"
21
21
  * />
22
22
  * ```
23
+ *
23
24
  * ```ts
24
25
  * import { Component } from '@angular/core';
25
- * import { type DashboardModel, DashboardService } from '@sisense/sdk-ui-angular';
26
+ * import { type DashboardProps, DashboardService } from '@sisense/sdk-ui-angular';
26
27
  *
27
28
  * @Component({
28
29
  * selector: 'app-dashboard',
@@ -31,17 +32,17 @@ import * as i0 from "@angular/core";
31
32
  * })
32
33
  * export class DashboardComponent {
33
34
  *
34
- * dashboard: DashboardModel | null = null;
35
+ * dashboard: DashboardProps | null = null;
35
36
  *
36
37
  * constructor(private dashboardService: DashboardService) {}
37
38
  *
38
39
  * async ngOnInit(): Promise<void> {
39
- * this.dashboard = await this.dashboardService.getDashboardModel('60f3e3e3e4b0e3e3e4b0e3e3', { includeWidgets: true, includeFilters: true });
40
+ * const dashboardModel = await this.dashboardService.getDashboardModel('60f3e3e3e4b0e3e3e4b0e3e3', { includeWidgets: true, includeFilters: true });
41
+ * this.dashboardProps = dashboardModelTranslator.toDashboardProps(dashboardModel);
40
42
  * }
41
43
  * ```
42
- * @group Fusion Embed
43
- * @fusionEmbed
44
- * @alpha
44
+ * @group Dashboarding
45
+ * @beta
45
46
  */
46
47
  export declare class DashboardComponent implements AfterViewInit, OnChanges, OnDestroy {
47
48
  /**
@@ -65,9 +66,15 @@ export declare class DashboardComponent implements AfterViewInit, OnChanges, OnD
65
66
  */
66
67
  title: DashboardProps['title'];
67
68
  /**
68
- * {@inheritDoc @sisense/sdk-ui!DashboardProps.layout}
69
+ * {@inheritDoc @sisense/sdk-ui!DashboardProps.layoutOptions}
70
+ */
71
+ layoutOptions: DashboardProps['layoutOptions'];
72
+ /**
73
+ * {@inheritDoc @sisense/sdk-ui!DashboardProps.config}
74
+ *
75
+ * @internal
69
76
  */
70
- layout: DashboardProps['layout'];
77
+ config: DashboardProps['config'];
71
78
  /**
72
79
  * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
73
80
  */
@@ -81,9 +88,9 @@ export declare class DashboardComponent implements AfterViewInit, OnChanges, OnD
81
88
  */
82
89
  defaultDataSource: DashboardProps['defaultDataSource'];
83
90
  /**
84
- * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgetFilterOptions}
91
+ * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgetsOptions}
85
92
  */
86
- widgetFilterOptions: DashboardProps['widgetFilterOptions'];
93
+ widgetsOptions: DashboardProps['widgetsOptions'];
87
94
  /**
88
95
  * {@inheritDoc @sisense/sdk-ui!DashboardProps.styleOptions}
89
96
  */
@@ -122,5 +129,5 @@ export declare class DashboardComponent implements AfterViewInit, OnChanges, OnD
122
129
  */
123
130
  ngOnDestroy(): void;
124
131
  static ɵfac: i0.ɵɵFactoryDeclaration<DashboardComponent, never>;
125
- static ɵcmp: i0.ɵɵComponentDeclaration<DashboardComponent, "csdk-dashboard", never, { "title": "title"; "layout": "layout"; "widgets": "widgets"; "filters": "filters"; "defaultDataSource": "defaultDataSource"; "widgetFilterOptions": "widgetFilterOptions"; "styleOptions": "styleOptions"; }, {}, never, never, false, never>;
132
+ static ɵcmp: i0.ɵɵComponentDeclaration<DashboardComponent, "csdk-dashboard", never, { "title": "title"; "layoutOptions": "layoutOptions"; "config": "config"; "widgets": "widgets"; "filters": "filters"; "defaultDataSource": "defaultDataSource"; "widgetsOptions": "widgetsOptions"; "styleOptions": "styleOptions"; }, {}, never, never, false, never>;
126
133
  }
@@ -60,7 +60,7 @@ import * as i0 from "@angular/core";
60
60
  * ```
61
61
  * <img src="media://angular-chart-widget-example.png" width="800px" />
62
62
  *
63
- * @group Chart Utilities
63
+ * @group Dashboarding
64
64
  */
65
65
  export declare class ChartWidgetComponent implements AfterViewInit, OnChanges, OnDestroy {
66
66
  private sisenseContextService;
@@ -104,7 +104,7 @@ export declare class DrilldownWidgetComponent implements AfterViewInit, OnChange
104
104
  * @category Widget
105
105
  *
106
106
  */
107
- drilldownDimensions: DrilldownWidgetProps['drilldownDimensions'];
107
+ drilldownDimensions: NonNullable<DrilldownWidgetProps['drilldownDimensions']>;
108
108
  /**
109
109
  * {@inheritDoc @sisense/sdk-ui!DrilldownWidgetProps.initialDimension}
110
110
  *
@@ -1,2 +1,2 @@
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, 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';
1
+ export { boxWhiskerProcessResult, widgetModelTranslator, dashboardModelTranslator, } 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, PivotTableWidgetStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, DashboardProps, DashboardLayoutOptions, DashboardConfig, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, WidgetProps, 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';
@@ -1,5 +1,5 @@
1
1
  import { BehaviorSubject } from 'rxjs';
2
- import { WidgetPlugin } from '@sisense/sdk-ui-preact';
2
+ import { PluginComponent } from '@sisense/sdk-ui-preact';
3
3
  import * as i0 from "@angular/core";
4
4
  /**
5
5
  * Service for working with plugins fetched from an external environment.
@@ -18,20 +18,20 @@ export declare class PluginsService {
18
18
  * @param pluginType - The unique identifier for the plugin type.
19
19
  * @param plugin - The plugin instance to register.
20
20
  */
21
- registerPlugin(pluginType: string, plugin: WidgetPlugin): void;
21
+ registerPlugin(pluginType: string, plugin: PluginComponent): void;
22
22
  /**
23
23
  * Retrieves a plugin by its type.
24
24
  *
25
25
  * @param pluginType - The unique identifier for the plugin type.
26
26
  * @returns The plugin instance if found, otherwise undefined.
27
27
  */
28
- getPlugin(pluginType: string): WidgetPlugin | undefined;
28
+ getPlugin(pluginType: string): PluginComponent | undefined;
29
29
  /**
30
30
  * Retrieves a complete plugin map.
31
31
  *
32
32
  * @returns A plugin map.
33
33
  */
34
- getPlugins(): BehaviorSubject<Map<string, WidgetPlugin<{}>>>;
34
+ getPlugins(): BehaviorSubject<Map<string, PluginComponent>>;
35
35
  static ɵfac: i0.ɵɵFactoryDeclaration<PluginsService, never>;
36
36
  static ɵprov: i0.ɵɵInjectableDeclaration<PluginsService>;
37
37
  }
package/dist/package.json CHANGED
@@ -11,7 +11,7 @@
11
11
  "Sisense",
12
12
  "Compose SDK"
13
13
  ],
14
- "version": "1.19.0",
14
+ "version": "1.20.0",
15
15
  "author": "Sisense",
16
16
  "license": "SEE LICENSE IN LICENSE.md",
17
17
  "main": "dist",
@@ -14,6 +14,8 @@
14
14
  * Angular context modules, services, and variables
15
15
  * @groupDescription Queries
16
16
  * Angular query service
17
+ * @groupDescription Dashboarding
18
+ * Angular modules, services, and components for composing dashboards
17
19
  * @groupDescription Fusion Embed
18
20
  * Angular modules, services, and components for working with Fusion Embed dashboards, widgets, queries, and formulas
19
21
  * @groupDescription Interfaces
package/dist/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- declare const _default: "1.19.0";
1
+ declare const _default: "1.20.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.19.0",
14
+ "version": "1.20.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.19.0",
49
- "@sisense/sdk-tracking": "^1.19.0",
50
- "@sisense/sdk-ui-preact": "^1.19.0",
48
+ "@sisense/sdk-data": "^1.20.0",
49
+ "@sisense/sdk-tracking": "^1.20.0",
50
+ "@sisense/sdk-ui-preact": "^1.20.0",
51
51
  "rxjs": "^7.8.1",
52
52
  "ts-deepmerge": "^6.2.0",
53
53
  "tslib": "^2.3.0"