@sisense/sdk-ui 1.4.1 → 1.6.0

package/dist/area-chart.d.ts

@@ -26,5 +26,6 @@ import { AreaChartProps } from './props';
  * <img src="media://area-chart-example-1.png" width="800"/>
  * @param props - Area chart properties
  * @returns Area Chart component
+ * @group Charts
  */
 export declare const AreaChart: import("react").FunctionComponent<AreaChartProps>;

package/dist/areamap-chart.d.ts

@@ -20,6 +20,7 @@ import { AreamapChartProps } from './props';
  * ```
  * @param props - Areamap chart properties
  * @returns Areamap Chart component
+ * @group Charts
  * @beta
  */
 export declare const AreamapChart: import("react").FunctionComponent<AreamapChartProps>;

package/dist/bar-chart.d.ts

@@ -3,6 +3,8 @@ import { BarChartProps } from './props';
 /**
  * A React component representing categorical data with horizontal rectangular bars,
  * whose lengths are proportional to the values that they represent.
+ * You can also break up the values by another category or groups.
+ *
  * See [Bar Chart](https://docs.sisense.com/main/SisenseLinux/bar-chart.htm) for more information.
  *
  * @example
@@ -25,5 +27,6 @@ import { BarChartProps } from './props';
  * <img src="media://bar-chart-example-1.png" width="800"/>
  * @param props - Bar chart properties
  * @returns Bar Chart component
+ * @group Charts
  */
 export declare const BarChart: import("react").FunctionComponent<BarChartProps>;

package/dist/boxplot-chart.d.ts

@@ -31,6 +31,7 @@ import { BoxplotChartProps } from './props';
  * <img src="media://boxplot-chart-example-1.png" width="600px" />
  * @param props - Boxplot chart properties
  * @returns Boxplot Chart component
+ * @group Charts
  * @beta
  */
 export declare const BoxplotChart: import("react").FunctionComponent<BoxplotChartProps>;

package/dist/boxplot-utils.d.ts

@@ -17,12 +17,13 @@ export declare const boxWhiskerProcessResultInternal: (boxWhiskerData: QueryResu
  * @param {QueryResultData} outliersData - The data for the outliers.
  * @param {BoxplotChartCustomDataOptions} [dataOptions] - Optional data options for customizing data processing.
  * @returns {QueryResultData} The combined data with outliers included in the box whisker plot.
+ * @group Chart Utilities
  */
 export declare function boxWhiskerProcessResult(boxWhiskerData: QueryResultData, outliersData: QueryResultData, dataOptions?: BoxplotChartCustomDataOptions): QueryResultData;
 export declare const executeBoxplotQuery: ({ app, chartDataOptions, dataSource, attributes, measures, filters, highlights, }: {
     app: ClientApplication;
     chartDataOptions: BoxplotChartDataOptionsInternal;
-    dataSource?: string | undefined;
+    dataSource?: DataSource | undefined;
     attributes: Attribute[];
     measures: Measure[];
     filters?: Filter[] | undefined;

package/dist/chart/chart.d.ts

@@ -76,5 +76,6 @@ export declare const shouldSkipSisenseContextWaiting: (props: ChartProps) => boo
  * <img src="media://chart-local-data-example-1.png" width="800px" />
  * @param props - Chart properties
  * @returns Chart component representing a chart type as specified in `ChartProps.`{@link ChartProps.chartType | chartType}
+ * @group Charts
  */
 export declare const Chart: import("react").FunctionComponent<ChartProps>;

package/dist/chart-data-options/types.d.ts

@@ -245,7 +245,7 @@ export interface CategoricalChartDataOptions {
     category: (Column | StyledColumn)[];
     /**
      * Optional mapping of each of the series to colors.
-     * ({@link MultiColumnValueToColorMap} used only for {@link SunburstChart})
+     * ({@link MultiColumnValueToColorMap} used only for the Sunburst Chart component)
      */
     seriesToColorMap?: ValueToColorMap | MultiColumnValueToColorMap;
 }
@@ -336,7 +336,7 @@ export interface AreamapChartDataOptions {
  */
 export declare function isMeasureColumn(arg: AnyColumn): arg is MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
 /**
- * Configuration for how to query data and assign data to {@link Table}.
+ * Configuration for how to query data and assign data to Table.
  *
  */
 export interface TableDataOptions {
@@ -347,7 +347,7 @@ export interface TableDataOptions {
     columns: (Column | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn)[];
 }
 /**
- * Configuration for how to query data and assign data to {@link PivotTable}.
+ * Configuration for how to query data and assign data to PivotTable.
  *
  */
 export interface PivotTableDataOptions {

package/dist/chart-options-processor/subtype-to-design-options.d.ts

@@ -4,7 +4,7 @@ import { AreamapType } from '../types';
 /**
  * Property of {@link LineStyleOptions}
  *
- * Subtype of {@link LineChart}
+ * Subtype of LineChart
  *
  * **Values**
  *
@@ -16,7 +16,7 @@ export type LineSubtype = 'line/spline' | 'line/basic';
 /**
  * Property of {@link AreaStyleOptions}
  *
- * Subtype of {@link AreaChart}
+ * Subtype of AreaChart
  *
  * **Values**
  *
@@ -32,7 +32,7 @@ export type AreaSubtype = 'area/basic' | 'area/stacked' | 'area/stacked100' | 'a
 /**
  * Property of {@link StackableSubtype}
  *
- * Subtype of {@link BarChart}
+ * Subtype of BarChart
  *
  *  **Values**
  * - `bar/classic` - y axis values displayed vertically.
@@ -47,7 +47,7 @@ export type StackableSubtype = 'bar/classic' | 'bar/stacked' | 'bar/stacked100'
 /**
  * Property of {@link PieStyleOptions}
  *
- * Subtype of {@link PieChart}
+ * Subtype of PieChart
  *
  * **Values**
  *
@@ -60,7 +60,7 @@ export type PieSubtype = 'pie/classic' | 'pie/donut' | 'pie/ring';
 /**
  * Property of {@link PolarStyleOptions}
  *
- * Subtype of {@link PolarChart}
+ * Subtype of PolarChart
  *
  * **Values**
  *
@@ -71,7 +71,7 @@ export type PieSubtype = 'pie/classic' | 'pie/donut' | 'pie/ring';
 export type PolarSubtype = 'polar/column' | 'polar/area' | 'polar/line';
 /**
  *
- * Subtype of {@link IndicatorChart}
+ * Subtype of IndicatorChart
  *
  * **Values**
  *

package/dist/chart-options-processor/translations/tooltip-utils.d.ts

@@ -2,6 +2,7 @@ import { Category, Value } from '../../chart-data-options/types.js';
 export declare const isXValueNumeric: (dataOptionX: Value | Category | undefined) => boolean | "";
 export declare const formatTooltipValue: (dataOption: Value | Category | undefined, value: number | undefined, displayValue: string) => string;
 export declare const formatTooltipXValue: (dataOption: Value | Category | undefined, value: number | string | undefined, displayValue: string) => string;
+export declare function isTooltipPercentValueSupported(options: Value | undefined): boolean;
 export type TooltipSettings = {
     enabled?: boolean;
     animation?: boolean;

package/dist/charts/table/helpers/calc-column-widths.d.ts

@@ -1,4 +1,4 @@
 import { DataTable } from '../../../chart-data-processor/table-processor';
-export declare const calcColumnWidths: (dataTable: DataTable, isLoading: boolean, columnsOptions: {
+export declare const calcColumnWidths: (dataTable: DataTable, isLoading: boolean, isShowFieldTypeIcon: boolean, columnsOptions: {
     isHtml: boolean;
 }[], fontFamily?: string) => number[];

package/dist/charts/table/styles/style-constants.d.ts

@@ -1,8 +1,8 @@
 export declare const HEADER_HEIGHT = 26;
 export declare const ROW_HEIGHT = 26;
-export declare const HEADER_PADDING = 60;
+export declare const HEADER_PADDING = 36;
+export declare const HEADER_TYPE_ICON_SPACING = 29;
 export declare const DATA_PADDING = 24;
-export declare const EXTRA_PIXELS = 8;
 export declare const MAX_WIDTH = 350;
 export declare const MIN_WIDTH = 126;
 export declare const HEADER_ELLIPSIZED_LENGTH = 38;

package/dist/column-chart.d.ts

@@ -3,6 +3,9 @@ import { ColumnChartProps } from './props';
 /**
  * A React component representing categorical data with vertical rectangular bars
  * whose heights are proportional to the values that they represent.
+ *
+ * The chart can include multiple values on both the X and Y-axis, as well as a break down by categories displayed on the Y-axis.
+ *
  * See [Column Chart](https://docs.sisense.com/main/SisenseLinux/column-chart.htm) for more information.
  *
  * @example
@@ -25,5 +28,6 @@ import { ColumnChartProps } from './props';
  * <img src="media://column-chart-example-1.png" width="800"/>
  * @param props - Column chart properties
  * @returns Column Chart component
+ * @group Charts
  */
 export declare const ColumnChart: import("react").FunctionComponent<ColumnChartProps>;

package/dist/common/components/loading-indicator.d.ts

@@ -3,8 +3,10 @@ import { CompleteThemeSettings } from '../../types';
 /**
  * Component that displays a loading indicator.
  *
+ * @param themeSettings - Theme settings to use for the loading indicator.
  * @param onCancel - Function to call when cancel is clicked.
  * @returns A loading indicator with optional cancel.
+ * @internal
  */
 export declare const LoadingIndicator: ({ themeSettings, onCancel, }: {
     themeSettings?: {

package/dist/common/components/loading-spinner.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+/**
+ * Centered, animated spinner.
+ */
+export default function LoadingSpinner(): JSX.Element;

package/dist/dashboard-widget/dashboard-widget.d.ts

@@ -2,7 +2,10 @@ import { type FunctionComponent } from 'react';
 import { DashboardWidgetProps } from '../props';
 /**
  * The Dashboard Widget component, which is a thin wrapper on the {@link ChartWidget} component,
- * used to render a widget created in the Sisense instance.
+ * is used to render a widget created in a Sisense Fusion instance.
+ *
+ * To learn more about using Sisense Fusion Widgets in Compose SDK,
+ * see [Sisense Fusion Widgets](/guides/sdk/guides/charts/guide-fusion-widgets.html).
  *
  * @example
  * The example below renders a dashboard widget with the specified widget and dashboard OIDs.
@@ -12,5 +15,6 @@ import { DashboardWidgetProps } from '../props';
  *   dashboardOid={'6441e728dac1920034bce737'}
  * />
  * ```
+ * @group Fusion Assets
  */
 export declare const DashboardWidget: FunctionComponent<DashboardWidgetProps>;

package/dist/dashboard-widget/translate-widget-data-options.d.ts

@@ -4,5 +4,10 @@ import { Panel, PanelItem, WidgetType, WidgetStyle, BoxplotWidgetStyle } from '.
 import { WidgetDataOptions } from '../models';
 export declare function createDimensionalElementFromJaql(jaql: Jaql, format?: PanelItem['format']): import("@sisense/sdk-data").Filter | DimensionalCalculatedMeasure | DimensionalBaseMeasure | DimensionalAttribute;
 export declare function createDataColumn(item: PanelItem, customPaletteColors?: Color[]): StyledMeasureColumn | StyledColumn;
+/** @internal */
+export declare const createDataOptionsFromPanels: (panels: Panel[], variantColors: Color[]) => {
+    [key: string]: any[];
+};
+export declare function createColumnsFromPanelItems(panels: Panel[], panelName: string, customPaletteColors?: Color[]): (StyledMeasureColumn | StyledColumn)[];
 export declare function extractBoxplotBoxType(style: BoxplotWidgetStyle): "iqr" | "extremums" | "standardDeviation";
 export declare function extractDataOptions(widgetType: WidgetType, panels: Panel[], style: WidgetStyle, customPaletteColors?: Color[]): WidgetDataOptions;

package/dist/dashboard-widget/translate-widget-filters.d.ts

@@ -24,6 +24,7 @@ export declare function extractFilterModelFromJaql(jaql: FilterJaql): {
  *
  * @param jaql - The filter JAQL object.
  * @returns - The created Filter object.
+ * @internal
  */
 export declare function createFilterFromJaql(jaql: FilterJaql, instanceid?: string): Filter;
 /**

package/dist/dashboard-widget/types.d.ts

@@ -10,11 +10,11 @@ export type CategoricalWidgetType = 'chart/pie' | 'chart/funnel' | 'treemap' | '
 /**
  * The type of a widget on a dashboard that is a variant of tabular widget.
  */
-export type TabularWidgetType = 'tablewidget' | 'tablewidgetagg';
+export type TabularWidgetType = 'tablewidget' | 'tablewidgetagg' | 'pivot2';
 /**
  * The type of a widget on a dashboard.
  */
-export type WidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area';
+export type WidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area' | 'plugin';
 export type WidgetSubtype = 'area/basic' | 'area/stacked' | 'area/stacked100' | 'area/spline' | 'area/stackedspline' | 'area/stackedspline100' | 'bar/classic' | 'bar/stacked' | 'bar/stacked100' | 'column/classic' | 'column/stackedcolumn' | 'column/stackedcolumn100' | 'line/basic' | 'line/spline' | 'pie/classic' | 'pie/donut' | 'pie/ring' | 'column/polar' | 'area/polar' | 'line/polar' | 'indicator/numeric' | 'indicator/gauge' | 'bubble/scatter' | 'treemap' | 'sunburst' | 'boxplot/full' | 'boxplot/hollow' | 'map/scatter' | 'areamap/world' | 'areamap/usa';
 export declare enum WidgetDashboardFilterMode {
     FILTER = "filter",
@@ -73,7 +73,7 @@ export declare enum CurrencyPosition {
 export type NumericMask = {
     isdefault?: boolean;
     abbreviations?: DecimalAbbreviations;
-    decimals?: 'auto' | number;
+    decimals?: 'auto' | number | string;
     currency?: {
         symbol: string;
         position: CurrencyPosition;
@@ -220,6 +220,7 @@ export type FunnelWidgetStyle = BaseWidgetStyle & {
         decimals: boolean;
     };
 };
+export type PluginStyle = any;
 export type TableWidgetStyle = {
     'colors/columns': boolean;
     'colors/headers': boolean;

package/dist/filters/components/criteria-filter-tile/criteria-filter-tile.d.ts

@@ -40,5 +40,6 @@ export type CriteriaFilterType = NumericFilter | TextFilter | RankingFilter | Ex
  * <img src="media://criteria-filter-tile-example-1.png" width="300px" />
  * @param props - Criteria filter tile props
  * @returns Criteria filter tile component
+ * @group Filter Tiles
  */
 export declare const CriteriaFilterTile: import("react").FunctionComponent<CriteriaFilterTileProps>;

package/dist/filters/components/date-filter/date-range-filter-tile/date-range-filter-tile.d.ts

@@ -67,5 +67,6 @@ export interface DateRangeFilterTileProps {
  * <img src="media://date-filter-example-1.png" width="800px" />
  * @param props - Date Range Filter Tile Props
  * @returns Date Range Filter Tile component
+ * @group Filter Tiles
  */
 export declare const DateRangeFilterTile: import("react").FunctionComponent<DateRangeFilterTileProps>;

package/dist/filters/components/date-filter/relative-date-filter-tile/relative-date-filter-tile.d.ts

@@ -32,5 +32,6 @@ export interface RelativeDateFilterTileProps {
  *
  * @param props - Relative date filter tile props
  * @returns Relative date filter tile component
+ * @group Filter Tiles
  */
 export declare const RelativeDateFilterTile: import("react").FunctionComponent<RelativeDateFilterTileProps>;

package/dist/filters/components/member-filter-tile/member-filter-tile.d.ts

@@ -44,5 +44,6 @@ export interface MemberFilterTileProps {
  * <img src="media://member-filter-tile-example-1.png" width="300px" />
  * @param props - Member filter tile props
  * @returns Member filter tile component
+ * @group Filter Tiles
  */
 export declare const MemberFilterTile: FunctionComponent<MemberFilterTileProps>;

package/dist/formulas/fetch-formula.d.ts

@@ -1,5 +1,5 @@
 import { ClientApplication } from '../app/client-application.js';
-import { DimensionalCalculatedMeasure } from '@sisense/sdk-data';
+import { DataSource, DimensionalCalculatedMeasure } from '@sisense/sdk-data';
 /**
  * Fetch a formula by oid from the default Sisense instance
  *
@@ -15,4 +15,4 @@ export declare function fetchFormulaByOid(oid: string, app: ClientApplication):
  * @param name - Formula name/title in Sisense instance
  * @param dataSource - Data source in Sisense instance
  */
-export declare function fetchFormula(name: string, dataSource: string, app: ClientApplication): Promise<DimensionalCalculatedMeasure | null>;
+export declare function fetchFormula(name: string, dataSource: DataSource, app: ClientApplication): Promise<DimensionalCalculatedMeasure | null>;

package/dist/formulas/use-get-shared-formula.d.ts

@@ -86,6 +86,7 @@ export type SharedFormulaSuccessState = {
  * @param params - {@link UseGetSharedFormulaParams}
  * @param dataSource - Data source in Sisense instance
  * @returns Formula load state that contains the status of the execution, the result formula, or the error if any
+ * @group Fusion Assets
  */
 export declare const useGetSharedFormula: (params: UseGetSharedFormulaParams) => SharedFormulaState;
 /**

package/dist/funnel-chart.d.ts

@@ -43,5 +43,6 @@ import { FunnelChartProps } from './props';
  * Note that the chart sorts the measure, `Unique Users`, in descending order by default.
  * @param props - Funnel chart properties
  * @returns Funnel Chart component
+ * @group Charts
  */
 export declare const FunnelChart: import("react").FunctionComponent<FunnelChartProps>;

package/dist/index.d.ts

@@ -42,3 +42,7 @@ export * from './filters';
 export * from './formulas';
 export { trackHook } from './decorators/hook-decorators';
 export * from './common/hooks/data-load-state-reducer';
+export { createDataOptionsFromPanels } from './dashboard-widget/translate-widget-data-options';
+export { createFilterFromJaql } from './dashboard-widget/translate-widget-filters';
+export { useThemeContext } from './theme-provider/theme-provider';
+export { LoadingIndicator } from './common/components/loading-indicator';