@sisense/sdk-ui-angular 1.20.0 → 1.21.0

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

@@ -10,23 +10,23 @@ import * as i0 from "@angular/core";
  * **Note:** Dashboard extensions based on JS scripts and add-ons in Fusion are not supported.
  *
  * @example
- * ```html
- * <csdk-dashboard-by-id
- *   [dashboardOid]="dashboardOid"
- * />
- * ```
  * ```ts
  * import { Component } from '@angular/core';
- *
  * @Component({
- *  selector: 'app-dashboard',
- *  templateUrl: './dashboard.component.html',
- *  styleUrls: ['./dashboard.component.scss'],
- * })
- * export class DashboardComponent {
- *  dashboardOid: string = '60f3e3e3e4b0e3e3e4b0e3e3';
+ *   selector: 'code-example',
+ *   template: `
+ *     <div style="width: 100vw;">
+ *       <csdk-dashboard-by-id *ngIf="dashboardOid" [dashboardOid]="dashboardOid" />
+ *     </div>
+ *   `,
+ *  })
+ * export class CodeExampleComponent {
+ *   dashboardOid = 'your-dashboard-oid';
  * }
  * ```
+ *
+ * To learn more about this and related dashboard components,
+ * see [Embedded Dashboards](/guides/sdk/guides/dashboards/index.html).
  * @group Fusion Embed
  * @fusionEmbed
  * @beta

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

@@ -12,18 +12,22 @@ import * as i0 from "@angular/core";
  * ```html
  * <csdk-dashboard
  *  *ngIf="dashboard"
- *  [title]="dashboard!.title"
- *  [layoutOptions]="dashboard!.layoutOptions"
- *  [widgets]="dashboard!.widgets"
- *  [filters]="dashboard!.filters"
- *  [defaultDataSource]="dashboard!.dataSource"
- *  [widgetsOptions]="dashboard!.widgetsOptions"
+ *  [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 } from '@sisense/sdk-ui-angular';
+ * import {
+ *   type DashboardProps,
+ *   DashboardService,
+ *   dashboardModelTranslator,
+ * } from '@sisense/sdk-ui-angular';
  *
  * @Component({
  *  selector: 'app-dashboard',
@@ -37,11 +41,14 @@ import * as i0 from "@angular/core";
  *  constructor(private dashboardService: DashboardService) {}
  *
  *  async ngOnInit(): Promise<void> {
- *    const dashboardModel = await this.dashboardService.getDashboardModel('60f3e3e3e4b0e3e3e4b0e3e3', { includeWidgets: true, includeFilters: true });
- *    this.dashboardProps = dashboardModelTranslator.toDashboardProps(dashboardModel);
+ *    const dashboardModel = await this.dashboardService.getDashboardModel('your-dashboard-oid', { includeWidgets: true, includeFilters: true });
+ *    this.dashboard = dashboardModelTranslator.toDashboardProps(dashboardModel);
  *  }
  * ```
- * @group Dashboarding
+ *
+ * To learn more about this and related dashboard components,
+ * see [Embedded Dashboards](/guides/sdk/guides/dashboards/index.html).
+ * @group Dashboards
  * @beta
  */
 export declare class DashboardComponent implements AfterViewInit, OnChanges, OnDestroy {

package/dist/lib/components/filters/criteria-filter-tile.component.d.ts

@@ -0,0 +1,117 @@
+import { AfterViewInit, ElementRef, EventEmitter, OnChanges, OnDestroy } from '@angular/core';
+import { type CriteriaFilterTileProps } from '@sisense/sdk-ui-preact';
+import { SisenseContextService } from '../../services/sisense-context.service';
+import { ThemeService } from '../../services/theme.service';
+import type { ArgumentsAsObject } from '../../types/utility-types';
+import * as i0 from "@angular/core";
+/**
+ * Criteria Filter Tile Component
+ *
+ * @example
+ * ```html
+ *     <csdk-criteria-filter-tile
+ *       [title]="criteriaFilterTileProps.title"
+ *       [filter]="criteriaFilterTileProps.filter"
+ *       (filterChange)="criteriaFilterTileProps.setFilter($event)"
+ *     />
+ * ```
+ * ```ts
+ * import { Component } from '@angular/core';
+ * import { Filter, filterFactory } from '@sisense/sdk-data';
+ * import * as DM from '../../assets/sample-healthcare-model';
+ *
+ * @Component({
+ *   selector: 'app-filters',
+ *   templateUrl: './filters.component.html',
+ *   styleUrls: ['./filters.component.scss'],
+ * })
+ * export class FiltersComponent {
+ *   DM = DM;
+ *   title: 'Room Number',
+ *   filter: filterFactory.lessThan(DM.Rooms.Room_number, 200) as CriteriaFilterType,
+ *   setFilter({ filter }: { filter: Filter | null }) {
+ *     console.log(filter);
+ *     if (filter) {
+ *       this.filter = filter as CriteriaFilterType;
+ *     }
+ *   },
+ * }
+ * ```
+ * <img src="media://angular-criteria-filter-tile-example.png" width="400px" />
+ * @group Filter Tiles
+ */
+export declare class CriteriaFilterTileComponent implements AfterViewInit, OnChanges, OnDestroy {
+    /**
+     * Sisense context service
+     *
+     * @category Constructor
+     */
+    sisenseContextService: SisenseContextService;
+    /**
+     * Theme service
+     *
+     * @category Constructor
+     */
+    themeService: ThemeService;
+    /**
+     * @internal
+     */
+    preactRef: ElementRef<HTMLDivElement>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.title}
+     */
+    title: CriteriaFilterTileProps['title'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.filter}
+     */
+    filter: CriteriaFilterTileProps['filter'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.arrangement}
+     */
+    arrangement: CriteriaFilterTileProps['arrangement'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!CriteriaFilterTileProps.measures}
+     */
+    measures: CriteriaFilterTileProps['measures'];
+    /** @internal */
+    tileDesignOptions: CriteriaFilterTileProps['tileDesignOptions'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.onChange}
+     */
+    filterChange: EventEmitter<ArgumentsAsObject<(filter: import("@sisense/sdk-data").Filter | null) => void, ["filter"]>>;
+    private componentAdapter;
+    /**
+     * Constructor for the `CriteriaFilterTileComponent`.
+     *
+     * @param sisenseContextService - Sisense context service
+     * @param themeService - Theme service
+     */
+    constructor(
+    /**
+     * Sisense context service
+     *
+     * @category Constructor
+     */
+    sisenseContextService: SisenseContextService, 
+    /**
+     * Theme service
+     *
+     * @category Constructor
+     */
+    themeService: ThemeService);
+    /**
+     * @internal
+     */
+    ngAfterViewInit(): void;
+    /**
+     * @internal
+     */
+    ngOnChanges(): void;
+    private createPreactComponent;
+    /**
+     * @internal
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CriteriaFilterTileComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<CriteriaFilterTileComponent, "csdk-criteria-filter-tile", never, { "title": "title"; "filter": "filter"; "arrangement": "arrangement"; "measures": "measures"; "tileDesignOptions": "tileDesignOptions"; }, { "filterChange": "filterChange"; }, never, never, false, never>;
+}

package/dist/lib/components/filters/date-range-filter-tile.component.d.ts

@@ -18,7 +18,6 @@ import * as i0 from "@angular/core";
  * ```
  * ```ts
  * import { Component } from '@angular/core';
- * import { Member } from '@sisense/sdk-ui-angular';
  * import { Filter, filterFactory } from '@sisense/sdk-data';
  * import * as DM from '../../assets/sample-healthcare-model';
  *
@@ -44,7 +43,6 @@ import * as i0 from "@angular/core";
  * }
  * ```
  * <img src="media://angular-date-range-filter-tile-example.png" width="600px" />
- *
  * @group Filter Tiles
  */
 export declare class DateRangeFilterTileComponent implements AfterViewInit, OnChanges, OnDestroy {

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

@@ -1,3 +1,4 @@
 export * from './basic-member-filter-tile.component';
 export * from './member-filter-tile.component';
 export * from './date-range-filter-tile.component';
+export * from './criteria-filter-tile.component';

package/dist/lib/components/filters/member-filter-tile.component.d.ts

@@ -18,7 +18,6 @@ import * as i0 from "@angular/core";
  * ```
  * ```ts
  * import { Component } from '@angular/core';
- * import { Member } from '@sisense/sdk-ui-angular';
  * import { Filter, filterFactory } from '@sisense/sdk-data';
  * import * as DM from '../../assets/sample-healthcare-model';
  *
@@ -40,7 +39,6 @@ import * as i0 from "@angular/core";
  * }
  * ```
  * <img src="media://angular-member-filter-tile-example.png" width="400px" />
- *
  * @group Filter Tiles
  */
 export declare class MemberFilterTileComponent implements AfterViewInit, OnChanges, OnDestroy {

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

@@ -60,7 +60,7 @@ import * as i0 from "@angular/core";
  * ```
  * <img src="media://angular-chart-widget-example.png" width="800px" />
  *
- * @group Dashboarding
+ * @group Dashboards
  */
 export declare class ChartWidgetComponent implements AfterViewInit, OnChanges, OnDestroy {
     private sisenseContextService;

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

@@ -20,16 +20,17 @@ import * as i18 from "./components/widgets/dashboard-widget.component";
 import * as i19 from "./components/filters/member-filter-tile.component";
 import * as i20 from "./components/widgets/drilldown-widget.component";
 import * as i21 from "./components/filters/date-range-filter-tile.component";
-import * as i22 from "./components/drilldown-breadcrumbs.component";
-import * as i23 from "./components/context-menu.component";
-import * as i24 from "./components/charts/boxplot-chart.component";
-import * as i25 from "./components/charts/scattermap-chart.component";
-import * as i26 from "./components/charts/areamap-chart.component";
-import * as i27 from "./components/charts/pivot-table.component";
-import * as i28 from "./components/dashboard/dashboard-by-id.component";
-import * as i29 from "./components/dashboard/dashboard.component";
-import * as i30 from "@angular/common";
-import * as i31 from "./decorators/decorators.module";
+import * as i22 from "./components/filters/criteria-filter-tile.component";
+import * as i23 from "./components/drilldown-breadcrumbs.component";
+import * as i24 from "./components/context-menu.component";
+import * as i25 from "./components/charts/boxplot-chart.component";
+import * as i26 from "./components/charts/scattermap-chart.component";
+import * as i27 from "./components/charts/areamap-chart.component";
+import * as i28 from "./components/charts/pivot-table.component";
+import * as i29 from "./components/dashboard/dashboard-by-id.component";
+import * as i30 from "./components/dashboard/dashboard.component";
+import * as i31 from "@angular/common";
+import * as i32 from "./decorators/decorators.module";
 /**
  * SDK UI Module, which is a container for components.
  *
@@ -60,6 +61,6 @@ import * as i31 from "./decorators/decorators.module";
  */
 export declare class SdkUiModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<SdkUiModule, never>;
-    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]>;
+    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.CriteriaFilterTileComponent, typeof i23.DrilldownBreadcrumbsComponent, typeof i24.ContextMenuComponent, typeof i25.BoxplotChartComponent, typeof i26.ScattermapChartComponent, typeof i27.AreamapChartComponent, typeof i28.PivotTableComponent, typeof i29.DashboardByIdComponent, typeof i30.DashboardComponent], [typeof i31.CommonModule, typeof i32.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.CriteriaFilterTileComponent, typeof i23.DrilldownBreadcrumbsComponent, typeof i24.ContextMenuComponent, typeof i25.BoxplotChartComponent, typeof i26.ScattermapChartComponent, typeof i27.AreamapChartComponent, typeof i28.PivotTableComponent, typeof i29.DashboardByIdComponent, typeof i30.DashboardComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<SdkUiModule>;
 }

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

@@ -31,7 +31,7 @@ export declare class PluginsService {
      *
      * @returns A plugin map.
      */
-    getPlugins(): BehaviorSubject<Map<string, PluginComponent>>;
+    getPlugins(): BehaviorSubject<Map<string, PluginComponent<import("@sisense/sdk-ui-preact").GenericDataOptions, any>>>;
     static ɵfac: i0.ɵɵFactoryDeclaration<PluginsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<PluginsService>;
 }

package/dist/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.20.0",
+  "version": "1.21.0",
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist",

package/dist/public-api.d.ts

@@ -1,9 +1,7 @@
 /**
  * @packageDocumentation
  * @groupDescription Charts
- * Angular components for charts
- * @groupDescription Chart Utilities
- * Utilities to be used with charts
+ * Angular components and utilities for working with charts
  * @groupDescription Data Grids
  * Angular components for data grids
  * @groupDescription Drilldown
@@ -14,8 +12,8 @@
  * Angular context modules, services, and variables
  * @groupDescription Queries
  * Angular query service
- * @groupDescription Dashboarding
- * Angular modules, services, and components for composing dashboards
+ * @groupDescription Dashboards
+ * Angular components and utilities for working with dashboards
  * @groupDescription Fusion Embed
  * Angular modules, services, and components for working with Fusion Embed dashboards, widgets, queries, and formulas
  * @groupDescription Interfaces

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.20.0";
+declare const _default: "1.21.0";
 export default _default;

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.20.0",
+  "version": "1.21.0",
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist",
@@ -45,9 +45,9 @@
     "@angular/core": "^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0"
   },
   "dependencies": {
-    "@sisense/sdk-data": "^1.20.0",
-    "@sisense/sdk-tracking": "^1.20.0",
-    "@sisense/sdk-ui-preact": "^1.20.0",
+    "@sisense/sdk-data": "^1.21.0",
+    "@sisense/sdk-tracking": "^1.21.0",
+    "@sisense/sdk-ui-preact": "^1.21.0",
     "rxjs": "^7.8.1",
     "ts-deepmerge": "^6.2.0",
     "tslib": "^2.3.0"