@sisense/sdk-ui-angular 2.17.0 → 2.18.0

package/dist/lib/components/charts/pivot-table.component.d.ts

@@ -1,12 +1,13 @@
-import { AfterViewInit, ElementRef, OnChanges, OnDestroy } from '@angular/core';
+import { AfterViewInit, ElementRef, EventEmitter, OnChanges, OnDestroy } from '@angular/core';
 import { type PivotTableProps as PivotTablePropsPreact } from '@sisense/sdk-ui-preact';
 import { SisenseContextService } from '../../services';
 import { ThemeService } from '../../services';
+import type { PivotTableDataPointEvent, PivotTableEventProps, WithoutPreactChartEventProps } from '../../types';
 import * as i0 from "@angular/core";
 /**
  * Props of the {@link PivotTableComponent}.
  */
-export interface PivotTableProps extends PivotTablePropsPreact {
+export interface PivotTableProps extends WithoutPreactChartEventProps<PivotTablePropsPreact>, PivotTableEventProps {
 }
 /**
  * Pivot Table with and pagination.
@@ -104,6 +105,18 @@ export declare class PivotTableComponent implements AfterViewInit, OnChanges, On
      * @category Representation
      */
     styleOptions: PivotTableProps['styleOptions'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableProps.onDataPointClick}
+     *
+     * @category Callbacks
+     */
+    dataPointClick: EventEmitter<PivotTableDataPointEvent>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableProps.onDataPointContextMenu}
+     *
+     * @category Callbacks
+     */
+    dataPointContextMenu: EventEmitter<PivotTableDataPointEvent>;
     private componentAdapter;
     constructor(sisenseContextService: SisenseContextService, themeService: ThemeService);
     /** @internal */
@@ -114,5 +127,5 @@ export declare class PivotTableComponent implements AfterViewInit, OnChanges, On
     /** @internal */
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<PivotTableComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<PivotTableComponent, "csdk-pivot-table", never, { "dataSet": "dataSet"; "dataOptions": "dataOptions"; "filters": "filters"; "highlights": "highlights"; "styleOptions": "styleOptions"; }, {}, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<PivotTableComponent, "csdk-pivot-table", never, { "dataSet": "dataSet"; "dataOptions": "dataOptions"; "filters": "filters"; "highlights": "highlights"; "styleOptions": "styleOptions"; }, { "dataPointClick": "dataPointClick"; "dataPointContextMenu": "dataPointContextMenu"; }, never, never, false, never>;
 }

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

@@ -1,12 +1,13 @@
-import { AfterViewInit, ElementRef, OnChanges, OnDestroy } from '@angular/core';
+import { AfterViewInit, ElementRef, EventEmitter, OnChanges, OnDestroy } from '@angular/core';
 import { type PivotTableWidgetProps as PivotTableWidgetPropsPreact } from '@sisense/sdk-ui-preact';
 import { SisenseContextService } from '../../services';
 import { ThemeService } from '../../services';
+import type { PivotTableDataPointEvent, PivotTableEventProps, WithoutPreactChartEventProps } from '../../types';
 import * as i0 from "@angular/core";
 /**
  * Props of the {@link PivotTableWidgetComponent}.
  */
-export interface PivotTableWidgetProps extends Omit<PivotTableWidgetPropsPreact, 'onDataPointClick' | 'onDataPointContextMenu'> {
+export interface PivotTableWidgetProps extends WithoutPreactChartEventProps<PivotTableWidgetPropsPreact>, PivotTableEventProps {
 }
 /**
  * The Pivot Table Widget component extends the {@link PivotTableComponent} component to support widget features,
@@ -100,6 +101,12 @@ export declare class PivotTableWidgetComponent implements AfterViewInit, OnChang
      * @category Representation
      */
     styleOptions: PivotTableWidgetProps['styleOptions'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableWidgetProps.drilldownOptions}
+     *
+     * @category Widget
+     */
+    drilldownOptions: PivotTableWidgetProps['drilldownOptions'];
     /**
      * {@inheritDoc @sisense/sdk-ui!PivotTableWidgetProps.title}
      *
@@ -112,6 +119,18 @@ export declare class PivotTableWidgetComponent implements AfterViewInit, OnChang
      * @category Widget
      */
     description: PivotTableWidgetProps['description'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableWidgetProps.onDataPointClick}
+     *
+     * @category Callbacks
+     */
+    dataPointClick: EventEmitter<PivotTableDataPointEvent>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableWidgetProps.onDataPointContextMenu}
+     *
+     * @category Callbacks
+     */
+    dataPointContextMenu: EventEmitter<PivotTableDataPointEvent>;
     private componentAdapter;
     constructor(sisenseContextService: SisenseContextService, themeService: ThemeService);
     /** @internal */
@@ -122,5 +141,5 @@ export declare class PivotTableWidgetComponent implements AfterViewInit, OnChang
     /** @internal */
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<PivotTableWidgetComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<PivotTableWidgetComponent, "csdk-pivot-table-widget", never, { "dataSource": "dataSource"; "dataOptions": "dataOptions"; "filters": "filters"; "highlights": "highlights"; "styleOptions": "styleOptions"; "title": "title"; "description": "description"; }, {}, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<PivotTableWidgetComponent, "csdk-pivot-table-widget", never, { "dataSource": "dataSource"; "dataOptions": "dataOptions"; "filters": "filters"; "highlights": "highlights"; "styleOptions": "styleOptions"; "drilldownOptions": "drilldownOptions"; "title": "title"; "description": "description"; }, { "dataPointClick": "dataPointClick"; "dataPointContextMenu": "dataPointContextMenu"; }, never, never, false, never>;
 }

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

@@ -3,7 +3,7 @@ import { type BeforeMenuOpenHandler, CustomWidgetProps, type SoftUnion, TextWidg
 import { SisenseContextService } from '../../services/sisense-context.service';
 import { ThemeService } from '../../services/theme.service';
 import { TextWidgetEventProps, WithoutPreactChartEventProps } from '../../types';
-import { ChartDataPointClickEvent, ChartDataPointContextMenuEvent, ChartDataPointsEvent } from '../../types/data-point';
+import { ChartDataPointsEvent, ChartDataPointsEventHandler, WidgetDataPointClickEvent, WidgetDataPointClickEventHandler, WidgetDataPointContextMenuEvent, WidgetDataPointContextMenuEventHandler } from '../../types/data-point';
 import { ChartWidgetProps } from './chart-widget.component';
 import { PivotTableWidgetProps } from './pivot-table-widget.component';
 import * as i0 from "@angular/core";
@@ -35,7 +35,11 @@ export type WithCommonWidgetProps<BaseWidget, Type> = BaseWidget & {
 /**
  * Props of the {@link WidgetComponent}.
  */
-export type WidgetProps = SoftUnion<WithCommonWidgetProps<ChartWidgetProps, 'chart'> | WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'> | WithCommonWidgetProps<TextWidgetProps, 'text'> | WithCommonWidgetProps<CustomWidgetProps, 'custom'>>;
+export type WidgetProps = SoftUnion<WithCommonWidgetProps<ChartWidgetProps, 'chart'> | WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'> | WithCommonWidgetProps<TextWidgetProps, 'text'> | WithCommonWidgetProps<CustomWidgetProps, 'custom'>> & {
+    dataPointClick?: WidgetDataPointClickEventHandler;
+    dataPointContextMenu?: WidgetDataPointContextMenuEventHandler;
+    dataPointsSelect?: ChartDataPointsEventHandler;
+};
 /**
  * Facade component that renders a widget within a dashboard based on the widget type.
  *
@@ -188,13 +192,13 @@ export declare class WidgetComponent implements AfterViewInit, OnChanges, OnDest
      *
      * @category Callbacks
      */
-    dataPointClick: EventEmitter<ChartDataPointClickEvent>;
+    dataPointClick: EventEmitter<WidgetDataPointClickEvent>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointContextMenu}
      *
      * @category Callbacks
      */
-    dataPointContextMenu: EventEmitter<ChartDataPointContextMenuEvent>;
+    dataPointContextMenu: EventEmitter<WidgetDataPointContextMenuEvent>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointsSelected}
      *

package/dist/lib/sdk-ui-core-exports.d.ts

@@ -1,2 +1,2 @@
 export { boxWhiskerProcessResult, extractDimensionsAndMeasures } from '@sisense/sdk-ui-preact';
-export type { AppConfig, AreamapChartDataOptions, AreamapChartType, AreamapStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, AreaSubtype, AxisLabel, BeforeRenderHandler, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, BoxplotChartType, BoxplotDataPoint, BoxplotStyleOptions, BoxplotSubtype, BoxWhiskerType, CalendarDayOfWeek, CalendarHeatmapChartDataOptions, CalendarHeatmapChartType, CalendarHeatmapDataPoint, CalendarHeatmapStyleOptions, CalendarHeatmapSubtype, CalendarHeatmapViewType, CartesianChartDataOptions, CartesianChartType, CartesianWidgetType, CategoricalChartDataOptions, CategoricalChartType, CategoricalWidgetType, ChartDataOptions, ChartStyleOptions, ChartType, ChartWidgetStyleOptions, Color, ColorPaletteTheme, CommonWidgetProps, ConditionalDataColorOptions, Convolution, DashboardLayoutOptions, DashboardModel, DashStyle, DataColorCondition, DataColorOptions, DataLimits, DataPoint, DateConfig, DateLevel, DayOfWeek, DecimalScale, DrilldownOptions, DrilldownSelection, EndCapType, FilterVariant, FunnelStyleOptions, GaugeIndicatorStyleOptions, GetDashboardModelOptions, GetDashboardModelsOptions, Hierarchy, HierarchyModel, HighchartsOptions, IndicatorBeforeRenderHandler, IndicatorChartDataOptions, IndicatorChartType, IndicatorComponents, IndicatorDataPoint, IndicatorRenderOptions, IndicatorStyleOptions, Labels, Legend, LineOptions, LineStyleOptions, LineSubtype, LineWidth, Markers, Member, MenuItemSection, MenuPosition, MonthOfYear, MultiColumnValueToColorMap, Navigator, NumberFormatConfig, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, PieStyleOptions, PieSubtype, PivotRowsSort, PivotTableDataOptions, PivotTableStyleOptions, PivotTableWidgetStyleOptions, PolarStyleOptions, PolarSubtype, RangeChartDataOptions, RangeChartType, RangeDataColorOptions, ScatterChartDataOptions, ScatterChartType, ScatterDataPoint, ScattermapChartDataOptions, ScattermapChartType, ScattermapLocationLevel, ScattermapMarkers, ScattermapStyleOptions, ScatterMarkerSize, ScatterStyleOptions, SeriesChartType, SeriesLabels, SortDirection, StackableStyleOptions, StackableSubtype, StyledColumn, StyledMeasureColumn, StreamgraphStyleOptions, SunburstStyleOptions, TableDataOptions, TableStyleOptions, TableType, TabularWidgetType, ThemeOid, ThemeSettings, TranslationConfig, TreemapStyleOptions, UniformDataColorOptions, ValueToColorMap, WidgetByIdStyleOptions, WidgetDataOptions, WidgetId, WidgetModel, WidgetsOptions, WidgetsPanelColumnLayout, WidgetsPanelLayout, WidgetStyleOptions, WidgetType, X2Title, } from '@sisense/sdk-ui-preact';
+export type { AppConfig, AreamapChartDataOptions, AreamapChartType, AreamapStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, AreaSubtype, AxisLabel, BeforeRenderHandler, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, BoxplotChartType, BoxplotDataPoint, BoxplotStyleOptions, BoxplotSubtype, BoxWhiskerType, CalendarDayOfWeek, CalendarHeatmapChartDataOptions, CalendarHeatmapChartType, CalendarHeatmapDataPoint, CalendarHeatmapStyleOptions, CalendarHeatmapSubtype, CalendarHeatmapViewType, CartesianChartDataOptions, CartesianChartType, CartesianWidgetType, CategoricalChartDataOptions, CategoricalChartType, CategoricalWidgetType, ChartDataOptions, ChartStyleOptions, ChartType, ChartWidgetStyleOptions, Color, ColorPaletteTheme, CommonWidgetProps, ConditionalDataColorOptions, Convolution, DashboardLayoutOptions, DashboardModel, DashStyle, DataColorCondition, DataColorOptions, DataLimits, DataOptionLocation, DataPoint, DateConfig, DateLevel, DayOfWeek, DecimalScale, DrilldownOptions, DrilldownSelection, EndCapType, FilterVariant, FunnelStyleOptions, GaugeIndicatorStyleOptions, GetDashboardModelOptions, GetDashboardModelsOptions, Hierarchy, HierarchyModel, HighchartsOptions, IndicatorBeforeRenderHandler, IndicatorChartDataOptions, IndicatorChartType, IndicatorComponents, IndicatorDataPoint, IndicatorRenderOptions, IndicatorStyleOptions, Labels, Legend, LineOptions, LineStyleOptions, LineSubtype, LineWidth, Markers, Member, MenuItemSection, MenuPosition, MonthOfYear, MultiColumnValueToColorMap, Navigator, NumberFormatConfig, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, PieStyleOptions, PieSubtype, PivotRowsSort, PivotTableDataOptions, PivotTableDrilldownOptions, PivotTableNonSelectableDrilldownOptions, PivotTableSelectableDrilldownOptions, PivotTableStyleOptions, PivotTableWidgetStyleOptions, PolarStyleOptions, PolarSubtype, RangeChartDataOptions, RangeChartType, RangeDataColorOptions, ScatterChartDataOptions, ScatterChartType, ScatterDataPoint, ScattermapChartDataOptions, ScattermapChartType, ScattermapLocationLevel, ScattermapMarkers, ScattermapStyleOptions, ScatterMarkerSize, ScatterStyleOptions, SeriesChartType, SeriesLabels, SortDirection, StackableStyleOptions, StackableSubtype, StyledColumn, StyledMeasureColumn, StreamgraphStyleOptions, SunburstStyleOptions, TableDataOptions, TableStyleOptions, TableType, TabularWidgetType, ThemeOid, ThemeSettings, TranslationConfig, TreemapStyleOptions, UniformDataColorOptions, ValueToColorMap, WidgetByIdStyleOptions, WidgetDataOptions, WidgetId, JumpToDashboardConfig, JumpToDashboardConfigForPivot, WidgetModel, WidgetsOptions, WidgetsPanelColumnLayout, WidgetsPanelLayout, WidgetStyleOptions, WidgetType, X2Title, } from '@sisense/sdk-ui-preact';

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

@@ -71,7 +71,7 @@ export declare class DashboardService {
      *
      * ```ts
       // Component behavior in example.component.ts
-      import { Component } from '@angular/core';
+      import { Component, OnDestroy } from '@angular/core';
       import { BehaviorSubject } from 'rxjs';
       import { DashboardService, type DashboardProps } from '@sisense/sdk-ui-angular';
   
@@ -80,15 +80,20 @@ export declare class DashboardService {
         templateUrl: './example.component.html',
         styleUrls: ['./example.component.scss'],
       })
-      export class ExampleComponent {
+      export class ExampleComponent implements OnDestroy {
         dashboard$: BehaviorSubject<DashboardProps> | undefined;
+        private composedDashboard: ReturnType<DashboardService['createComposedDashboard']> | undefined;
   
         constructor(private dashboardService: DashboardService) {}
   
         ngOnInit() {
           const initialDashboard: DashboardProps = { ... };
-          const composedDashboard = this.dashboardService.createComposedDashboard(initialDashboard);
-          this.dashboard$ = composedDashboard.dashboard$;
+          this.composedDashboard = this.dashboardService.createComposedDashboard(initialDashboard);
+          this.dashboard$ = this.composedDashboard.dashboard$;
+        }
+  
+        ngOnDestroy() {
+          this.composedDashboard?.destroy();
         }
   
         trackByIndex = (index: number) => index;
@@ -98,12 +103,15 @@ export declare class DashboardService {
      * ```
      * @param initialDashboard - Initial dashboard
      * @param options - Configuration options
-     * @returns Reactive composed dashboard object and API methods for interacting with it
+     * @returns Reactive composed dashboard object and API methods for interacting with it.
+     * The returned object includes a `destroy()` method that should be called when
+     * the dashboard is no longer needed to prevent memory leaks (e.g., in `ngOnDestroy`).
      */
     createComposedDashboard<D extends ComposableDashboardProps | DashboardProps>(initialDashboard: D, options?: UseComposedDashboardOptions): {
         dashboard$: BehaviorSubject<D>;
         setFilters: (filters: Filter[] | FilterRelations) => Promise<void>;
         setWidgetsLayout: (newLayout: WidgetsPanelLayout) => Promise<void>;
+        destroy: () => void;
     };
     static ɵfac: i0.ɵɵFactoryDeclaration<DashboardService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<DashboardService>;

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

@@ -1,5 +1,8 @@
-import { type GetWidgetModelParams as GetWidgetModelParamsPreact } from '@sisense/sdk-ui-preact';
+import { type GetWidgetModelParams as GetWidgetModelParamsPreact, type JumpToDashboardConfig, type JumpToDashboardConfigForPivot } from '@sisense/sdk-ui-preact';
+import { BehaviorSubject } from 'rxjs';
+import { type WidgetProps } from '../components/widgets/widget.component';
 import { SisenseContextService } from './sisense-context.service';
+import { ThemeService } from './theme.service';
 import * as i0 from "@angular/core";
 /**
  * Parameters for retrieving an existing widget model from the Sisense instance
@@ -14,7 +17,8 @@ export interface GetWidgetModelParams extends Omit<GetWidgetModelParamsPreact, '
  */
 export declare class WidgetService {
     private sisenseContextService;
-    constructor(sisenseContextService: SisenseContextService);
+    private themeService;
+    constructor(sisenseContextService: SisenseContextService, themeService: ThemeService);
     /**
      * Retrieves an existing widget model from the Sisense instance.
      *
@@ -22,6 +26,100 @@ export declare class WidgetService {
      * @returns Widget model
      */
     getWidgetModel(params: GetWidgetModelParams): Promise<import("@sisense/sdk-ui-preact").WidgetModel>;
+    /**
+     * Adds Jump To Dashboard (JTD) functionality to widget props.
+     *
+     * Jump To Dashboard (JTD) allows users to navigate from one dashboard to another when interacting with widgets,
+     * such as clicking on chart data points or using context menus. This method is particularly useful when rendering
+     * Widget components directly (not through a Dashboard component), but you still want JTD navigation functionality.
+     *
+     * For widgets that are part of a dashboard, consider using `applyJtdConfig` or `applyJtdConfigs` instead,
+     * as they apply JTD configuration at the dashboard level rather than individual widget level.
+     *
+     * Note: dashboard-only 'includeDashboardFilters' is not supported and would just be ignored, since we do not have a dashboard in the current context.
+     *
+     * This method enhances the provided widget props with JTD navigation capabilities, including:
+     * - Click and right-click event handlers for navigation
+     * - Hyperlink styling for actionable pivot cells (when applicable)
+     * - JTD icon display in widget headers
+     * @example
+     * ```TypeScript
+     * import { Component, OnDestroy } from '@angular/core';
+     * import {
+     *   WidgetService,
+     *   widgetModelTranslator,
+     *   type WidgetProps,
+     * } from '@sisense/sdk-ui-angular';
+     * import { BehaviorSubject } from 'rxjs';
+     *
+     * @Component({
+     *   selector: 'code-example',
+     *   template: `
+     *     <csdk-widget
+     *       *ngIf="widgetProps$ && (widgetProps$ | async) as widgetProps"
+     *       [id]="widgetProps.id"
+     *       [widgetType]="widgetProps.widgetType"
+     *       [chartType]="widgetProps.chartType"
+     *       [title]="widgetProps.title"
+     *       [dataSource]="widgetProps.dataSource"
+     *       [dataOptions]="widgetProps.dataOptions"
+     *       [filters]="widgetProps.filters"
+     *       [highlights]="widgetProps.highlights"
+     *       [styleOptions]="widgetProps.styleOptions"
+     *       [beforeMenuOpen]="widgetProps.beforeMenuOpen"
+     *       (dataPointClick)="widgetProps.dataPointClick?.($event)"
+     *       (dataPointContextMenu)="widgetProps.dataPointContextMenu?.($event)"
+     *       (dataPointsSelect)="widgetProps.dataPointsSelect?.($event)"
+     *     />
+     *   `,
+     * })
+     * export class CodeExample implements OnDestroy {
+     *   constructor(private widgetService: WidgetService) {}
+     *
+     *   widgetProps$: BehaviorSubject<WidgetProps | null> | null = null;
+     *   private jtdDestroy: (() => void) | null = null;
+     *
+     *   async ngOnInit(): Promise<void> {
+     *     const widget = await this.widgetService.getWidgetModel({
+     *       dashboardOid: '65a82171719e7f004018691c',
+     *       widgetOid: '65a82171719e7f004018691f',
+     *     });
+     *
+     *     const baseProps = widget
+     *       ? widgetModelTranslator.toWidgetProps(widget)
+     *       : null;
+     *
+     *     if (baseProps) {
+     *       const jtdConfig = {
+     *         targets: [{ id: 'target-dashboard-id', caption: 'Details' }],
+     *         interaction: { triggerMethod: 'rightclick' },
+     *       };
+     *       const jtdResult = this.widgetService.createJtdWidget(
+     *         baseProps,
+     *         jtdConfig,
+     *       );
+     *       this.widgetProps$ = jtdResult.widget$;
+     *       this.jtdDestroy = jtdResult.destroy;
+     *     }
+     *   }
+     *
+     *   ngOnDestroy(): void {
+     *     this.jtdDestroy?.();
+     *   }
+     * }
+     * ```
+     *
+     * @param widgetProps - Base widget props to enhance with JTD functionality
+     * @param jtdConfig - JTD configuration defining navigation targets and behavior
+     * @returns Object containing:
+     *         - `widget$`: The observable that emits enhanced widget props with JTD handlers.
+     *         - `destroy`: Function to clean up resources. Call this when the component is destroyed.
+     * @group Dashboards
+     */
+    createJtdWidget(widgetProps: WidgetProps | null, jtdConfig: JumpToDashboardConfig | JumpToDashboardConfigForPivot): {
+        widget$: BehaviorSubject<WidgetProps | null>;
+        destroy: () => void;
+    };
     static ɵfac: i0.ɵɵFactoryDeclaration<WidgetService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<WidgetService>;
 }

package/dist/lib/types/chart-event-props.d.ts

@@ -1,6 +1,6 @@
 import type { Data } from '@sisense/sdk-data';
 import type { BeforeRenderHandler, IndicatorBeforeRenderHandler } from '@sisense/sdk-ui-preact';
-import type { AreamapDataPointEventHandler, BoxplotDataPointEventHandler, CalendarHeatmapDataPointEventHandler, CalendarHeatmapDataPointsEventHandler, ChartDataPointClickEventHandler, ChartDataPointContextMenuEventHandler, ChartDataPointsEventHandler, DataPointEventHandler, DataPointsEventHandler, IndicatorDataPointEventHandler, ScatterDataPointEventHandler, ScatterDataPointsEventHandler, ScattermapDataPointEventHandler } from './data-point';
+import type { AreamapDataPointEventHandler, BoxplotDataPointEventHandler, CalendarHeatmapDataPointEventHandler, CalendarHeatmapDataPointsEventHandler, ChartDataPointClickEventHandler, ChartDataPointContextMenuEventHandler, ChartDataPointsEventHandler, DataPointEventHandler, DataPointsEventHandler, IndicatorDataPointEventHandler, PivotTableDataPointEventHandler, ScatterDataPointEventHandler, ScatterDataPointsEventHandler, ScattermapDataPointEventHandler } from './data-point';
 export interface HighchartsBasedChartEventProps {
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartProps.onBeforeRender}
@@ -152,6 +152,20 @@ export interface CalendarHeatmapChartEventProps extends BaseChartEventProps, Hig
      */
     dataPointsSelect?: CalendarHeatmapDataPointsEventHandler;
 }
+export interface PivotTableEventProps {
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableProps.onDataPointClick}
+     *
+     * @category Callbacks
+     */
+    dataPointClick?: PivotTableDataPointEventHandler;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!PivotTableProps.onDataPointContextMenu}
+     *
+     * @category Callbacks
+     */
+    dataPointContextMenu?: PivotTableDataPointEventHandler;
+}
 export interface ChartEventProps extends BaseChartEventProps {
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointClick}

package/dist/lib/types/data-point.d.ts

@@ -1,4 +1,4 @@
-import { AreamapDataPoint, BoxplotDataPoint, CalendarHeatmapDataPoint, DataPoint, IndicatorDataPoint, ScatterDataPoint, ScattermapDataPoint, TextWidgetDataPoint } from '@sisense/sdk-ui-preact';
+import { AreamapDataPoint, BoxplotDataPoint, CalendarHeatmapDataPoint, DataPoint, IndicatorDataPoint, PivotTableDataPoint, ScatterDataPoint, ScattermapDataPoint, TextWidgetDataPoint } from '@sisense/sdk-ui-preact';
 export type DataPointEvent = {
     /** Data point that was clicked */
     point: DataPoint;
@@ -54,8 +54,9 @@ export type TextWidgetDataPointEvent = {
     nativeEvent: MouseEvent;
 };
 export type ChartDataPointClickEvent = DataPointEvent | ScatterDataPointEvent | BoxplotDataPointEvent | AreamapDataPointEvent | ScattermapDataPointEvent | IndicatorDataPointEvent | CalendarHeatmapDataPointEvent;
-export type WidgetDataPointClickEvent = ChartDataPointClickEvent | TextWidgetDataPointEvent;
+export type WidgetDataPointClickEvent = ChartDataPointClickEvent | TextWidgetDataPointEvent | PivotTableDataPointEvent;
 export type ChartDataPointContextMenuEvent = DataPointEvent | ScatterDataPointEvent | BoxplotDataPointEvent | CalendarHeatmapDataPointEvent;
+export type WidgetDataPointContextMenuEvent = ChartDataPointContextMenuEvent | PivotTableDataPointEvent;
 export type DataPointsEvent = {
     /** Data points that were selected */
     points: DataPoint[];
@@ -74,6 +75,12 @@ export type BoxplotDataPointsEvent = {
     /** Native MouseEvent */
     nativeEvent: MouseEvent;
 };
+export type PivotTableDataPointEvent = {
+    /** Data point that was clicked */
+    point: PivotTableDataPoint;
+    /** Native MouseEvent */
+    nativeEvent: MouseEvent;
+};
 export type ChartDataPointsEvent = DataPointsEvent | ScatterDataPointsEvent | CalendarHeatmapDataPointsEvent;
 /**
  * A handler function that allows you to customize what happens when certain events occur to
@@ -108,6 +115,8 @@ export type WidgetDataPointClickEventHandler = (event: WidgetDataPointClickEvent
  * Context menu handler for when a data point on the Chart is right-clicked.
  */
 export type ChartDataPointContextMenuEventHandler = (event: ChartDataPointContextMenuEvent) => void;
+/** Context menu handler for when a data point on Widget is right-clicked. */
+export type WidgetDataPointContextMenuEventHandler = (event: WidgetDataPointContextMenuEvent) => void;
 /** Click handler for when multiple scatter data points are selected. */
 export type ScatterDataPointsEventHandler = (event: ScatterDataPointsEvent) => void;
 /** Click handler for when multiple data points are selected. */
@@ -122,3 +131,5 @@ export type CalendarHeatmapDataPointEventHandler = (event: CalendarHeatmapDataPo
 export type CalendarHeatmapDataPointsEventHandler = (event: CalendarHeatmapDataPointsEvent) => void;
 /** Click handler for when multiple data points on Chart are selected. */
 export type ChartDataPointsEventHandler = (event: ChartDataPointsEvent) => void;
+/** Click handler for when a pivot table data point is clicked. */
+export type PivotTableDataPointEventHandler = (event: PivotTableDataPointEvent) => void;

package/dist/lib/utilities/widget-model-translator.d.ts

@@ -1,5 +1,5 @@
 import { type WidgetModel } from '@sisense/sdk-ui-preact';
-import { ChartProps, ChartWidgetProps, PivotTableProps, PivotTableWidgetProps, TableProps, type TextWidgetProps } from '../components';
+import { ChartProps, ChartWidgetProps, PivotTableProps, PivotTableWidgetProps, TableProps, type TextWidgetProps, type WidgetProps } from '../components';
 import { ExecutePivotQueryParams, ExecuteQueryParams } from '../services';
 /**
  * Translates a {@link WidgetModel} to the parameters for executing a query for the widget.
@@ -287,3 +287,52 @@ const textWidgetProps = widgetModelTranslator.toTextWidgetProps(widgetModel);
  * Use {@link toPivotTableWidgetProps} instead for getting props for the pivot table widget.
  */
 export declare function toTextWidgetProps(widgetModel: WidgetModel): TextWidgetProps;
+/**
+ * Translates {@link WidgetModel} to {@link WidgetProps}.
+ *
+ * @example
+ * ```html
+ * <csdk-widget
+ *   *ngIf="widgetProps"
+ *   [id]="widgetProps.id"
+ *   [widgetType]="widgetProps.widgetType"
+ *   [chartType]="widgetProps.chartType"
+ *   [dataSource]="widgetProps.dataSource"
+ *   [dataOptions]="widgetProps.dataOptions"
+ *   [filters]="widgetProps.filters"
+ *   [highlights]="widgetProps.highlights"
+ *   [styleOptions]="widgetProps.styleOptions"
+ *   [title]="widgetProps.title"
+ *   [description]="widgetProps.description"
+ * />
+ * ```
+ *
+ * ```ts
+ * import { Component } from '@angular/core';
+ * import {
+ *   type WidgetProps,
+ *   WidgetService,
+ *   widgetModelTranslator,
+ * } from '@sisense/sdk-ui-angular';
+ *
+ * @Component({
+ *   selector: 'app-example',
+ *   templateUrl: './example.component.html',
+ *   styleUrls: ['./example.component.scss'],
+ * })
+ * export class ExampleComponent {
+ *   widgetProps: WidgetProps | null = null;
+ *
+ *   constructor(private widgetService: WidgetService) {}
+ *
+ *   async ngOnInit(): Promise<void> {
+ *     const widgetModel = await widgetService.getWidgetModel({
+ *       dashboardOid: 'your-dashboard-oid',
+ *       widgetOid: 'your-widget-oid'
+ *     });
+ *     this.widgetProps = widgetModelTranslator.toWidgetProps(widgetModel);
+ *   }
+ * }
+ * ```
+ */
+export declare function toWidgetProps(widgetModel: WidgetModel): WidgetProps;

package/dist/package.json

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

package/dist/public-api.d.ts

@@ -5,7 +5,7 @@ export * from './lib/components';
 export * from './lib/sdk-ui.module';
 export * from './lib/sdk-ui-core-exports';
 export * from './lib/services';
-export type { AreamapDataPointEvent, AreamapDataPointEventHandler, BoxplotDataPointEvent, BoxplotDataPointEventHandler, BoxplotDataPointsEvent, CalendarHeatmapDataPointEvent, CalendarHeatmapDataPointEventHandler, CalendarHeatmapDataPointsEvent, CalendarHeatmapDataPointsEventHandler, ChartDataPointClickEvent, ChartDataPointClickEventHandler, ChartDataPointContextMenuEvent, ChartDataPointContextMenuEventHandler, ChartDataPointsEvent, ChartDataPointsEventHandler, DataPointEvent, DataPointEventHandler, DataPointsEvent, DataPointsEventHandler, FilterChangeEvent, FilterChangeEventHandler, FilterDeleteEventHandler, FilterEditEvent, FilterEditEventHandler, FiltersPanelChangeEvent, FiltersPanelChangeEventHandler, IndicatorDataPointEvent, IndicatorDataPointEventHandler, ScatterDataPointEvent, ScatterDataPointEventHandler, ScatterDataPointsEvent, ScatterDataPointsEventHandler, ScattermapDataPointEvent, ScattermapDataPointEventHandler, } from './lib/types';
+export type { AreamapDataPointEvent, AreamapDataPointEventHandler, BoxplotDataPointEvent, BoxplotDataPointEventHandler, BoxplotDataPointsEvent, CalendarHeatmapDataPointEvent, CalendarHeatmapDataPointEventHandler, CalendarHeatmapDataPointsEvent, CalendarHeatmapDataPointsEventHandler, ChartDataPointClickEvent, ChartDataPointClickEventHandler, ChartDataPointContextMenuEvent, ChartDataPointContextMenuEventHandler, ChartDataPointsEvent, ChartDataPointsEventHandler, DataPointEvent, DataPointEventHandler, DataPointsEvent, DataPointsEventHandler, FilterChangeEvent, FilterChangeEventHandler, FilterDeleteEventHandler, FilterEditEvent, FilterEditEventHandler, FiltersPanelChangeEvent, FiltersPanelChangeEventHandler, IndicatorDataPointEvent, IndicatorDataPointEventHandler, ScatterDataPointEvent, ScatterDataPointEventHandler, ScatterDataPointsEvent, ScatterDataPointsEventHandler, WidgetDataPointClickEventHandler, WidgetDataPointContextMenuEventHandler, ScattermapDataPointEvent, ScattermapDataPointEventHandler, PivotTableDataPointEvent, PivotTableDataPointEventHandler, WidgetDataPointClickEvent, WidgetDataPointContextMenuEvent, TextWidgetDataPointEvent, } from './lib/types';
 export * from './lib/utilities';
 export { createCustomWidgetsContextConnector, createSisenseContextConnector, createThemeContextConnector, } from './lib/component-wrapper-helpers';
 export { TrackableService } from './lib/decorators';

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "2.17.0";
+declare const _default: "2.18.0";
 export default _default;

package/package.json

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