@sisense/sdk-ui-angular 0.13.0 → 0.14.0

package/dist/esm2020/lib/services/query.service.mjs

@@ -6,12 +6,24 @@ export 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({
@@ -28,4 +40,4 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                     providedIn: 'root',
                 }]
         }], ctorParameters: function () { return [{ type: i1.SisenseContextService }]; } });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVlcnkuc2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvc2VydmljZXMvcXVlcnkuc2VydmljZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sZUFBZSxDQUFDO0FBQzNDLE9BQU8sRUFDTCxZQUFZLEVBQ1osc0JBQXNCLEdBR3ZCLE1BQU0sd0JBQXdCLENBQUM7OztBQU1oQyxNQUFNLE9BQU8sWUFBWTtJQUN2QixZQUFvQixxQkFBNEM7UUFBNUMsMEJBQXFCLEdBQXJCLHFCQUFxQixDQUF1QjtJQUFHLENBQUM7SUFFcEUsS0FBSyxDQUFDLFlBQVksQ0FBQyxNQUEwQjtRQUMzQyxNQUFNLEVBQUUsVUFBVSxFQUFFLFVBQVUsRUFBRSxRQUFRLEVBQUUsT0FBTyxFQUFFLFVBQVUsRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLGFBQWEsRUFBRSxHQUMzRixNQUFNLENBQUM7UUFDVCxNQUFNLEdBQUcsR0FBRyxNQUFNLElBQUksQ0FBQyxxQkFBcUIsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUN0RCxNQUFNLElBQUksR0FBRyxNQUFNLFlBQVksQ0FDN0IsRUFBRSxVQUFVLEVBQUUsVUFBVSxFQUFFLFFBQVEsRUFBRSxPQUFPLEVBQUUsVUFBVSxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsRUFDeEUsR0FBRyxFQUNILEVBQUUsYUFBYSxFQUFFLENBQ2xCLENBQUM7UUFFRixPQUFPLEVBQUUsSUFBSSxFQUFFLENBQUM7SUFDbEIsQ0FBQztJQUVELEtBQUssQ0FBQyxzQkFBc0IsQ0FBQyxNQUFvQztRQUMvRCxNQUFNLEdBQUcsR0FBRyxNQUFNLElBQUksQ0FBQyxxQkFBcUIsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUV0RCxPQUFPLHNCQUFzQixDQUFDO1lBQzVCLEdBQUcsTUFBTTtZQUNULEdBQUc7U0FDSixDQUFDLENBQUM7SUFDTCxDQUFDOzswR0F2QlUsWUFBWTs4R0FBWixZQUFZLGNBRlgsTUFBTTs0RkFFUCxZQUFZO2tCQUh4QixVQUFVO21CQUFDO29CQUNWLFVBQVUsRUFBRSxNQUFNO2lCQUNuQiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEluamVjdGFibGUgfSBmcm9tICdAYW5ndWxhci9jb3JlJztcbmltcG9ydCB7XG4gIGV4ZWN1dGVRdWVyeSxcbiAgZXhlY3V0ZVF1ZXJ5QnlXaWRnZXRJZCxcbiAgdHlwZSBFeGVjdXRlUXVlcnlQYXJhbXMsXG4gIHR5cGUgRXhlY3V0ZVF1ZXJ5QnlXaWRnZXRJZFBhcmFtcyxcbn0gZnJvbSAnQHNpc2Vuc2Uvc2RrLXVpLXByZWFjdCc7XG5pbXBvcnQgeyBTaXNlbnNlQ29udGV4dFNlcnZpY2UgfSBmcm9tICcuL3Npc2Vuc2UtY29udGV4dC5zZXJ2aWNlJztcblxuQEluamVjdGFibGUoe1xuICBwcm92aWRlZEluOiAncm9vdCcsXG59KVxuZXhwb3J0IGNsYXNzIFF1ZXJ5U2VydmljZSB7XG4gIGNvbnN0cnVjdG9yKHByaXZhdGUgc2lzZW5zZUNvbnRleHRTZXJ2aWNlOiBTaXNlbnNlQ29udGV4dFNlcnZpY2UpIHt9XG5cbiAgYXN5bmMgZXhlY3V0ZVF1ZXJ5KHBhcmFtczogRXhlY3V0ZVF1ZXJ5UGFyYW1zKSB7XG4gICAgY29uc3QgeyBkYXRhU291cmNlLCBkaW1lbnNpb25zLCBtZWFzdXJlcywgZmlsdGVycywgaGlnaGxpZ2h0cywgY291bnQsIG9mZnNldCwgb25CZWZvcmVRdWVyeSB9ID1cbiAgICAgIHBhcmFtcztcbiAgICBjb25zdCBhcHAgPSBhd2FpdCB0aGlzLnNpc2Vuc2VDb250ZXh0U2VydmljZS5nZXRBcHAoKTtcbiAgICBjb25zdCBkYXRhID0gYXdhaXQgZXhlY3V0ZVF1ZXJ5KFxuICAgICAgeyBkYXRhU291cmNlLCBkaW1lbnNpb25zLCBtZWFzdXJlcywgZmlsdGVycywgaGlnaGxpZ2h0cywgY291bnQsIG9mZnNldCB9LFxuICAgICAgYXBwLFxuICAgICAgeyBvbkJlZm9yZVF1ZXJ5IH0sXG4gICAgKTtcblxuICAgIHJldHVybiB7IGRhdGEgfTtcbiAgfVxuXG4gIGFzeW5jIGV4ZWN1dGVRdWVyeUJ5V2lkZ2V0SWQocGFyYW1zOiBFeGVjdXRlUXVlcnlCeVdpZGdldElkUGFyYW1zKSB7XG4gICAgY29uc3QgYXBwID0gYXdhaXQgdGhpcy5zaXNlbnNlQ29udGV4dFNlcnZpY2UuZ2V0QXBwKCk7XG5cbiAgICByZXR1cm4gZXhlY3V0ZVF1ZXJ5QnlXaWRnZXRJZCh7XG4gICAgICAuLi5wYXJhbXMsXG4gICAgICBhcHAsXG4gICAgfSk7XG4gIH1cbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVlcnkuc2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvc2VydmljZXMvcXVlcnkuc2VydmljZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sZUFBZSxDQUFDO0FBQzNDLE9BQU8sRUFDTCxZQUFZLEVBQ1osc0JBQXNCLEdBR3ZCLE1BQU0sd0JBQXdCLENBQUM7OztBQU1oQyxNQUFNLE9BQU8sWUFBWTtJQUN2QixZQUFvQixxQkFBNEM7UUFBNUMsMEJBQXFCLEdBQXJCLHFCQUFxQixDQUF1QjtJQUFHLENBQUM7SUFFcEU7Ozs7O09BS0c7SUFDSCxLQUFLLENBQUMsWUFBWSxDQUFDLE1BQTBCO1FBQzNDLE1BQU0sRUFBRSxVQUFVLEVBQUUsVUFBVSxFQUFFLFFBQVEsRUFBRSxPQUFPLEVBQUUsVUFBVSxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsYUFBYSxFQUFFLEdBQzNGLE1BQU0sQ0FBQztRQUNULE1BQU0sR0FBRyxHQUFHLE1BQU0sSUFBSSxDQUFDLHFCQUFxQixDQUFDLE1BQU0sRUFBRSxDQUFDO1FBQ3RELE1BQU0sSUFBSSxHQUFHLE1BQU0sWUFBWSxDQUM3QixFQUFFLFVBQVUsRUFBRSxVQUFVLEVBQUUsUUFBUSxFQUFFLE9BQU8sRUFBRSxVQUFVLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRSxFQUN4RSxHQUFHLEVBQ0gsRUFBRSxhQUFhLEVBQUUsQ0FDbEIsQ0FBQztRQUVGLE9BQU8sRUFBRSxJQUFJLEVBQUUsQ0FBQztJQUNsQixDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxLQUFLLENBQUMsc0JBQXNCLENBQUMsTUFBb0M7UUFDL0QsTUFBTSxHQUFHLEdBQUcsTUFBTSxJQUFJLENBQUMscUJBQXFCLENBQUMsTUFBTSxFQUFFLENBQUM7UUFFdEQsT0FBTyxzQkFBc0IsQ0FBQztZQUM1QixHQUFHLE1BQU07WUFDVCxHQUFHO1NBQ0osQ0FBQyxDQUFDO0lBQ0wsQ0FBQzs7MEdBbkNVLFlBQVk7OEdBQVosWUFBWSxjQUZYLE1BQU07NEZBRVAsWUFBWTtrQkFIeEIsVUFBVTttQkFBQztvQkFDVixVQUFVLEVBQUUsTUFBTTtpQkFDbkIiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBJbmplY3RhYmxlIH0gZnJvbSAnQGFuZ3VsYXIvY29yZSc7XG5pbXBvcnQge1xuICBleGVjdXRlUXVlcnksXG4gIGV4ZWN1dGVRdWVyeUJ5V2lkZ2V0SWQsXG4gIHR5cGUgRXhlY3V0ZVF1ZXJ5UGFyYW1zLFxuICB0eXBlIEV4ZWN1dGVRdWVyeUJ5V2lkZ2V0SWRQYXJhbXMsXG59IGZyb20gJ0BzaXNlbnNlL3Nkay11aS1wcmVhY3QnO1xuaW1wb3J0IHsgU2lzZW5zZUNvbnRleHRTZXJ2aWNlIH0gZnJvbSAnLi9zaXNlbnNlLWNvbnRleHQuc2VydmljZSc7XG5cbkBJbmplY3RhYmxlKHtcbiAgcHJvdmlkZWRJbjogJ3Jvb3QnLFxufSlcbmV4cG9ydCBjbGFzcyBRdWVyeVNlcnZpY2Uge1xuICBjb25zdHJ1Y3Rvcihwcml2YXRlIHNpc2Vuc2VDb250ZXh0U2VydmljZTogU2lzZW5zZUNvbnRleHRTZXJ2aWNlKSB7fVxuXG4gIC8qKlxuICAgKiBFeGVjdXRlcyBhIGRhdGEgcXVlcnkuXG4gICAqXG4gICAqIEBwYXJhbSBwYXJhbXMgLSBRdWVyeSBwYXJhbWV0ZXJzXG4gICAqIHJldHVybiBRdWVyeSByZXN1bHRcbiAgICovXG4gIGFzeW5jIGV4ZWN1dGVRdWVyeShwYXJhbXM6IEV4ZWN1dGVRdWVyeVBhcmFtcykge1xuICAgIGNvbnN0IHsgZGF0YVNvdXJjZSwgZGltZW5zaW9ucywgbWVhc3VyZXMsIGZpbHRlcnMsIGhpZ2hsaWdodHMsIGNvdW50LCBvZmZzZXQsIG9uQmVmb3JlUXVlcnkgfSA9XG4gICAgICBwYXJhbXM7XG4gICAgY29uc3QgYXBwID0gYXdhaXQgdGhpcy5zaXNlbnNlQ29udGV4dFNlcnZpY2UuZ2V0QXBwKCk7XG4gICAgY29uc3QgZGF0YSA9IGF3YWl0IGV4ZWN1dGVRdWVyeShcbiAgICAgIHsgZGF0YVNvdXJjZSwgZGltZW5zaW9ucywgbWVhc3VyZXMsIGZpbHRlcnMsIGhpZ2hsaWdodHMsIGNvdW50LCBvZmZzZXQgfSxcbiAgICAgIGFwcCxcbiAgICAgIHsgb25CZWZvcmVRdWVyeSB9LFxuICAgICk7XG5cbiAgICByZXR1cm4geyBkYXRhIH07XG4gIH1cblxuICAvKipcbiAgICogRXhlY3V0ZXMgYSBkYXRhIHF1ZXJ5IGV4dHJhY3RlZCBmcm9tIGFuIGV4aXN0aW5nIHdpZGdldCBpbiB0aGUgU2lzZW5zZSBpbnN0YW5jZS5cbiAgICpcbiAgICogQHBhcmFtIHBhcmFtcyAtIFBhcmFtZXRlcnMgdG8gaWRlbnRpZnkgdGhlIHRhcmdldCB3aWRnZXRcbiAgICogQHJldHVybnMgUXVlcnkgcmVzdWx0XG4gICAqL1xuICBhc3luYyBleGVjdXRlUXVlcnlCeVdpZGdldElkKHBhcmFtczogRXhlY3V0ZVF1ZXJ5QnlXaWRnZXRJZFBhcmFtcykge1xuICAgIGNvbnN0IGFwcCA9IGF3YWl0IHRoaXMuc2lzZW5zZUNvbnRleHRTZXJ2aWNlLmdldEFwcCgpO1xuXG4gICAgcmV0dXJuIGV4ZWN1dGVRdWVyeUJ5V2lkZ2V0SWQoe1xuICAgICAgLi4ucGFyYW1zLFxuICAgICAgYXBwLFxuICAgIH0pO1xuICB9XG59XG4iXX0=

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

@@ -406,7 +406,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
             }] } });
 
 /**
- * Table Component
+ * Table with aggregation and pagination.
  */
 class TableComponent {
     constructor(sisenseContextService, themeService) {
@@ -463,7 +463,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) {
@@ -515,6 +515,7 @@ class ChartWidgetComponent {
             drilldownOptions: this.drilldownOptions,
             title: this.title,
             description: this.description,
+            highlightSelectionDisabled: this.highlightSelectionDisabled,
             onBeforeRender: (_a = this.beforeRender) === null || _a === void 0 ? void 0 : _a.bind(this),
             onDataPointClick: (...[point, nativeEvent]) => this.dataPointClick.emit({ point, nativeEvent }),
             onDataPointContextMenu: (...[point, nativeEvent]) => this.dataPointContextMenu.emit({ point, nativeEvent }),
@@ -528,7 +529,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: [{
@@ -558,6 +559,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 type: Input
             }], description: [{
                 type: Input
+            }], highlightSelectionDisabled: [{
+                type: Input
             }], beforeRender: [{
                 type: Input
             }], dataPointClick: [{
@@ -569,7 +572,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() {
@@ -648,7 +653,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() {
@@ -727,7 +734,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() {
@@ -806,7 +815,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() {
@@ -885,7 +895,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() {
@@ -930,7 +941,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() {
@@ -1009,7 +1028,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() {
@@ -1088,7 +1109,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() {
@@ -1167,7 +1189,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() {
@@ -1246,7 +1269,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() {
@@ -1325,7 +1350,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
  */
@@ -1390,7 +1415,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) {
@@ -1574,6 +1600,12 @@ class QueryService {
     constructor(sisenseContextService) {
         this.sisenseContextService = sisenseContextService;
     }
+    /**
+     * Executes a data query.
+     *
+     * @param params - Query parameters
+     * return Query result
+     */
     executeQuery(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const { dataSource, dimensions, measures, filters, highlights, count, offset, onBeforeQuery } = params;
@@ -1582,6 +1614,12 @@ class QueryService {
             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
+     */
     executeQueryByWidgetId(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const app = yield this.sisenseContextService.getApp();