@sisense/sdk-ui 1.4.0 → 1.5.0

package/dist/sisense-context/sisense-context.d.ts

@@ -3,7 +3,10 @@ import { ClientApplication } from '../app/client-application';
 export type SisenseContextPayload = {
     isInitialized: boolean;
     app?: ClientApplication;
-    enableTracking: boolean;
+    tracking: {
+        enabled: boolean;
+        packageName: string;
+    };
 };
 export declare const SisenseContext: import("react").Context<SisenseContextPayload>;
 export declare const useSisenseContext: () => SisenseContextPayload;

package/dist/theme-provider/theme-provider.d.ts

@@ -38,7 +38,7 @@ export declare const useThemeContext: () => {
  * For comparison, indicator chart with default theme settings:
  *
  * <img src="media://indicator-chart-example-1.png" width="400px" />
- * @see {@link ThemeSettings} and {@link IndicatorChart}
+ * @see {@link ThemeSettings} and IndicatorChart
  * @param props - Theme provider props
  * @returns A Theme Provider component
  */

package/dist/types.d.ts

@@ -14,7 +14,7 @@ export type { AppConfig } from './app/client-application';
 export type { DateConfig } from './query/date-formats';
 export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, StyledColumn, StyledMeasureColumn, } from './chart-data-options/types';
 export type { DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, } from './chart-data/data-coloring/types';
-export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, };
+export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, Coordinates, };
 export type { MonthOfYear, DayOfWeek, DateLevel } from './query/date-formats/apply-date-format';
 /**
  * @internal
@@ -205,18 +205,18 @@ export interface BaseAxisStyleOptions {
     /** Configuration for second Y axis */
     y2Axis?: AxisLabel;
 }
-/** Configuration options that define functional style of the various elements of {@link LineChart} */
+/** Configuration options that define functional style of the various elements of LineChart */
 export interface LineStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
     /** Configuration that defines line width */
     lineWidth?: LineWidth;
-    /** Subtype of {@link LineChart}*/
+    /** Subtype of LineChart */
     subtype?: LineSubtype;
 }
-/** Configuration options that define functional style of the various elements of {@link AreaChart} */
+/** Configuration options that define functional style of the various elements of AreaChart */
 export interface AreaStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
     /** Configuration that defines line width */
     lineWidth?: LineWidth;
-    /** Subtype of {@link AreaChart}*/
+    /** Subtype of AreaChart*/
     subtype?: AreaSubtype;
 }
 /** Configuration options that define functional style of the various elements of stackable charts, like Column or Bar */
@@ -236,25 +236,25 @@ export interface PieStyleOptions extends BaseStyleOptions {
     /** Subtype of Pie chart*/
     subtype?: PieSubtype;
 }
-/** Configuration options that define functional style of the various elements of {@link FunnelChart} */
+/** Configuration options that define functional style of the various elements of FunnelChart */
 export interface FunnelStyleOptions extends BaseStyleOptions {
     /** Visual size of the lowest slice (degree of funnel narrowing from highest to lowest slices)*/
     funnelSize?: FunnelSize;
-    /** Visual type of the lowest slice of {@link FunnelChart} */
+    /** Visual type of the lowest slice of FunnelChart */
     funnelType?: FunnelType;
-    /** Direction of {@link FunnelChart} narrowing */
+    /** Direction of FunnelChart narrowing */
     funnelDirection?: FunnelDirection;
-    /** Configuration that defines behavior of data labels on {@link FunnelChart} */
+    /** Configuration that defines behavior of data labels on FunnelChart */
     labels?: Labels;
-    /** Subtype of {@link FunnelChart}*/
+    /** Subtype of FunnelChart*/
     subtype?: never;
 }
-/** Configuration options that define functional style of the various elements of {@link PolarChart} */
+/** Configuration options that define functional style of the various elements of PolarChart */
 export interface PolarStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
-    /** Subtype of {@link PolarChart}*/
+    /** Subtype of PolarChart*/
     subtype?: PolarSubtype;
 }
-/** Configuration options that define functional style of the various elements of {@link IndicatorChart} */
+/** Configuration options that define functional style of the various elements of IndicatorChart */
 export type IndicatorStyleOptions = (NumericSimpleIndicatorStyleOptions | NumericBarIndicatorStyleOptions | GaugeIndicatorStyleOptions) & {
     /**
      * Total width of the component, which is considered in the following order of priority:
@@ -274,7 +274,7 @@ export type IndicatorStyleOptions = (NumericSimpleIndicatorStyleOptions | Numeri
      */
     height?: number;
 };
-/** Configuration options that define functional style of the various elements of {@link Table} */
+/** Configuration options that define functional style of the various elements of the Table Component */
 export interface TableStyleOptions {
     /**
      * Boolean flag whether to fill header cells with background color
@@ -313,7 +313,7 @@ export interface TableStyleOptions {
      */
     height?: number;
 }
-/** Configuration options that define functional style of the various elements of {@link PivotTable} */
+/** Configuration options that define functional style of the various elements of the PivotTable component */
 export interface PivotTableStyleOptions {
     /**
      * Boolean flag whether to fill header cells with background color
@@ -366,31 +366,31 @@ export interface BaseIndicatorStyleOptions {
     /** Boolean flag to force render indicator in ticker mode regardless of display size */
     forceTickerView?: boolean;
 }
-/** Configuration options that define functional style of the various elements of Numeric Simple {@link IndicatorChart} */
+/** Configuration options that define functional style of the various elements of Numeric Simple IndicatorChart */
 export interface NumericSimpleIndicatorStyleOptions extends BaseIndicatorStyleOptions {
     subtype: 'indicator/numeric';
     numericSubtype: 'numericSimple';
     skin: 'vertical' | 'horizontal';
 }
-/** Configuration options that define functional style of the various elements of Numeric Bar {@link IndicatorChart} */
+/** Configuration options that define functional style of the various elements of Numeric Bar IndicatorChart */
 export interface NumericBarIndicatorStyleOptions extends BaseIndicatorStyleOptions {
     subtype: 'indicator/numeric';
     numericSubtype: 'numericBar';
 }
-/** Configuration options that define functional style of the various elements of Gauge {@link IndicatorChart} */
+/** Configuration options that define functional style of the various elements of Gauge IndicatorChart */
 export interface GaugeIndicatorStyleOptions extends BaseIndicatorStyleOptions {
     subtype: 'indicator/gauge';
     skin: 1 | 2;
     /** Bar height for gauge indicator in ticker mode */
     tickerBarHeight?: number;
 }
-/** Configuration options that define functional style of the various elements of {@link ScatterChart} */
+/** Configuration options that define functional style of the various elements of ScatterChart */
 export interface ScatterStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
-    /** Subtype of {@link ScatterChart}*/
+    /** Subtype of ScatterChart*/
     subtype?: never;
     markerSize?: ScatterMarkerSize;
 }
-/** Configuration options that define functional style of the various elements of {@link TreemapChart} */
+/** Configuration options that define functional style of the various elements of TreemapChart */
 export interface TreemapStyleOptions extends BaseStyleOptions {
     /** Labels options object */
     labels?: {
@@ -406,7 +406,7 @@ export interface TreemapStyleOptions extends BaseStyleOptions {
         mode?: 'value' | 'contribution';
     };
 }
-/** Configuration options that define functional style of the various elements of {@link SunburstChart} */
+/** Configuration options that define functional style of the various elements of the SunburstChart component */
 export interface SunburstStyleOptions extends BaseStyleOptions {
     /** Labels options object */
     labels?: {
@@ -422,20 +422,20 @@ export interface SunburstStyleOptions extends BaseStyleOptions {
         mode?: 'value' | 'contribution';
     };
 }
-/** Configuration options that define functional style of the various elements of {@link BoxplotChart} */
+/** Configuration options that define functional style of the various elements of the BoxplotChart component */
 export interface BoxplotStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
-    /** Subtype of {@link BoxplotChart}*/
+    /** Subtype of the BoxplotChart component*/
     subtype?: BoxplotSubtype;
 }
 /**
- * Type of map to display on {@link AreamapChart}
+ * Type of map to display on the AreamapChart component
  */
 export type AreamapType = 'world' | 'usa';
 /**
- * Configuration options that define functional style of the various elements of {@link AreamapChart}
+ * Configuration options that define functional style of the various elements of the AreamapChart component
  */
 export interface AreamapStyleOptions extends Pick<BaseStyleOptions, 'width' | 'height'> {
-    /** Type of map to display on {@link AreamapChart} */
+    /** Type of map to display on the AreamapChart component */
     mapType?: AreamapType;
 }
 /**
@@ -454,7 +454,7 @@ export type ScattermapMarkers = {
         maxSize?: number;
     };
 };
-/** Configuration options that define functional style of the various elements of {@link ScattermapChart} */
+/** Configuration options that define functional style of the various elements of ScattermapChart */
 export interface ScattermapStyleOptions extends Pick<BaseStyleOptions, 'width' | 'height'> {
     subtype?: never;
     markers?: ScattermapMarkers;
@@ -627,7 +627,7 @@ export interface WidgetStyleOptions {
         renderToolbar?: (onRefresh: () => void) => JSX.Element;
     };
 }
-/** Style settings defining the look and feel of {@link DashboardWidget} */
+/** Style settings defining the look and feel of DashboardWidget */
 export interface DashboardWidgetStyleOptions extends WidgetStyleOptions {
     /**
      * Total width of the component, which is considered in the following order of priority:
@@ -647,7 +647,7 @@ export interface DashboardWidgetStyleOptions extends WidgetStyleOptions {
      */
     height?: number;
 }
-/** Style settings defining the look and feel of {@link ChartWidget} */
+/** Style settings defining the look and feel of ChartWidget */
 export type ChartWidgetStyleOptions = ChartStyleOptions & WidgetStyleOptions;
 /**
  * Style settings defining the look and feel of TableWidget}
@@ -847,7 +847,7 @@ export type SeriesWithAlerts<T> = {
 };
 /**
  * Context menu position coordinates
- * Used in {@link ContextMenu} component
+ * Used in {@link ContextMenuProps} component
  */
 export type MenuPosition = {
     /** Horizontal position */
@@ -857,7 +857,7 @@ export type MenuPosition = {
 };
 /**
  * Context menu section
- * Used in {@link ContextMenu} component
+ * Used in {@link ContextMenuProps} component
  */
 export type MenuItemSection = {
     /** Optional section title */

package/dist/utils/not-available-value.d.ts

@@ -0,0 +1,3 @@
+export type NAType = 'N\\A';
+export declare const NAValue = "N\\A";
+export declare const isNotAvailable: (value: number | string | null | undefined) => boolean;

package/dist/widgets/table-widget.d.ts

@@ -1,7 +1,7 @@
 import { type FunctionComponent } from 'react';
 import { TableWidgetProps } from '../props';
 /**
- * The TableWidget component extending the {@link Table} component to support widget style options.
+ * The TableWidget component extending the Table component to support widget style options.
  *
  * @example
  * Example of using the `Widget` component to