@sisense/sdk-ui-angular 1.32.0 → 1.33.0

package/dist/fesm2015/sisense-sdk-ui-angular.mjs

@@ -1,8 +1,8 @@
 import * as i0 from '@angular/core';
 import { InjectionToken, Injectable, Inject, NgModule, Optional, EventEmitter, Component, ViewChild, Input, Output } from '@angular/core';
 import { CommonModule } from '@angular/common';
-import { createContextProviderRenderer, CustomThemeProvider, CustomSisenseContextProvider, CustomPluginsProvider, createClientApplication, executeQuery, executeQueryByWidgetId, getDashboardModel, getDashboardModels, getWidgetModel, getHierarchyModels, getDefaultThemeSettings, getThemeSettingsByOid, ComponentAdapter, createElement, MemberFilterTile, DateRangeFilterTile, RelativeDateFilterTile, CriteriaFilterTile, Chart, Table, PivotTable, TableWidget, DashboardWidget, WidgetById, createWrapperElementHandler, createWrapperElement, DrilldownWidget, createComponentRenderer, ChartWidget, DashboardById, Dashboard, DrilldownBreadcrumbs, ContextMenu } from '@sisense/sdk-ui-preact';
-export { boxWhiskerProcessResult, dashboardHelpers, dashboardModelTranslator, widgetModelTranslator } from '@sisense/sdk-ui-preact';
+import { createContextProviderRenderer, CustomThemeProvider, CustomSisenseContextProvider, CustomPluginsProvider, createClientApplication, executeQuery, executeQueryByWidgetId, executePivotQuery, getDashboardModel, getDashboardModels, getWidgetModel, getHierarchyModels, getDefaultThemeSettings, getThemeSettingsByOid, ComponentAdapter, createElement, MemberFilterTile, DateRangeFilterTile, RelativeDateFilterTile, CriteriaFilterTile, Chart, Table, PivotTable, TableWidget, DashboardWidget, WidgetById, createWrapperElementHandler, createWrapperElement, DrilldownWidget, createComponentRenderer, ChartWidget, PivotTableWidget, DashboardById, Dashboard, DrilldownBreadcrumbs, ContextMenu, dashboardModelTranslator as dashboardModelTranslator$1, dashboardHelpers as dashboardHelpers$1, widgetModelTranslator as widgetModelTranslator$1 } from '@sisense/sdk-ui-preact';
+export { boxWhiskerProcessResult } from '@sisense/sdk-ui-preact';
 import { __awaiter, __decorate } from 'tslib';
 import { map, BehaviorSubject } from 'rxjs';
 import merge from 'ts-deepmerge';
@@ -171,7 +171,7 @@ let QueryService = class QueryService {
      */
     executeQuery(params) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { dataSource, dimensions, measures, filters, highlights, count, offset, onBeforeQuery } = params;
+            const { dataSource, dimensions, measures, filters, highlights, count, offset, beforeQuery, onBeforeQuery, } = params;
             const app = yield this.sisenseContextService.getApp();
             const { filters: filterList, relations: filterRelations } = getFilterListAndRelationsJaql(filters);
             const data = yield executeQuery({
@@ -183,7 +183,7 @@ let QueryService = class QueryService {
                 highlights,
                 count,
                 offset,
-            }, app, { onBeforeQuery });
+            }, app, { onBeforeQuery: beforeQuery !== null && beforeQuery !== void 0 ? beforeQuery : onBeforeQuery });
             return { data };
         });
     }
@@ -194,16 +194,44 @@ let QueryService = class QueryService {
      * @returns Query result
      */
     executeQueryByWidgetId(params) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const app = yield this.sisenseContextService.getApp();
-            return executeQueryByWidgetId(Object.assign(Object.assign({}, params), { app }));
+            return executeQueryByWidgetId(Object.assign(Object.assign({}, params), { app, onBeforeQuery: (_a = params.beforeQuery) !== null && _a !== void 0 ? _a : params.onBeforeQuery }));
+        });
+    }
+    /**
+     * Executes a data query for a pivot table.
+     *
+     * @param params - Pivot query parameters
+     * @return Pivot query result
+     * @beta
+     */
+    executePivotQuery(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { dataSource, rows, columns, values, grandTotals, filters, highlights, count, offset, beforeQuery, } = params;
+            const { filters: filterList, relations: filterRelations } = getFilterListAndRelationsJaql(filters);
+            const app = yield this.sisenseContextService.getApp();
+            const data = yield executePivotQuery({
+                dataSource,
+                rows,
+                columns,
+                values,
+                grandTotals,
+                filters: filterList,
+                filterRelations,
+                highlights,
+                count,
+                offset,
+            }, app, { onBeforeQuery: beforeQuery });
+            return { data };
         });
     }
 };
 QueryService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: QueryService, deps: [{ token: SisenseContextService }], target: i0.ɵɵFactoryTarget.Injectable });
 QueryService.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: QueryService, providedIn: 'root' });
 QueryService = __decorate([
-    TrackableService(['executeQuery', 'executeQueryByWidgetId'])
+    TrackableService(['executeQuery', 'executeQueryByWidgetId', 'executePivotQuery'])
 ], QueryService);
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: QueryService, decorators: [{
             type: Injectable,
@@ -401,7 +429,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 }]
         }], ctorParameters: function () { return [{ type: SisenseContextService }]; } });
 
-var packageVersion = '1.32.0';
+var packageVersion = '1.33.0';
 
 function Trackable(target, propertyKey, descriptor) {
     const originalMethod = descriptor.value;
@@ -4051,6 +4079,127 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 type: Output
             }] } });
 
+/**
+ * The Pivot Table Widget component extends the {@link PivotTableComponent} component to support widget features,
+ * including a header, widget style options, and more.
+ *
+ * @example
+ * ```html
+<csdk-pivot-table-widget
+  [dataSource]="pivotProps.dataSource"
+  [dataOptions]="pivotProps.dataOptions"
+  [filters]="pivotProps.filters"
+  [styleOptions]="pivotProps.styleOptions"
+  [title]="pivotProps.title"
+  [description]="pivotProps.description"
+/>
+ * ```
+ * ```ts
+import { Component } from '@angular/core';
+import { type PivotTableWidgetProps } from '@sisense/sdk-ui-angular';
+import { measureFactory, filterFactory } from '@sisense/sdk-data';
+import * as DM from '../../assets/sample-ecommerce';
+
+@Component({
+  selector: 'app-analytics',
+  templateUrl: './analytics.component.html',
+  styleUrls: ['./analytics.component.scss'],
+})
+export class AnalyticsComponent {
+
+  pivotProps: PivotTableWidgetProps = {
+    dataSource: DM.DataSource,
+    dataOptions: {
+      rows: [
+        { column: DM.Category.Category, includeSubTotals: true },
+        { column: DM.Commerce.AgeRange, includeSubTotals: true },
+        DM.Commerce.Condition,
+      ],
+      columns: [{ column: DM.Commerce.Gender, includeSubTotals: true }],
+      values: [
+        measureFactory.sum(DM.Commerce.Cost, 'Total Cost'),
+        {
+          column: measureFactory.sum(DM.Commerce.Revenue, 'Total Revenue'),
+          totalsCalculation: 'sum',
+          dataBars: true,
+        },
+      ],
+      grandTotals: { title: 'Grand Total', rows: true, columns: true },
+    },
+    filters: [filterFactory.members(DM.Commerce.Gender, ['Female', 'Male'])],
+    styleOptions: { width: 1400, height: 600, rowsPerPage: 25 },
+    title: 'Pivot Table Widget',
+    description: 'Pivot Table Widget Description',
+  };
+}
+ * ```
+ * <img src="media://angular-pivot-table-widget-example.png" width="800px" />
+ * @group Dashboards
+ * @beta
+ */
+class PivotTableWidgetComponent {
+    constructor(sisenseContextService, themeService) {
+        this.sisenseContextService = sisenseContextService;
+        this.themeService = themeService;
+        this.componentAdapter = new ComponentAdapter(() => this.createPreactComponent(), [
+            createSisenseContextConnector(this.sisenseContextService),
+            createThemeContextConnector(this.themeService),
+        ]);
+    }
+    /** @internal */
+    ngAfterViewInit() {
+        this.componentAdapter.render(this.preactRef.nativeElement);
+    }
+    /** @internal */
+    ngOnChanges() {
+        if (this.preactRef) {
+            this.componentAdapter.render(this.preactRef.nativeElement);
+        }
+    }
+    createPreactComponent() {
+        const props = {
+            dataSource: this.dataSource,
+            dataOptions: this.dataOptions,
+            filters: this.filters,
+            highlights: this.highlights,
+            styleOptions: this.styleOptions,
+            title: this.title,
+            description: this.description,
+        };
+        return createElement(PivotTableWidget, props);
+    }
+    /** @internal */
+    ngOnDestroy() {
+        this.componentAdapter.destroy();
+    }
+}
+PivotTableWidgetComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: PivotTableWidgetComponent, deps: [{ token: SisenseContextService }, { token: ThemeService }], target: i0.ɵɵFactoryTarget.Component });
+PivotTableWidgetComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: PivotTableWidgetComponent, selector: "csdk-pivot-table-widget", inputs: { dataSource: "dataSource", dataOptions: "dataOptions", filters: "filters", highlights: "highlights", styleOptions: "styleOptions", title: "title", description: "description" }, viewQueries: [{ propertyName: "preactRef", first: true, predicate: ["preact"], descendants: true }], usesOnChanges: true, ngImport: i0, template: "\n    <div #preact style=\"width: 100%; height: 100%\"></div>\n", isInline: true });
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: PivotTableWidgetComponent, decorators: [{
+            type: Component,
+            args: [{
+                    selector: 'csdk-pivot-table-widget',
+                    template,
+                }]
+        }], ctorParameters: function () { return [{ type: SisenseContextService }, { type: ThemeService }]; }, propDecorators: { preactRef: [{
+                type: ViewChild,
+                args: [rootId]
+            }], dataSource: [{
+                type: Input
+            }], dataOptions: [{
+                type: Input
+            }], filters: [{
+                type: Input
+            }], highlights: [{
+                type: Input
+            }], styleOptions: [{
+                type: Input
+            }], title: [{
+                type: Input
+            }], description: [{
+                type: Input
+            }] } });
+
 /**
  * An Angular component used for easily rendering a dashboard by its ID created in a Sisense Fusion instance.
  *
@@ -4130,7 +4279,7 @@ class DashboardByIdComponent {
     createPreactComponent() {
         const props = {
             dashboardOid: this.dashboardOid,
-            persist: this.persist,
+            config: this.config,
         };
         return createElement(DashboardById, props);
     }
@@ -4142,7 +4291,7 @@ class DashboardByIdComponent {
     }
 }
 DashboardByIdComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: DashboardByIdComponent, deps: [{ token: SisenseContextService }, { token: ThemeService }, { token: PluginsService }], target: i0.ɵɵFactoryTarget.Component });
-DashboardByIdComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: DashboardByIdComponent, selector: "csdk-dashboard-by-id", inputs: { dashboardOid: "dashboardOid", persist: "persist" }, viewQueries: [{ propertyName: "preactRef", first: true, predicate: ["preact"], descendants: true }], usesOnChanges: true, ngImport: i0, template: "\n    <div #preact style=\"width: 100%; height: 100%\"></div>\n", isInline: true });
+DashboardByIdComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: DashboardByIdComponent, selector: "csdk-dashboard-by-id", inputs: { dashboardOid: "dashboardOid", config: "config" }, viewQueries: [{ propertyName: "preactRef", first: true, predicate: ["preact"], descendants: true }], usesOnChanges: true, ngImport: i0, template: "\n    <div #preact style=\"width: 100%; height: 100%\"></div>\n", isInline: true });
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: DashboardByIdComponent, decorators: [{
             type: Component,
             args: [{
@@ -4154,7 +4303,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 args: [rootId]
             }], dashboardOid: [{
                 type: Input
-            }], persist: [{
+            }], config: [{
                 type: Input
             }] } });
 
@@ -4538,7 +4687,8 @@ SdkUiModule.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "1
         AreamapChartComponent,
         PivotTableComponent,
         DashboardByIdComponent,
-        DashboardComponent], imports: [CommonModule, DecoratorsModule], exports: [ChartComponent,
+        DashboardComponent,
+        PivotTableWidgetComponent], imports: [CommonModule, DecoratorsModule], exports: [ChartComponent,
         TableComponent,
         ChartWidgetComponent,
         ColumnChartComponent,
@@ -4568,7 +4718,8 @@ SdkUiModule.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "1
         AreamapChartComponent,
         PivotTableComponent,
         DashboardByIdComponent,
-        DashboardComponent] });
+        DashboardComponent,
+        PivotTableWidgetComponent] });
 SdkUiModule.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: SdkUiModule, imports: [CommonModule, DecoratorsModule] });
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: SdkUiModule, decorators: [{
             type: NgModule,
@@ -4605,6 +4756,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                         PivotTableComponent,
                         DashboardByIdComponent,
                         DashboardComponent,
+                        PivotTableWidgetComponent,
                     ],
                     imports: [CommonModule, DecoratorsModule],
                     exports: [
@@ -4639,11 +4791,509 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                         PivotTableComponent,
                         DashboardByIdComponent,
                         DashboardComponent,
+                        PivotTableWidgetComponent,
                     ],
                     providers: [],
                 }]
         }] });
 
+/**
+ * Translates {@link DashboardModel} to {@link DashboardProps}.
+ *
+ * @example
+ * ```html
+<csdk-dashboard
+  *ngIf="dashboard"
+  [title]="dashboard.title"
+  [layoutOptions]="dashboard.layoutOptions"
+  [widgets]="dashboard.widgets"
+  [filters]="dashboard.filters"
+  [defaultDataSource]="dashboard.defaultDataSource"
+  [widgetsOptions]="dashboard.widgetsOptions"
+/>
+ * ```
+ *
+ * ```ts
+import { Component } from '@angular/core';
+import {
+  type DashboardProps,
+  DashboardService,
+  dashboardModelTranslator,
+} from '@sisense/sdk-ui-angular';
+
+@Component({
+  selector: 'app-dashboard',
+  templateUrl: './dashboard.component.html',
+  styleUrls: ['./dashboard.component.scss'],
+})
+export class DashboardComponent {
+  dashboard: DashboardProps | null = null;
+
+  constructor(private dashboardService: DashboardService) {}
+
+  async ngOnInit(): Promise<void> {
+    const dashboardModel = await this.dashboardService.getDashboardModel('your-dashboard-oid', {
+      includeWidgets: true,
+      includeFilters: true,
+    });
+    this.dashboard = dashboardModelTranslator.toDashboardProps(dashboardModel);
+  }
+}
+ * ```
+ */
+function toDashboardProps(dashboardModel) {
+    return dashboardModelTranslator$1.toDashboardProps(dashboardModel);
+}
+
+var dashboardModelTranslator = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    toDashboardProps: toDashboardProps
+});
+
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.replaceFilters}
+ *
+ * @example
+ * Replace all filters on a dashboard with a new set of filters.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...}
+ * const newFilters: Filter[] = [{...}, {...}, ...];
+ * const updatedDashboard = dashboardHelpers.replaceFilters(existingDashboard, newFilters);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) whose filters are to be replaced.
+ * @param newFilters - An array of new filters or filter relations to set on the dashboard.
+ * @returns A new dashboard instance with the updated filters.
+ */
+const replaceFilters = (dashboard, newFilters) => {
+    return dashboardHelpers$1.replaceFilters(dashboard, newFilters);
+};
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.addFilter}
+ *
+ * @example
+ * Add a new filter to a dashboard.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...};
+ * const newFilter: Filter = {...};
+ * const updatedDashboard = dashboardHelpers.addFilter(existingDashboard, newFilter);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) to which the filter will be added.
+ * @param newFilter - The filter to add to the dashboard.
+ * @returns A new dashboard instance with the new filter added.
+ */
+const addFilter = (dashboard, newFilter) => {
+    return dashboardHelpers$1.addFilter(dashboard, newFilter);
+};
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.addFilters}
+ *
+ * @example
+ * Add multiple new filters to a dashboard.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...};
+ * const newFilters: Filter[] = [{...}, {...}, ...];
+ * const updatedDashboard = dashboardHelpers.addFilters(existingDashboard, newFilters);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) to which the filters will be added.
+ * @param newFilters - An array of filters to add to the dashboard.
+ * @returns A new dashboard instance with the new filters added.
+ */
+const addFilters = (dashboard, newFilters) => {
+    return dashboardHelpers$1.addFilters(dashboard, newFilters);
+};
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.replaceFilter}
+ *
+ * @example
+ * Replace a filter in a dashboard.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...};
+ * const filterToReplace: Filter = {...};
+ * const newFilter: Filter = {...};
+ * const updatedDashboard = dashboardHelpers.replaceFilter(existingDashboard, filterToReplace, newFilter);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) containing the filter to be replaced.
+ * @param filterToReplace - The existing filter to be replaced.
+ * @param newFilter - The new filter to replace the existing one.
+ * @returns A new dashboard instance with the specified filter replaced.
+ */
+const replaceFilter = (dashboard, filterToReplace, newFilter) => {
+    return dashboardHelpers$1.replaceFilter(dashboard, filterToReplace, newFilter);
+};
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.modifyFilter}
+ *
+ * @deprecated Use {@link replaceFilter} instead
+ *
+ * @param dashboard - The original dashboard (`DashboardProps`) containing the filter to modify.
+ * @param filterToModify - The existing filter to be modified.
+ * @param newFilter - The new filter to replace the existing one.
+ * @returns A new dashboard instance with the specified filter modified.
+ */
+const modifyFilter = (dashboard, filterToModify, newFilter) => {
+    return dashboardHelpers$1.modifyFilter(dashboard, filterToModify, newFilter);
+};
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.removeFilter}
+ *
+ * @example
+ * Remove a filter from a dashboard.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...};
+ * const filterToRemove: Filter = {...};
+ * const updatedDashboard = dashboardHelpers.removeFilter(existingDashboard, filterToRemove);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) from which to remove the filter.
+ * @param filterToRemove - The filter to be removed.
+ * @returns A new dashboard instance with the specified filter removed.
+ */
+const removeFilter = (dashboard, filterToRemove) => {
+    return dashboardHelpers$1.removeFilter(dashboard, filterToRemove);
+};
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.removeFilters}
+ *
+ * @example
+ * Remove multiple filters from a dashboard.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...};
+ * const filtersToRemove: Filter[] = [{...}, {...}, ...];
+ * const updatedDashboard = dashboardHelpers.removeFilters(existingDashboard, filtersToRemove);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) from which the specified filters are removed.
+ * @param filtersToRemove - An array of filters to remove.
+ * @returns A new dashboard instance with the specified filters removed.
+ */
+const removeFilters = (dashboard, filtersToRemove) => {
+    return dashboardHelpers$1.removeFilters(dashboard, filtersToRemove);
+};
+
+var dashboardHelpers = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    addFilter: addFilter,
+    addFilters: addFilters,
+    modifyFilter: modifyFilter,
+    removeFilter: removeFilter,
+    removeFilters: removeFilters,
+    replaceFilter: replaceFilter,
+    replaceFilters: replaceFilters
+});
+
+/**
+ * Translates a {@link WidgetModel} to the parameters for executing a query for the widget.
+ *
+ * @example
+ * ```ts
+const widgetModel = await widgetService.getWidgetModel({
+  dashboardOid: 'your-dashboard-oid',
+  widgetOid: 'your-widget-oid'
+});
+const executeQueryParams = widgetModelTranslator.toExecuteQueryParams(widgetModel);
+const queryResult = await queryService.executeQuery(executeQueryParams);
+ * ```
+ *
+ * Note: this method is not supported for getting pivot query.
+ * Use {@link toExecutePivotQueryParams} instead for getting query parameters for the pivot widget.
+ */
+const toExecuteQueryParams = (widgetModel) => {
+    return widgetModelTranslator$1.toExecuteQueryParams(widgetModel);
+};
+/**
+ * Translates a {@link WidgetModel} to the parameters for executing a query for the pivot widget.
+ *
+ * @example
+ * ```ts
+const widgetModel = await widgetService.getWidgetModel({
+  dashboardOid: 'your-dashboard-oid',
+  widgetOid: 'your-widget-oid'
+});
+const executePivotQueryParams = widgetModelTranslator.toExecutePivotQueryParams(widgetModel);
+const queryResult = await queryService.executePivotQuery(executeQueryParams);
+ * ```
+ *
+ * Note: this method is supported only for getting pivot query.
+ * Use {@link toExecuteQueryParams} instead for getting query parameters for non-pivot widgets.
+ */
+const toExecutePivotQueryParams = (widgetModel) => {
+    return widgetModelTranslator$1.toExecutePivotQueryParams(widgetModel);
+};
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a chart.
+ *
+ * @example
+ * ```html
+<csdk-chart
+  *ngIf="chartProps"
+  [chartType]="chartProps.chartType"
+  [dataSet]="chartProps.dataSet"
+  [dataOptions]="chartProps.dataOptions"
+  [filters]="chartProps.filters"
+  [highlights]="chartProps.highlights"
+  [styleOptions]="chartProps.styleOptions"
+/>
+ * ```
+ *
+ * ```ts
+import { Component } from '@angular/core';
+import {
+  type ChartProps
+  WidgetService,
+  widgetModelTranslator,
+} from '@sisense/sdk-ui-angular';
+
+@Component({
+  selector: 'app-example',
+  templateUrl: './example.component.html',
+  styleUrls: ['./example.component.scss'],
+})
+export class ExampleComponent {
+  chartProps: ChartProps | null = null;
+
+  constructor(private widgetService: WidgetService) {}
+
+  async ngOnInit(): Promise<void> {
+    const widgetModel = await widgetService.getWidgetModel({
+      dashboardOid: 'your-dashboard-oid',
+      widgetOid: 'your-widget-oid'
+    });
+    this.chartProps = widgetModelTranslator.toChartProps(widgetModel);
+  }
+}
+ * ```
+ *
+ * Note: this method is not supported for pivot widgets.
+ * Use {@link toPivotTableProps} instead for getting props for the {@link PivotTableComponent}.
+ */
+function toChartProps(widgetModel) {
+    return widgetModelTranslator$1.toChartProps(widgetModel);
+}
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a table.
+ *
+ * @example
+ * ```html
+<csdk-table
+  *ngIf="tableProps"
+  [dataSet]="tableProps.dataSet"
+  [dataOptions]="tableProps.dataOptions"
+  [filters]="tableProps.filters"
+  [styleOptions]="tableProps.styleOptions"
+/>
+ * ```
+ *
+ * ```ts
+import { Component } from '@angular/core';
+import {
+  type TableProps
+  WidgetService,
+  widgetModelTranslator,
+} from '@sisense/sdk-ui-angular';
+
+@Component({
+  selector: 'app-example',
+  templateUrl: './example.component.html',
+  styleUrls: ['./example.component.scss'],
+})
+export class ExampleComponent {
+  tableProps: TableProps | null = null;
+
+  constructor(private widgetService: WidgetService) {}
+
+  async ngOnInit(): Promise<void> {
+    const widgetModel = await widgetService.getWidgetModel({
+      dashboardOid: 'your-dashboard-oid',
+      widgetOid: 'your-widget-oid'
+    });
+    this.tableProps = widgetModelTranslator.toTableProps(widgetModel);
+  }
+}
+ * ```
+ *
+ * Note: this method is not supported for chart and pivot widgets.
+ * Use {@link toChartProps} instead for getting props for the {@link ChartComponent}.
+ * Use {@link toPivotTableProps} instead for getting props for the {@link PivotTableComponent}.
+ */
+function toTableProps(widgetModel) {
+    return widgetModelTranslator$1.toTableProps(widgetModel);
+}
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a pivot table.
+ *
+ * @example
+ * ```html
+<csdk-pivot-table
+  *ngIf="pivotTableProps"
+  [dataSet]="pivotTableProps.dataSet"
+  [dataOptions]="pivotTableProps.dataOptions"
+  [filters]="pivotTableProps.filters"
+  [styleOptions]="pivotTableProps.styleOptions"
+/>
+ * ```
+ *
+ * ```ts
+import { Component } from '@angular/core';
+import {
+  type PivotTableProps
+  WidgetService,
+  widgetModelTranslator,
+} from '@sisense/sdk-ui-angular';
+
+@Component({
+  selector: 'app-example',
+  templateUrl: './example.component.html',
+  styleUrls: ['./example.component.scss'],
+})
+export class ExampleComponent {
+  pivotTableProps: PivotTableProps | null = null;
+
+  constructor(private widgetService: WidgetService) {}
+
+  async ngOnInit(): Promise<void> {
+    const widgetModel = await widgetService.getWidgetModel({
+      dashboardOid: 'your-dashboard-oid',
+      widgetOid: 'your-widget-oid'
+    });
+    this.pivotTableProps = widgetModelTranslator.toPivotTableProps(widgetModel);
+  }
+}
+ * ```
+ *
+ * Note: this method is not supported for chart or table widgets.
+ * Use {@link toChartProps} instead for getting props for the {@link ChartComponent}.
+ * Use {@link toTableProps} instead for getting props for the {@link TableComponent}.
+ */
+function toPivotTableProps(widgetModel) {
+    return widgetModelTranslator$1.toPivotTableProps(widgetModel);
+}
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a chart widget.
+ *
+ * @example
+ * ```html
+<csdk-chart-widget
+  *ngIf="chartWidgetProps"
+  [chartType]="chartWidgetProps.chartType"
+  [dataSource]="chartWidgetProps.dataSource"
+  [dataOptions]="chartWidgetProps.dataOptions"
+  [filters]="chartWidgetProps.filters"
+  [highlights]="chartWidgetProps.highlights"
+  [styleOptions]="chartWidgetProps.styleOptions"
+/>
+ * ```
+ *
+ * ```ts
+import { Component } from '@angular/core';
+import {
+  type ChartWidgetProps
+  WidgetService,
+  widgetModelTranslator,
+} from '@sisense/sdk-ui-angular';
+
+@Component({
+  selector: 'app-example',
+  templateUrl: './example.component.html',
+  styleUrls: ['./example.component.scss'],
+})
+export class ExampleComponent {
+  chartWidgetProps: ChartWidgetProps | null = null;
+
+  constructor(private widgetService: WidgetService) {}
+
+  async ngOnInit(): Promise<void> {
+    const widgetModel = await widgetService.getWidgetModel({
+      dashboardOid: 'your-dashboard-oid',
+      widgetOid: 'your-widget-oid'
+    });
+    this.chartWidgetProps = widgetModelTranslator.toChartWidgetProps(widgetModel);
+  }
+}
+ * ```
+ *
+ * Note: this method is not supported for pivot widgets.
+ */
+function toChartWidgetProps(widgetModel) {
+    return widgetModelTranslator$1.toChartWidgetProps(widgetModel);
+}
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a pivot table widget.
+ *
+ * @example
+ * ```html
+<csdk-pivot-table-widget
+  *ngIf="pivotWidgetProps"
+  [dataSet]="pivotWidgetProps.dataSet"
+  [dataOptions]="pivotWidgetProps.dataOptions"
+  [filters]="pivotWidgetProps.filters"
+  [styleOptions]="pivotWidgetProps.styleOptions"
+/>
+ * ```
+ *
+ * ```ts
+import { Component } from '@angular/core';
+import {
+  type PivotTableWidgetProps
+  WidgetService,
+  widgetModelTranslator,
+} from '@sisense/sdk-ui-angular';
+
+@Component({
+  selector: 'app-example',
+  templateUrl: './example.component.html',
+  styleUrls: ['./example.component.scss'],
+})
+export class ExampleComponent {
+  pivotWidgetProps: PivotTableWidgetProps | null = null;
+
+  constructor(private widgetService: WidgetService) {}
+
+  async ngOnInit(): Promise<void> {
+    const widgetModel = await widgetService.getWidgetModel({
+      dashboardOid: 'your-dashboard-oid',
+      widgetOid: 'your-widget-oid'
+    });
+    this.pivotWidgetProps = widgetModelTranslator.toPivotTableWidgetProps(widgetModel);
+  }
+}
+ * ```
+ *
+ * Note: this method is not supported for chart or table widgets.
+ * Use {@link toChartWidgetProps} instead for getting props for the {@link ChartWidgetComponent}.
+ */
+function toPivotTableWidgetProps(widgetModel) {
+    return widgetModelTranslator$1.toPivotTableWidgetProps(widgetModel);
+}
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a text widget.
+ *
+ * @example
+ * ```ts
+const widgetModel = await widgetService.getWidgetModel({
+  dashboardOid: 'your-dashboard-oid',
+  widgetOid: 'your-widget-oid'
+});
+const textWidgetProps = widgetModelTranslator.toTextWidgetProps(widgetModel);
+ * ```
+ *
+ * Note: this method is not supported for chart or pivot widgets.
+ * Use {@link toChartWidgetProps} instead for getting props for the {@link ChartWidgetComponent}.
+ * Use {@link toPivotTableWidgetProps} instead for getting props for the pivot table widget.
+ */
+function toTextWidgetProps(widgetModel) {
+    return widgetModelTranslator$1.toTextWidgetProps(widgetModel);
+}
+
+var widgetModelTranslator = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    toChartProps: toChartProps,
+    toChartWidgetProps: toChartWidgetProps,
+    toExecutePivotQueryParams: toExecutePivotQueryParams,
+    toExecuteQueryParams: toExecuteQueryParams,
+    toPivotTableProps: toPivotTableProps,
+    toPivotTableWidgetProps: toPivotTableWidgetProps,
+    toTableProps: toTableProps,
+    toTextWidgetProps: toTextWidgetProps
+});
+
 // This file re-exports common types/utils from @sisense/sdk-ui-preact
 // Re-exports utils from @sisense/sdk-ui-preact
 
@@ -4655,5 +5305,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * Generated bundle index. Do not edit.
  */
 
-export { AreaChartComponent, AreaRangeChartComponent, AreamapChartComponent, BarChartComponent, BoxplotChartComponent, ChartComponent, ChartWidgetComponent, ColumnChartComponent, ContextMenuComponent, CriteriaFilterTileComponent, DashboardByIdComponent, DashboardComponent, DashboardService, DashboardWidgetComponent, DateRangeFilterTileComponent, DrilldownBreadcrumbsComponent, DrilldownWidgetComponent, FunnelChartComponent, HierarchyService, IndicatorChartComponent, LineChartComponent, MemberFilterTileComponent, PieChartComponent, PivotTableComponent, PluginsService, PolarChartComponent, QueryService, RelativeDateFilterTileComponent, SISENSE_CONTEXT_CONFIG_TOKEN, ScatterChartComponent, ScattermapChartComponent, SdkUiModule, SisenseContextService, SunburstChartComponent, THEME_CONFIG_TOKEN, TableComponent, TableWidgetComponent, ThemeService, TrackableService, TreemapChartComponent, WidgetByIdComponent, WidgetService, createPluginsContextConnector, createSisenseContextConnector, createThemeContextConnector };
+export { AreaChartComponent, AreaRangeChartComponent, AreamapChartComponent, BarChartComponent, BoxplotChartComponent, ChartComponent, ChartWidgetComponent, ColumnChartComponent, ContextMenuComponent, CriteriaFilterTileComponent, DashboardByIdComponent, DashboardComponent, DashboardService, DashboardWidgetComponent, DateRangeFilterTileComponent, DrilldownBreadcrumbsComponent, DrilldownWidgetComponent, FunnelChartComponent, HierarchyService, IndicatorChartComponent, LineChartComponent, MemberFilterTileComponent, PieChartComponent, PivotTableComponent, PivotTableWidgetComponent, PluginsService, PolarChartComponent, QueryService, RelativeDateFilterTileComponent, SISENSE_CONTEXT_CONFIG_TOKEN, ScatterChartComponent, ScattermapChartComponent, SdkUiModule, SisenseContextService, SunburstChartComponent, THEME_CONFIG_TOKEN, TableComponent, TableWidgetComponent, ThemeService, TrackableService, TreemapChartComponent, WidgetByIdComponent, WidgetService, createPluginsContextConnector, createSisenseContextConnector, createThemeContextConnector, dashboardHelpers, dashboardModelTranslator, widgetModelTranslator };
 //# sourceMappingURL=sisense-sdk-ui-angular.mjs.map