@sisense/sdk-ui-angular 0.13.0 → 0.14.0

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

@@ -396,7 +396,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Table Component
+ * Table with aggregation and pagination.
  */
 class TableComponent {
     constructor(sisenseContextService, themeService) {
@@ -453,7 +453,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Chart Widget Component
+ * The Chart Widget component extending {@link ChartComponent} to support widget style options.
  */
 class ChartWidgetComponent {
     constructor(sisenseContextService, themeService) {
@@ -504,6 +504,7 @@ class ChartWidgetComponent {
             drilldownOptions: this.drilldownOptions,
             title: this.title,
             description: this.description,
+            highlightSelectionDisabled: this.highlightSelectionDisabled,
             onBeforeRender: this.beforeRender?.bind(this),
             onDataPointClick: (...[point, nativeEvent]) => this.dataPointClick.emit({ point, nativeEvent }),
             onDataPointContextMenu: (...[point, nativeEvent]) => this.dataPointContextMenu.emit({ point, nativeEvent }),
@@ -517,7 +518,7 @@ class ChartWidgetComponent {
     }
 }
 ChartWidgetComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: ChartWidgetComponent, deps: [{ token: SisenseContextService }, { token: ThemeService }], target: i0.ɵɵFactoryTarget.Component });
-ChartWidgetComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: ChartWidgetComponent, selector: "csdk-chart-widget", inputs: { chartType: "chartType", dataSource: "dataSource", dataOptions: "dataOptions", filters: "filters", highlights: "highlights", styleOptions: "styleOptions", widgetStyleOptions: "widgetStyleOptions", drilldownOptions: "drilldownOptions", title: "title", description: "description", beforeRender: "beforeRender" }, outputs: { dataPointClick: "dataPointClick", dataPointContextMenu: "dataPointContextMenu", dataPointsSelect: "dataPointsSelect" }, viewQueries: [{ propertyName: "preactRef", first: true, predicate: ["preact"], descendants: true }], usesOnChanges: true, ngImport: i0, template: "<div #preact style=\"width: 100%; height: 100%\"></div>", isInline: true });
+ChartWidgetComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: ChartWidgetComponent, selector: "csdk-chart-widget", inputs: { chartType: "chartType", dataSource: "dataSource", dataOptions: "dataOptions", filters: "filters", highlights: "highlights", styleOptions: "styleOptions", widgetStyleOptions: "widgetStyleOptions", drilldownOptions: "drilldownOptions", title: "title", description: "description", highlightSelectionDisabled: "highlightSelectionDisabled", beforeRender: "beforeRender" }, outputs: { dataPointClick: "dataPointClick", dataPointContextMenu: "dataPointContextMenu", dataPointsSelect: "dataPointsSelect" }, viewQueries: [{ propertyName: "preactRef", first: true, predicate: ["preact"], descendants: true }], usesOnChanges: true, ngImport: i0, template: "<div #preact style=\"width: 100%; height: 100%\"></div>", isInline: true });
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: ChartWidgetComponent, decorators: [{
             type: Component,
             args: [{
@@ -547,6 +548,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 type: Input
             }], description: [{
                 type: Input
+            }], highlightSelectionDisabled: [{
+                type: Input
             }], beforeRender: [{
                 type: Input
             }], dataPointClick: [{
@@ -558,7 +561,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Column Chart Component
+ * A component representing categorical data with vertical rectangular bars
+ * whose heights are proportional to the values that they represent.
+ * See [Column Chart](https://docs.sisense.com/main/SisenseLinux/column-chart.htm) for more information.
  */
 class ColumnChartComponent {
     constructor() {
@@ -637,7 +642,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Bar Chart Component
+ * A component representing categorical data with horizontal rectangular bars,
+ * whose lengths are proportional to the values that they represent.
+ * See [Bar Chart](https://docs.sisense.com/main/SisenseLinux/bar-chart.htm) for more information.
  */
 class BarChartComponent {
     constructor() {
@@ -716,7 +723,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Area Chart Component
+ * A component similar to a {@link LineChartComponent},
+ * but with filled in areas under each line and an option to display them as stacked.
+ * More info on [Sisense Documentation page](https://docs.sisense.com/main/SisenseLinux/area-chart.htm).
  */
 class AreaChartComponent {
     constructor() {
@@ -795,7 +804,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Line Chart Component
+ * A component displaying data as a series of points connected by a line. Used to show trends or changes over time.
+ * See [Line Chart](https://docs.sisense.com/main/SisenseLinux/line-chart.htm) for more information.
  */
 class LineChartComponent {
     constructor() {
@@ -874,7 +884,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Indicator Chart Component
+ * A component that provides various options for displaying one or two numeric values as a number, gauge or ticker.
+ * See [Indicator](https://docs.sisense.com/main/SisenseLinux/indicator.htm) for more information.
  */
 class IndicatorChartComponent {
     constructor() {
@@ -919,7 +930,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Scatter Chart Component
+ * A component displaying the distribution of two variables on an X-Axis, Y-Axis,
+ * and two additional fields of data that are shown as colored circles scattered across the chart.
+ *
+ * **Point**: A field that for each of its members a scatter point is drawn. The maximum amount of data points is 500.
+ *
+ * **Size**: An optional field represented by the size of the circles.
+ * If omitted, all scatter points are equal in size. If used, the circle sizes are relative to their values.
+ *
+ * See [Scatter Chart](https://docs.sisense.com/main/SisenseLinux/scatter-chart.htm) for more information.
  */
 class ScatterChartComponent {
     constructor() {
@@ -998,7 +1017,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Pie Chart Component
+ * A component representing data in a circular graph with the data shown as slices of a whole,
+ * with each slice representing a proportion of the total.
+ * See [Pie Chart](https://docs.sisense.com/main/SisenseLinux/pie-chart.htm) for more information.
  */
 class PieChartComponent {
     constructor() {
@@ -1077,7 +1098,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Funnel Chart Component
+ * A component representing data progressively decreasing in size or quantity through a funnel shape.
+ * See [Funnel Chart](https://docs.sisense.com/main/SisenseLinux/funnel-chart.htm) for more information.
  */
 class FunnelChartComponent {
     constructor() {
@@ -1156,7 +1178,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Polar Chart Component
+ * A component comparing multiple categories/variables with a spacial perspective in a radial chart.
+ * See [Polar Chart](https://docs.sisense.com/main/SisenseLinux/polar-chart.htm) for more information.
  */
 class PolarChartComponent {
     constructor() {
@@ -1235,7 +1258,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Treemap Chart Component
+ * A component displaying hierarchical data in the form of nested rectangles.
+ * This type of chart can be used instead of a column chart for comparing a large number of categories and sub-categories.
+ * See [Treemap Chart](https://docs.sisense.com/main/SisenseLinux/treemap.htm) for more information.
  */
 class TreemapChartComponent {
     constructor() {
@@ -1314,7 +1339,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Table Widget Component
+ * The Table Widget component extending {@link TableComponent} component to support widget style options.
  *
  * @internal
  */
@@ -1379,7 +1404,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Dashboard Widget Component
+ * The Dashboard Widget component, which is a thin wrapper on {@link ChartWidgetComponent},
+ * used to render a widget created in the Sisense instance.
  */
 class DashboardWidgetComponent {
     constructor(sisenseContextService, themeService) {
@@ -1563,12 +1589,24 @@ class QueryService {
     constructor(sisenseContextService) {
         this.sisenseContextService = sisenseContextService;
     }
+    /**
+     * Executes a data query.
+     *
+     * @param params - Query parameters
+     * return Query result
+     */
     async executeQuery(params) {
         const { dataSource, dimensions, measures, filters, highlights, count, offset, onBeforeQuery } = params;
         const app = await this.sisenseContextService.getApp();
         const data = await executeQuery({ dataSource, dimensions, measures, filters, highlights, count, offset }, app, { onBeforeQuery });
         return { data };
     }
+    /**
+     * Executes a data query extracted from an existing widget in the Sisense instance.
+     *
+     * @param params - Parameters to identify the target widget
+     * @returns Query result
+     */
     async executeQueryByWidgetId(params) {
         const app = await this.sisenseContextService.getApp();
         return executeQueryByWidgetId({