@sisense/sdk-ui-angular 1.20.0 → 1.21.0

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

@@ -1,7 +1,7 @@
 import * as i0 from '@angular/core';
 import { EventEmitter, Component, ViewChild, Input, Output, InjectionToken, Injectable, Inject, NgModule, Optional } from '@angular/core';
 import { CommonModule } from '@angular/common';
-import { ComponentAdapter, createElement, BasicMemberFilterTile, createContextProviderRenderer, CustomThemeProvider, CustomSisenseContextProvider, CustomPluginsProvider, createClientApplication, executeQuery, executeQueryByWidgetId, getDashboardModel, getDashboardModels, getWidgetModel, getDefaultThemeSettings, getThemeSettingsByOid, MemberFilterTile, DateRangeFilterTile, Chart, Table, PivotTable, TableWidget, DashboardWidget, createWrapperElementHandler, createWrapperElement, DrilldownWidget, createComponentRenderer, ChartWidget, DashboardById, Dashboard, DrilldownBreadcrumbs, ContextMenu } from '@sisense/sdk-ui-preact';
+import { ComponentAdapter, createElement, BasicMemberFilterTile, createContextProviderRenderer, CustomThemeProvider, CustomSisenseContextProvider, CustomPluginsProvider, createClientApplication, executeQuery, executeQueryByWidgetId, getDashboardModel, getDashboardModels, getWidgetModel, getDefaultThemeSettings, getThemeSettingsByOid, MemberFilterTile, DateRangeFilterTile, CriteriaFilterTile, Chart, Table, PivotTable, TableWidget, DashboardWidget, createWrapperElementHandler, createWrapperElement, DrilldownWidget, createComponentRenderer, ChartWidget, DashboardById, Dashboard, DrilldownBreadcrumbs, ContextMenu } from '@sisense/sdk-ui-preact';
 export { boxWhiskerProcessResult, dashboardModelTranslator, widgetModelTranslator } from '@sisense/sdk-ui-preact';
 import { map, BehaviorSubject } from 'rxjs';
 import { __decorate } from 'tslib';
@@ -415,7 +415,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 }]
         }], ctorParameters: function () { return [{ type: SisenseContextService }]; } });
 
-var packageVersion = '1.20.0';
+var packageVersion = '1.21.0';
 
 function Trackable(target, propertyKey, descriptor) {
     const originalMethod = descriptor.value;
@@ -567,7 +567,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * ```
  * ```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';
  *
@@ -589,7 +588,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * }
  * ```
  * <img src="media://angular-member-filter-tile-example.png" width="400px" />
- *
  * @group Filter Tiles
  */
 class MemberFilterTileComponent {
@@ -691,7 +689,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * ```
  * ```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';
  *
@@ -717,7 +714,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * }
  * ```
  * <img src="media://angular-date-range-filter-tile-example.png" width="600px" />
- *
  * @group Filter Tiles
  */
 class DateRangeFilterTileComponent {
@@ -811,6 +807,130 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 type: Output
             }] } });
 
+/**
+ * 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
+ */
+class CriteriaFilterTileComponent {
+    /**
+     * Constructor for the `CriteriaFilterTileComponent`.
+     *
+     * @param sisenseContextService - Sisense context service
+     * @param themeService - Theme service
+     */
+    constructor(
+    /**
+     * Sisense context service
+     *
+     * @category Constructor
+     */
+    sisenseContextService, 
+    /**
+     * Theme service
+     *
+     * @category Constructor
+     */
+    themeService) {
+        this.sisenseContextService = sisenseContextService;
+        this.themeService = themeService;
+        /**
+         * {@inheritDoc @sisense/sdk-ui!MemberFilterTileProps.onChange}
+         */
+        this.filterChange = new EventEmitter();
+        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 = {
+            title: this.title,
+            filter: this.filter,
+            arrangement: this.arrangement,
+            measures: this.measures,
+            tileDesignOptions: this.tileDesignOptions,
+            onUpdate: (...[filter]) => this.filterChange.emit({ filter }),
+        };
+        return createElement(CriteriaFilterTile, props);
+    }
+    /**
+     * @internal
+     */
+    ngOnDestroy() {
+        this.componentAdapter.destroy();
+    }
+}
+CriteriaFilterTileComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: CriteriaFilterTileComponent, deps: [{ token: SisenseContextService }, { token: ThemeService }], target: i0.ɵɵFactoryTarget.Component });
+CriteriaFilterTileComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: CriteriaFilterTileComponent, selector: "csdk-criteria-filter-tile", inputs: { title: "title", filter: "filter", arrangement: "arrangement", measures: "measures", tileDesignOptions: "tileDesignOptions" }, outputs: { filterChange: "filterChange" }, 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: CriteriaFilterTileComponent, decorators: [{
+            type: Component,
+            args: [{
+                    selector: 'csdk-criteria-filter-tile',
+                    template,
+                }]
+        }], ctorParameters: function () { return [{ type: SisenseContextService }, { type: ThemeService }]; }, propDecorators: { preactRef: [{
+                type: ViewChild,
+                args: [rootId]
+            }], title: [{
+                type: Input
+            }], filter: [{
+                type: Input
+            }], arrangement: [{
+                type: Input
+            }], measures: [{
+                type: Input
+            }], tileDesignOptions: [{
+                type: Input
+            }], filterChange: [{
+                type: Output
+            }] } });
+
 /**
  * An Angular component used for easily switching chart types or rendering multiple series of different chart types.
  *
@@ -3519,7 +3639,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * ```
  * <img src="media://angular-chart-widget-example.png" width="800px" />
  *
- * @group Dashboarding
+ * @group Dashboards
  */
 class ChartWidgetComponent {
     constructor(sisenseContextService, themeService) {
@@ -3629,23 +3749,23 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * **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
@@ -3737,18 +3857,22 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * ```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',
@@ -3762,11 +3886,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  *  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
  */
 class DashboardComponent {
@@ -4093,6 +4220,7 @@ SdkUiModule.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "1
         MemberFilterTileComponent,
         DrilldownWidgetComponent,
         DateRangeFilterTileComponent,
+        CriteriaFilterTileComponent,
         DrilldownBreadcrumbsComponent,
         ContextMenuComponent,
         BoxplotChartComponent,
@@ -4121,6 +4249,7 @@ SdkUiModule.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "1
         MemberFilterTileComponent,
         DrilldownWidgetComponent,
         DateRangeFilterTileComponent,
+        CriteriaFilterTileComponent,
         DrilldownBreadcrumbsComponent,
         ContextMenuComponent,
         BoxplotChartComponent,
@@ -4155,6 +4284,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                         MemberFilterTileComponent,
                         DrilldownWidgetComponent,
                         DateRangeFilterTileComponent,
+                        CriteriaFilterTileComponent,
                         DrilldownBreadcrumbsComponent,
                         ContextMenuComponent,
                         BoxplotChartComponent,
@@ -4187,6 +4317,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                         MemberFilterTileComponent,
                         DrilldownWidgetComponent,
                         DateRangeFilterTileComponent,
+                        CriteriaFilterTileComponent,
                         DrilldownBreadcrumbsComponent,
                         ContextMenuComponent,
                         BoxplotChartComponent,
@@ -4209,9 +4340,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
 /**
  * @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
@@ -4222,8 +4351,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * 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
@@ -4236,5 +4365,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * Generated bundle index. Do not edit.
  */
 
-export { AreaChartComponent, AreaRangeChartComponent, AreamapChartComponent, BarChartComponent, BasicMemberFilterTileComponent, BoxplotChartComponent, ChartComponent, ChartWidgetComponent, ColumnChartComponent, ContextMenuComponent, DashboardByIdComponent, DashboardComponent, DashboardService, DashboardWidgetComponent, DateRangeFilterTileComponent, DrilldownBreadcrumbsComponent, DrilldownWidgetComponent, FunnelChartComponent, IndicatorChartComponent, LineChartComponent, MemberFilterTileComponent, PieChartComponent, PivotTableComponent, PluginsService, PolarChartComponent, QueryService, SISENSE_CONTEXT_CONFIG_TOKEN, ScatterChartComponent, ScattermapChartComponent, SdkUiModule, SisenseContextService, SunburstChartComponent, THEME_CONFIG_TOKEN, TableComponent, TableWidgetComponent, ThemeService, TreemapChartComponent, WidgetService };
+export { AreaChartComponent, AreaRangeChartComponent, AreamapChartComponent, BarChartComponent, BasicMemberFilterTileComponent, BoxplotChartComponent, ChartComponent, ChartWidgetComponent, ColumnChartComponent, ContextMenuComponent, CriteriaFilterTileComponent, DashboardByIdComponent, DashboardComponent, DashboardService, DashboardWidgetComponent, DateRangeFilterTileComponent, DrilldownBreadcrumbsComponent, DrilldownWidgetComponent, FunnelChartComponent, IndicatorChartComponent, LineChartComponent, MemberFilterTileComponent, PieChartComponent, PivotTableComponent, PluginsService, PolarChartComponent, QueryService, SISENSE_CONTEXT_CONFIG_TOKEN, ScatterChartComponent, ScattermapChartComponent, SdkUiModule, SisenseContextService, SunburstChartComponent, THEME_CONFIG_TOKEN, TableComponent, TableWidgetComponent, ThemeService, TreemapChartComponent, WidgetService };
 //# sourceMappingURL=sisense-sdk-ui-angular.mjs.map