@sisense/sdk-ui-angular 1.32.0 → 1.33.0

package/dist/lib/components/dashboard/dashboard-by-id.component.d.ts

@@ -3,11 +3,16 @@ import { type DashboardByIdProps as DashboardByIdPropsPreact } from '@sisense/sd
 import { SisenseContextService } from '../../services/sisense-context.service';
 import { ThemeService } from '../../services/theme.service';
 import { PluginsService } from '../../services/plugins.service';
+import type { DashboardByIdConfig } from '../../types';
 import * as i0 from "@angular/core";
 /**
  * Props of the {@link DashboardByIdComponent}.
  */
 export interface DashboardByIdProps extends DashboardByIdPropsPreact {
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.config}
+     */
+    config?: DashboardByIdConfig;
 }
 /**
  * An Angular component used for easily rendering a dashboard by its ID created in a Sisense Fusion instance.
@@ -64,11 +69,9 @@ export declare class DashboardByIdComponent implements AfterViewInit, OnChanges,
      */
     dashboardOid: DashboardByIdProps['dashboardOid'];
     /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.persist}
-     *
-     * @alpha
+     * {@inheritDoc @sisense/sdk-ui!DashboardByIdProps.config}
      */
-    persist: DashboardByIdProps['persist'];
+    config: DashboardByIdProps['config'];
     private componentAdapter;
     /**
      * Constructor for the `DashboardById` component.
@@ -110,5 +113,5 @@ export declare class DashboardByIdComponent implements AfterViewInit, OnChanges,
      */
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<DashboardByIdComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DashboardByIdComponent, "csdk-dashboard-by-id", never, { "dashboardOid": "dashboardOid"; "persist": "persist"; }, {}, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DashboardByIdComponent, "csdk-dashboard-by-id", never, { "dashboardOid": "dashboardOid"; "config": "config"; }, {}, never, never, false, never>;
 }

package/dist/lib/components/dashboard/dashboard.component.d.ts

@@ -2,11 +2,16 @@ import { AfterViewInit, ElementRef, OnChanges, OnDestroy } from '@angular/core';
 import { type DashboardProps as DashboardPropsPreact } from '@sisense/sdk-ui-preact';
 import { SisenseContextService } from '../../services/sisense-context.service';
 import { ThemeService } from '../../services/theme.service';
+import type { DashboardConfig } from '../../types';
 import * as i0 from "@angular/core";
 /**
  * Props of the {@link DashboardComponent}.
  */
 export interface DashboardProps extends DashboardPropsPreact {
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.config}
+     */
+    config?: DashboardConfig;
 }
 /**
  * An Angular component used for easily rendering a dashboard created in Sisense Fusion.
@@ -82,8 +87,6 @@ export declare class DashboardComponent implements AfterViewInit, OnChanges, OnD
     layoutOptions: DashboardProps['layoutOptions'];
     /**
      * {@inheritDoc @sisense/sdk-ui!DashboardProps.config}
-     *
-     * @internal
      */
     config: DashboardProps['config'];
     /**

package/dist/lib/components/widgets/index.d.ts

@@ -3,3 +3,4 @@ export * from './dashboard-widget.component';
 export * from './widget-by-id.component';
 export * from './drilldown-widget.component';
 export * from './chart-widget.component';
+export * from './pivot-table-widget.component';

package/dist/lib/components/widgets/pivot-table-widget.component.d.ts

@@ -0,0 +1,127 @@
+import { AfterViewInit, ElementRef, OnChanges, OnDestroy } from '@angular/core';
+import { type PivotTableWidgetProps as PivotTableWidgetPropsPreact } from '@sisense/sdk-ui-preact';
+import { SisenseContextService } from '../../services';
+import { ThemeService } from '../../services';
+import * as i0 from "@angular/core";
+/**
+ * Props of the {@link PivotTableWidgetComponent}.
+ */
+export interface PivotTableWidgetProps extends PivotTableWidgetPropsPreact {
+}
+/**
+ * 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
+ */
+export declare class PivotTableWidgetComponent implements AfterViewInit, OnChanges, OnDestroy {
+    private sisenseContextService;
+    private themeService;
+    /** @internal */
+    preactRef: ElementRef<HTMLDivElement>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableWidgetProps.dataSource}
+     *
+     * @category Data
+     */
+    dataSource: PivotTableWidgetProps['dataSource'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableWidgetProps.dataOptions}
+     *
+     * @category Data
+     */
+    dataOptions: PivotTableWidgetProps['dataOptions'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableWidgetProps.filters}
+     *
+     * @category Data
+     */
+    filters: PivotTableWidgetProps['filters'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableWidgetProps.highlights}
+     *
+     * @category Data
+     */
+    highlights: PivotTableWidgetProps['highlights'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableWidgetProps.styleOptions}
+     *
+     * @category Representation
+     */
+    styleOptions: PivotTableWidgetProps['styleOptions'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableWidgetProps.title}
+     *
+     * @category Widget
+     */
+    title: PivotTableWidgetProps['title'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableWidgetProps.title}
+     *
+     * @category Widget
+     */
+    description: PivotTableWidgetProps['description'];
+    private componentAdapter;
+    constructor(sisenseContextService: SisenseContextService, themeService: ThemeService);
+    /** @internal */
+    ngAfterViewInit(): void;
+    /** @internal */
+    ngOnChanges(): void;
+    private createPreactComponent;
+    /** @internal */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PivotTableWidgetComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<PivotTableWidgetComponent, "csdk-pivot-table-widget", never, { "dataSource": "dataSource"; "dataOptions": "dataOptions"; "filters": "filters"; "highlights": "highlights"; "styleOptions": "styleOptions"; "title": "title"; "description": "description"; }, {}, never, never, false, never>;
+}

package/dist/lib/sdk-ui-core-exports.d.ts

@@ -1,2 +1,2 @@
-export { boxWhiskerProcessResult, widgetModelTranslator, dashboardModelTranslator, dashboardHelpers, } from '@sisense/sdk-ui-preact';
-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, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, PivotTableWidgetStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, HierarchyModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, IndicatorBeforeRenderHandler, IndicatorRenderOptions, DashboardLayoutOptions, DashboardConfig, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, Member, FilterVariant, Hierarchy, CriteriaFilterType, CommonWidgetProps, WidgetProps, } from '@sisense/sdk-ui-preact';
+export { boxWhiskerProcessResult } from '@sisense/sdk-ui-preact';
+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, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, PivotTableWidgetStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, HierarchyModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, IndicatorBeforeRenderHandler, IndicatorRenderOptions, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, Member, FilterVariant, Hierarchy, CriteriaFilterType, CommonWidgetProps, WidgetProps, TextWidgetProps, } from '@sisense/sdk-ui-preact';

package/dist/lib/sdk-ui.module.d.ts

@@ -30,8 +30,9 @@ import * as i28 from "./components/charts/areamap-chart.component";
 import * as i29 from "./components/charts/pivot-table.component";
 import * as i30 from "./components/dashboard/dashboard-by-id.component";
 import * as i31 from "./components/dashboard/dashboard.component";
-import * as i32 from "@angular/common";
-import * as i33 from "./decorators/decorators.module";
+import * as i32 from "./components/widgets/pivot-table-widget.component";
+import * as i33 from "@angular/common";
+import * as i34 from "./decorators/decorators.module";
 /**
  * SDK UI Module, which is a container for components.
  *
@@ -62,6 +63,6 @@ import * as i33 from "./decorators/decorators.module";
  */
 export declare class SdkUiModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<SdkUiModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<SdkUiModule, [typeof i1.ChartComponent, typeof i2.TableComponent, typeof i3.ChartWidgetComponent, typeof i4.ColumnChartComponent, typeof i5.BarChartComponent, typeof i6.AreaChartComponent, typeof i7.AreaRangeChartComponent, typeof i8.LineChartComponent, typeof i9.IndicatorChartComponent, typeof i10.ScatterChartComponent, typeof i11.PieChartComponent, typeof i12.FunnelChartComponent, typeof i13.PolarChartComponent, typeof i14.TreemapChartComponent, typeof i15.SunburstChartComponent, typeof i16.TableWidgetComponent, typeof i17.DashboardWidgetComponent, typeof i18.WidgetByIdComponent, typeof i19.MemberFilterTileComponent, typeof i20.DrilldownWidgetComponent, typeof i21.DateRangeFilterTileComponent, typeof i22.RelativeDateFilterTileComponent, typeof i23.CriteriaFilterTileComponent, typeof i24.DrilldownBreadcrumbsComponent, typeof i25.ContextMenuComponent, typeof i26.BoxplotChartComponent, typeof i27.ScattermapChartComponent, typeof i28.AreamapChartComponent, typeof i29.PivotTableComponent, typeof i30.DashboardByIdComponent, typeof i31.DashboardComponent], [typeof i32.CommonModule, typeof i33.DecoratorsModule], [typeof i1.ChartComponent, typeof i2.TableComponent, typeof i3.ChartWidgetComponent, typeof i4.ColumnChartComponent, typeof i5.BarChartComponent, typeof i6.AreaChartComponent, typeof i7.AreaRangeChartComponent, typeof i8.LineChartComponent, typeof i9.IndicatorChartComponent, typeof i10.ScatterChartComponent, typeof i11.PieChartComponent, typeof i12.FunnelChartComponent, typeof i13.PolarChartComponent, typeof i14.TreemapChartComponent, typeof i15.SunburstChartComponent, typeof i16.TableWidgetComponent, typeof i17.DashboardWidgetComponent, typeof i18.WidgetByIdComponent, typeof i19.MemberFilterTileComponent, typeof i20.DrilldownWidgetComponent, typeof i21.DateRangeFilterTileComponent, typeof i22.RelativeDateFilterTileComponent, typeof i23.CriteriaFilterTileComponent, typeof i24.DrilldownBreadcrumbsComponent, typeof i25.ContextMenuComponent, typeof i26.BoxplotChartComponent, typeof i27.ScattermapChartComponent, typeof i28.AreamapChartComponent, typeof i29.PivotTableComponent, typeof i30.DashboardByIdComponent, typeof i31.DashboardComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SdkUiModule, [typeof i1.ChartComponent, typeof i2.TableComponent, typeof i3.ChartWidgetComponent, typeof i4.ColumnChartComponent, typeof i5.BarChartComponent, typeof i6.AreaChartComponent, typeof i7.AreaRangeChartComponent, typeof i8.LineChartComponent, typeof i9.IndicatorChartComponent, typeof i10.ScatterChartComponent, typeof i11.PieChartComponent, typeof i12.FunnelChartComponent, typeof i13.PolarChartComponent, typeof i14.TreemapChartComponent, typeof i15.SunburstChartComponent, typeof i16.TableWidgetComponent, typeof i17.DashboardWidgetComponent, typeof i18.WidgetByIdComponent, typeof i19.MemberFilterTileComponent, typeof i20.DrilldownWidgetComponent, typeof i21.DateRangeFilterTileComponent, typeof i22.RelativeDateFilterTileComponent, typeof i23.CriteriaFilterTileComponent, typeof i24.DrilldownBreadcrumbsComponent, typeof i25.ContextMenuComponent, typeof i26.BoxplotChartComponent, typeof i27.ScattermapChartComponent, typeof i28.AreamapChartComponent, typeof i29.PivotTableComponent, typeof i30.DashboardByIdComponent, typeof i31.DashboardComponent, typeof i32.PivotTableWidgetComponent], [typeof i33.CommonModule, typeof i34.DecoratorsModule], [typeof i1.ChartComponent, typeof i2.TableComponent, typeof i3.ChartWidgetComponent, typeof i4.ColumnChartComponent, typeof i5.BarChartComponent, typeof i6.AreaChartComponent, typeof i7.AreaRangeChartComponent, typeof i8.LineChartComponent, typeof i9.IndicatorChartComponent, typeof i10.ScatterChartComponent, typeof i11.PieChartComponent, typeof i12.FunnelChartComponent, typeof i13.PolarChartComponent, typeof i14.TreemapChartComponent, typeof i15.SunburstChartComponent, typeof i16.TableWidgetComponent, typeof i17.DashboardWidgetComponent, typeof i18.WidgetByIdComponent, typeof i19.MemberFilterTileComponent, typeof i20.DrilldownWidgetComponent, typeof i21.DateRangeFilterTileComponent, typeof i22.RelativeDateFilterTileComponent, typeof i23.CriteriaFilterTileComponent, typeof i24.DrilldownBreadcrumbsComponent, typeof i25.ContextMenuComponent, typeof i26.BoxplotChartComponent, typeof i27.ScattermapChartComponent, typeof i28.AreamapChartComponent, typeof i29.PivotTableComponent, typeof i30.DashboardByIdComponent, typeof i31.DashboardComponent, typeof i32.PivotTableWidgetComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<SdkUiModule>;
 }

package/dist/lib/services/query.service.d.ts

@@ -1,15 +1,30 @@
-import { type ExecuteQueryParams as ExecuteQueryParamsPreact, type ExecuteQueryByWidgetIdParams as ExecuteQueryByWidgetIdParamsPreact } from '@sisense/sdk-ui-preact';
+import { type ExecuteQueryParams as ExecuteQueryParamsPreact, type ExecuteQueryByWidgetIdParams as ExecuteQueryByWidgetIdParamsPreact, type ExecutePivotQueryParams as ExecutePivotQueryParamsPreact } from '@sisense/sdk-ui-preact';
 import { SisenseContextService } from './sisense-context.service';
 import * as i0 from "@angular/core";
+interface ExecuteQueryHandlers {
+    /** Sync or async callback that allows to modify the JAQL payload before it is sent to the server. */
+    beforeQuery?: ExecuteQueryParamsPreact['onBeforeQuery'];
+    /**
+     * Sync or async callback that allows to modify the JAQL payload before it is sent to the server.
+     *
+     * @deprecated Use `beforeQuery` instead.
+     */
+    onBeforeQuery?: ExecuteQueryParamsPreact['onBeforeQuery'];
+}
 /**
  * Parameters for data query execution.
  */
-export interface ExecuteQueryParams extends Omit<ExecuteQueryParamsPreact, 'enabled'> {
+export interface ExecuteQueryParams extends Omit<ExecuteQueryParamsPreact, 'enabled' | 'onBeforeQuery'>, ExecuteQueryHandlers {
 }
 /**
  * Parameters for data query by widget id execution.
  */
-export interface ExecuteQueryByWidgetIdParams extends Omit<ExecuteQueryByWidgetIdParamsPreact, 'enabled'> {
+export interface ExecuteQueryByWidgetIdParams extends Omit<ExecuteQueryByWidgetIdParamsPreact, 'enabled' | 'onBeforeQuery'>, ExecuteQueryHandlers {
+}
+/**
+ * Parameters for pivot data query execution.
+ */
+export interface ExecutePivotQueryParams extends Omit<ExecutePivotQueryParamsPreact, 'enabled' | 'onBeforeQuery'>, Omit<ExecuteQueryHandlers, 'onBeforeQuery'> {
 }
 /**
  * Service for executing data queries.
@@ -41,6 +56,17 @@ export declare class QueryService {
     executeQueryByWidgetId(params: ExecuteQueryByWidgetIdParams): Promise<{
         data: import("@sisense/sdk-data").QueryResultData;
     } & import("@sisense/sdk-ui-preact").QueryByWidgetIdQueryParams>;
+    /**
+     * Executes a data query for a pivot table.
+     *
+     * @param params - Pivot query parameters
+     * @return Pivot query result
+     * @beta
+     */
+    executePivotQuery(params: ExecutePivotQueryParams): Promise<{
+        data: import("@sisense/sdk-data").PivotQueryResultData;
+    }>;
     static ɵfac: i0.ɵɵFactoryDeclaration<QueryService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<QueryService>;
 }
+export {};

package/dist/lib/types/dashboard-config.d.ts

@@ -0,0 +1,24 @@
+import type { DashboardConfig as DashboardConfigPreact, DashboardByIdConfig as DashboardByIdConfigPreact, DashboardFiltersPanelConfig as DashboardFiltersPanelConfigPreact } from '@sisense/sdk-ui-preact';
+/**
+ * {@inheritDoc @sisense/sdk-ui!DashboardFiltersPanelConfig}
+ */
+export interface DashboardFiltersPanelConfig extends Omit<DashboardFiltersPanelConfigPreact, 'actions'> {
+}
+/**
+ * {@inheritDoc @sisense/sdk-ui!DashboardConfig}
+ */
+export interface DashboardConfig extends Omit<DashboardConfigPreact, 'filtersPanel'> {
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardConfig.filtersPanel}
+     */
+    filtersPanel?: DashboardFiltersPanelConfig;
+}
+/**
+ * {@inheritDoc @sisense/sdk-ui!DashboardByIdConfig}
+ */
+export interface DashboardByIdConfig extends Omit<DashboardByIdConfigPreact, 'filtersPanel'> {
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardByIdConfig.filtersPanel}
+     */
+    filtersPanel?: DashboardFiltersPanelConfig;
+}

package/dist/lib/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from './utility-types';
 export * from './data-point';
 export * from './chart-event-props';
+export * from './dashboard-config';

package/dist/lib/utilities/dashboard-helpers.d.ts

@@ -0,0 +1,105 @@
+import { DashboardProps } from '../components';
+import { Filter, FilterRelations } from '@sisense/sdk-data';
+/**
+ * {@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.
+ */
+export declare const replaceFilters: (dashboard: DashboardProps, newFilters: Filter[] | FilterRelations) => DashboardProps;
+/**
+ * {@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.
+ */
+export declare const addFilter: (dashboard: DashboardProps, newFilter: Filter) => DashboardProps;
+/**
+ * {@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.
+ */
+export declare const addFilters: (dashboard: DashboardProps, newFilters: Filter[]) => DashboardProps;
+/**
+ * {@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.
+ */
+export declare const replaceFilter: (dashboard: DashboardProps, filterToReplace: Filter, newFilter: Filter) => DashboardProps;
+/**
+ * {@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.
+ */
+export declare const modifyFilter: (dashboard: DashboardProps, filterToModify: Filter, newFilter: Filter) => DashboardProps;
+/**
+ * {@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.
+ */
+export declare const removeFilter: (dashboard: DashboardProps, filterToRemove: Filter) => DashboardProps;
+/**
+ * {@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.
+ */
+export declare const removeFilters: (dashboard: DashboardProps, filtersToRemove: Filter[]) => DashboardProps;

package/dist/lib/utilities/dashboard-model-translator.d.ts

@@ -0,0 +1,47 @@
+import { type DashboardModel } from '@sisense/sdk-ui-preact';
+import { type DashboardProps } from '../components';
+/**
+ * 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);
+  }
+}
+ * ```
+ */
+export declare function toDashboardProps(dashboardModel: DashboardModel): DashboardProps;

package/dist/lib/utilities/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardModelTranslator}
+ *
+ * @group Fusion Assets
+ * @fusionEmbed
+ * @shortDescription Utility functions to translate a Fusion dashboard model from and to other dashboard data structures
+ */
+export * as dashboardModelTranslator from './dashboard-model-translator';
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers}
+ *
+ * @group Dashboards
+ * @shortDescription Utility functions to manipulate dashboard elements
+ */
+export * as dashboardHelpers from './dashboard-helpers';
+/**
+ * {@inheritDoc @sisense/sdk-ui!widgetModelTranslator}
+ *
+ * @group Fusion Assets
+ * @fusionEmbed
+ * @shortDescription Utility functions to translate a Fusion widget model from and to other widget data structures
+ */
+export * as widgetModelTranslator from './widget-model-translator';