@sisense/sdk-ui-angular 0.13.0 → 0.14.0

package/dist/lib/components/column-chart.component.d.ts

@@ -3,7 +3,9 @@ import { type ChartType, type ColumnChartProps } from '@sisense/sdk-ui-preact';
 import { type ArgumentsAsObject } from '../utility-types';
 import * as i0 from "@angular/core";
 /**
- * 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.
  */
 export declare class ColumnChartComponent {
     /**
@@ -24,12 +26,17 @@ export declare class ColumnChartComponent {
      * @category Data
      */
     filters: ColumnChartProps['filters'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!ColumnChartProps.highlights}
+     *
+     * @category Data
+     */
+    highlights: ColumnChartProps['highlights'];
     /**
      * {@inheritDoc @sisense/sdk-ui!ColumnChartProps.styleOptions}
      *
      * @category Chart
      */
-    highlights: ColumnChartProps['highlights'];
     styleOptions: ColumnChartProps['styleOptions'];
     /**
      * {@inheritDoc @sisense/sdk-ui!ColumnChartProps.onBeforeRender}

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

@@ -4,7 +4,8 @@ import { SisenseContextService } from '../services/sisense-context.service';
 import { ThemeService } from '../services/theme.service';
 import * as i0 from "@angular/core";
 /**
- * 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.
  */
 export declare class DashboardWidgetComponent implements AfterViewInit, OnChanges, OnDestroy {
     private sisenseContextService;

package/dist/lib/components/funnel-chart.component.d.ts

@@ -3,7 +3,8 @@ import { type ChartType, type FunnelChartProps } from '@sisense/sdk-ui-preact';
 import { type ArgumentsAsObject } from '../utility-types';
 import * as i0 from "@angular/core";
 /**
- * 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.
  */
 export declare class FunnelChartComponent {
     /**

package/dist/lib/components/indicator-chart.component.d.ts

@@ -1,7 +1,8 @@
 import { type ChartType, type IndicatorChartProps } from '@sisense/sdk-ui-preact';
 import * as i0 from "@angular/core";
 /**
- * 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.
  */
 export declare class IndicatorChartComponent {
     /**

package/dist/lib/components/line-chart.component.d.ts

@@ -3,7 +3,8 @@ import { type ChartType, type LineChartProps } from '@sisense/sdk-ui-preact';
 import { type ArgumentsAsObject } from '../utility-types';
 import * as i0 from "@angular/core";
 /**
- * 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.
  */
 export declare class LineChartComponent {
     /**

package/dist/lib/components/pie-chart.component.d.ts

@@ -3,7 +3,9 @@ import { type ChartType, type PieChartProps } from '@sisense/sdk-ui-preact';
 import { type ArgumentsAsObject } from '../utility-types';
 import * as i0 from "@angular/core";
 /**
- * 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.
  */
 export declare class PieChartComponent {
     /**

package/dist/lib/components/polar-chart.component.d.ts

@@ -3,7 +3,8 @@ import { type ChartType, type PolarChartProps } from '@sisense/sdk-ui-preact';
 import { type ArgumentsAsObject } from '../utility-types';
 import * as i0 from "@angular/core";
 /**
- * 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.
  */
 export declare class PolarChartComponent {
     /**

package/dist/lib/components/scatter-chart.component.d.ts

@@ -3,7 +3,15 @@ import { type ChartType, type ScatterChartProps } from '@sisense/sdk-ui-preact';
 import { type ArgumentsAsObject } from '../utility-types';
 import * as i0 from "@angular/core";
 /**
- * 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.
  */
 export declare class ScatterChartComponent {
     /**

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

@@ -4,30 +4,56 @@ import { SisenseContextService } from '../services/sisense-context.service';
 import { ThemeService } from '../services/theme.service';
 import * as i0 from "@angular/core";
 /**
- * Table Widget Component
+ * The Table Widget component extending {@link TableComponent} component to support widget style options.
  *
  * @internal
  */
 export declare class TableWidgetComponent implements AfterViewInit, OnChanges, OnDestroy {
     private sisenseContextService;
     private themeService;
+    /** @internal */
     preactRef: ElementRef<HTMLDivElement>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!TableWidgetProps.dataSource}
+     *
+     * @category Data
+     */
     dataSource: TableWidgetProps['dataSource'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!TableWidgetProps.dataOptions}
+     *
+     * @category Data
+     */
     dataOptions: TableWidgetProps['dataOptions'];
     /**
-     * {@inheritDoc @sisense/sdk-ui!ChartProps.filters}
+     * {@inheritDoc @sisense/sdk-ui!TableWidgetProps.filters}
      *
      * @category Data
      */
     filters: TableWidgetProps['filters'];
     /**
-     * {@inheritDoc @sisense/sdk-ui!ChartProps.styleOptions}
+     * {@inheritDoc @sisense/sdk-ui!TableWidgetProps.styleOptions}
      *
      * @category Representation
      */
     styleOptions: TableWidgetProps['styleOptions'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!TableWidgetProps.widgetStyleOptions}
+     *
+     * @category Representation
+     */
     widgetStyleOptions: TableWidgetProps['widgetStyleOptions'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!TableWidgetProps.title}
+     *
+     * @category Widget
+     */
     title: TableWidgetProps['title'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!TableWidgetProps.description}
+     *
+     * @category Widget
+     */
     description: TableWidgetProps['description'];
     private componentAdapter;
     constructor(sisenseContextService: SisenseContextService, themeService: ThemeService);

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

@@ -4,7 +4,7 @@ import { SisenseContextService } from '../services/sisense-context.service';
 import { ThemeService } from '../services/theme.service';
 import * as i0 from "@angular/core";
 /**
- * Table Component
+ * Table with aggregation and pagination.
  */
 export declare class TableComponent implements AfterViewInit, OnChanges, OnDestroy {
     private sisenseContextService;
@@ -12,25 +12,25 @@ export declare class TableComponent implements AfterViewInit, OnChanges, OnDestr
     /** @internal */
     preactRef: ElementRef<HTMLDivElement>;
     /**
-     * {@inheritDoc @sisense/sdk-ui!ChartProps.dataSet}
+     * {@inheritDoc @sisense/sdk-ui!TableProps.dataSet}
      *
      * @category Data
      */
     dataSet: TableProps['dataSet'];
     /**
-     * {@inheritDoc @sisense/sdk-ui!ChartProps.highlights}
+     * {@inheritDoc @sisense/sdk-ui!TableProps.dataOptions}
      *
      * @category Data
      */
     dataOptions: TableProps['dataOptions'];
     /**
-     * {@inheritDoc @sisense/sdk-ui!ChartProps.filters}
+     * {@inheritDoc @sisense/sdk-ui!TableProps.filters}
      *
      * @category Data
      */
     filters: TableProps['filters'];
     /**
-     * {@inheritDoc @sisense/sdk-ui!ChartProps.styleOptions}
+     * {@inheritDoc @sisense/sdk-ui!TableProps.styleOptions}
      *
      * @category Representation
      */

package/dist/lib/components/treemap-chart.component.d.ts

@@ -3,7 +3,9 @@ import { type ChartType, type TreemapChartProps } from '@sisense/sdk-ui-preact';
 import { type ArgumentsAsObject } from '../utility-types';
 import * as i0 from "@angular/core";
 /**
- * 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.
  */
 export declare class TreemapChartComponent {
     /**

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

@@ -4,9 +4,21 @@ import * as i0 from "@angular/core";
 export declare class QueryService {
     private sisenseContextService;
     constructor(sisenseContextService: SisenseContextService);
+    /**
+     * Executes a data query.
+     *
+     * @param params - Query parameters
+     * return Query result
+     */
     executeQuery(params: ExecuteQueryParams): Promise<{
         data: import("@sisense/sdk-data").QueryResultData;
     }>;
+    /**
+     * Executes a data query extracted from an existing widget in the Sisense instance.
+     *
+     * @param params - Parameters to identify the target widget
+     * @returns Query result
+     */
     executeQueryByWidgetId(params: ExecuteQueryByWidgetIdParams): Promise<{
         data: import("@sisense/sdk-data").QueryResultData;
         query: ExecuteQueryParams;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-ui-angular",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "type": "module",
   "main": "./dist",
   "module": "fesm2015/sisense-sdk-ui-angular.mjs",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-ui-angular",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "type": "module",
   "main": "./dist",
   "module": "./dist",
@@ -28,7 +28,7 @@
     "@angular/core": "^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@sisense/sdk-ui-preact": "^0.13.0",
+    "@sisense/sdk-ui-preact": "^0.14.0",
     "rxjs": "^7.8.1",
     "ts-deepmerge": "^6.2.0",
     "tslib": "^2.3.0"
@@ -40,7 +40,7 @@
     "@angular/compiler": "^15.2.0",
     "@angular/compiler-cli": "^15.2.0",
     "@angular/core": "^15.2.0",
-    "@sisense/sdk-data": "^0.13.0",
+    "@sisense/sdk-data": "^0.14.0",
     "eslint": "^8.40.0",
     "ng-packagr": "^15.2.2",
     "prettier": "2.8.4",