@sisense/sdk-ui 0.12.1 → 0.13.0

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

@@ -35,7 +35,7 @@ export interface CategoryStyle {
     isColored?: boolean;
 }
 /**
- * Wrapped {@link @sisense/sdk-data!Column} with styles controlling how the column is visualized in a chart.
+ * Wrapped {@link @sisense/sdk-data!Column | Column} with styles controlling how the column is visualized in a chart.
  *
  * @example
  * An example of using `StyledColumn` to change the date format of the months displayed on the x-axis.

package/dist/chart-options-processor/chart-options-service.d.ts

@@ -1,4 +1,4 @@
-import type { Options, DrilldownOptions } from '@sisense/sisense-charts';
+import type { Options, DrilldownOptions, SeriesLegendItemClickCallbackFunction } from '@sisense/sisense-charts';
 import { ChartData } from '../chart-data/types';
 import { ChartDesignOptions } from './translations/types';
 import { LegendSettings } from './translations/legend-section';
@@ -53,9 +53,12 @@ type ChartPlotOptions = {
     pointPadding?: number;
     pointPlacement?: null;
     animation?: boolean;
-    shadow: boolean;
+    shadow?: boolean;
     marker?: MarkerSettings;
     borderWidth?: number;
+    events?: {
+        legendItemClick?: SeriesLegendItemClickCallbackFunction;
+    };
 };
 export type Stacking = 'normal' | 'percent';
 export type PlotOptions = {
@@ -91,6 +94,7 @@ export type PlotOptions = {
     pie?: PieOptions;
     funnel?: FunnelOptions;
     bubble?: ScatterBubbleOptions;
+    sunburst?: ChartPlotOptions;
 };
 /**
  * Highcharts options internal

package/dist/chart-options-processor/style-to-design-options-translator/translate-to-highcharts-options.d.ts

@@ -1,6 +1,8 @@
-import { PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, TreemapStyleOptions } from '../../types';
-import { StackableChartDesignOptions, LineChartDesignOptions, PieChartDesignOptions, FunnelChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, AreaChartDesignOptions, TreemapChartDesignOptions } from '../translations/design-options';
+import { Legend, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions } from '../../types';
+import { StackableChartDesignOptions, LineChartDesignOptions, PieChartDesignOptions, FunnelChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, AreaChartDesignOptions, TreemapChartDesignOptions, SunburstChartDesignOptions } from '../translations/design-options';
+import { LegendPosition } from '../translations/legend-section';
 import { StackType } from '../translations/translations-to-highcharts';
+export declare const getLegend: (legend?: Legend) => LegendPosition;
 export declare const DefaultStackType: StackType;
 export declare const getStackableChartDesignOptions: (styleOptions: AreaStyleOptions | StackableStyleOptions, hasY2Axis: boolean) => StackableChartDesignOptions;
 export declare const getLineChartDesignOptions: (styleOptions: LineStyleOptions, hasY2Axis: boolean) => LineChartDesignOptions;
@@ -9,5 +11,6 @@ export declare const DefaultPieType = "classic";
 export declare const getPieChartDesignOptions: (styleOptions: PieStyleOptions) => PieChartDesignOptions;
 export declare const getFunnelChartDesignOptions: (styleOptions: FunnelStyleOptions) => FunnelChartDesignOptions;
 export declare const getTreemapChartDesignOptions: (styleOptions: TreemapStyleOptions) => TreemapChartDesignOptions;
+export declare const getSunburstChartDesignOptions: (styleOptions: SunburstStyleOptions) => SunburstChartDesignOptions;
 export declare const getPolarChartDesignOptions: (styleOptions: PolarStyleOptions) => PolarChartDesignOptions;
 export declare const getScatterChartDesignOptions: (styleOptions: ScatterStyleOptions) => ScatterChartDesignOptions;

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

@@ -87,7 +87,8 @@ export type IndicatorSubtype = 'indicator/numeric' | 'indicator/gauge';
  * - `treemap` - default treemap.
  */
 export type TreemapSubtype = 'treemap';
-export type ChartSubtype = LineSubtype | AreaSubtype | StackableSubtype | PieSubtype | PolarSubtype | IndicatorSubtype | TreemapSubtype;
+export type SunburstSubtype = 'sunburst';
+export type ChartSubtype = LineSubtype | AreaSubtype | StackableSubtype | PieSubtype | PolarSubtype | IndicatorSubtype | TreemapSubtype | SunburstSubtype;
 export declare const chartSubtypeToDesignOptions: Readonly<Record<ChartSubtype, {
     lineType?: LineType | undefined;
     stackType?: StackType | undefined;

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

@@ -5,6 +5,7 @@ export type InternalSeriesNode = {
     val: number;
     name: string;
     parentNode?: InternalSeriesNode;
+    color?: string;
 };
 export type InternalSeries = {
     series: {

package/dist/chart-options-processor/translations/design-options.d.ts

@@ -5,7 +5,7 @@ import { LegendPosition } from './legend-section';
 import { LineType, StackType } from './translations-to-highcharts';
 import { PieType, PieLabels } from './pie-plot-options';
 import { FunnelSize, FunnelType, FunnelDirection, FunnelLabels } from './funnel-plot-options';
-import { Convolution, TreemapStyleOptions } from '../../types';
+import { Convolution, SunburstStyleOptions, TreemapStyleOptions } from '../../types';
 import { ScatterMarkerSize } from './scatter-plot-options';
 type DataLimits = {
     seriesCapacity: number;
@@ -44,6 +44,7 @@ export type FunnelChartDesignOptions = BaseDesignOptionsType & {
     funnelLabels?: FunnelLabels;
 };
 export type TreemapChartDesignOptions = BaseDesignOptionsType & TreemapStyleOptions;
+export type SunburstChartDesignOptions = BaseDesignOptionsType & SunburstStyleOptions;
 export type ScatterChartDesignOptions = BaseDesignOptionsType & {
     markerSize?: ScatterMarkerSize;
 };

package/dist/chart-options-processor/translations/sunburst/sunburst-levels.d.ts

@@ -0,0 +1,12 @@
+import { CategoricalChartData } from '../../../chart-data/types';
+import { PointLabelObject } from '@sisense/sisense-charts';
+import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options/types';
+import { SunburstChartDesignOptions } from '../design-options';
+import { CompleteThemeSettings } from '../../../types';
+export declare function prepareSunburstLevels(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, themeSettings?: CompleteThemeSettings): {
+    level: number;
+    dataLabels: {
+        enabled: boolean;
+        formatter(this: PointLabelObject): string;
+    };
+}[];

package/dist/chart-options-processor/translations/sunburst/sunburst-options.d.ts

@@ -0,0 +1,6 @@
+import { CategoricalChartData } from '../../../chart-data/types';
+import { HighchartsOptionsInternal } from '../../chart-options-service';
+import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options/types';
+import { CompleteThemeSettings } from '../../../types';
+import { SunburstChartDesignOptions } from '../design-options';
+export declare function prepareSunburstOptions(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, designOptions: SunburstChartDesignOptions, themeSettings?: CompleteThemeSettings): HighchartsOptionsInternal;

package/dist/chart-options-processor/translations/sunburst/sunburst-series.d.ts

@@ -0,0 +1,37 @@
+import { CategoricalChartData } from '../../../chart-data/types';
+import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options/types';
+import { CompleteThemeSettings } from '../../../types';
+export declare const SUNBURST_ROOT_PARENT_ID = "SUNBURST_ROOT_PARENT_ID";
+export declare function prepareSunburstDataItems(chartData: CategoricalChartData, dataOptions: CategoricalChartDataOptionsInternal, themeSettings?: CompleteThemeSettings): ({
+    id: string;
+    name: string;
+    custom: {
+        level: number;
+        levelsCount: number;
+    };
+} | {
+    color: string;
+    name?: string | undefined;
+    y?: number | null | undefined;
+    x?: number | null | undefined;
+    z?: number | null | undefined;
+    marker?: {
+        enabled?: boolean | undefined;
+        isIsolatedPoint?: boolean | undefined;
+        lineColor?: string | undefined;
+        lineWidth?: number | undefined;
+    } | undefined;
+    selected?: boolean | undefined;
+    custom?: {
+        [k: string]: unknown;
+        number1?: number | undefined;
+        string1?: string | undefined;
+        level?: number | undefined;
+        maskedBreakByPoint?: string | undefined;
+        maskedBreakByColor?: string | undefined;
+    } | undefined;
+    value?: number | null | undefined;
+    id?: string | undefined;
+    drilldown?: string | undefined;
+    parent?: string | undefined;
+})[];

package/dist/chart-options-processor/translations/translations-to-highcharts.d.ts

@@ -30,6 +30,8 @@ export type SeriesPointStructure = {
         number1?: number;
         string1?: string;
         level?: number;
+        maskedBreakByPoint?: string;
+        maskedBreakByColor?: string;
         [k: string]: unknown;
     };
     value?: number | null;

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

@@ -2,5 +2,11 @@ import { CategoricalChartDataOptionsInternal } from '../../../chart-data-options
 import { TreemapChartDesignOptions } from '../design-options';
 import { TooltipSettings } from '../../tooltip';
 import { TooltipFormatterContextObject } from '@sisense/sisense-charts';
-export declare const getTreemapTooltipSettings: (chartDataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions) => TooltipSettings;
-export declare function treemapTooltipFormatter(context: TooltipFormatterContextObject, chartDataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions): string;
+type TooltipFormatterOptions = {
+    displayTotalContribution: boolean;
+    displayColorCircles: boolean;
+    shouldSkip: (context: TooltipFormatterContextObject) => boolean;
+};
+export declare const getTreemapTooltipSettings: (chartDataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, formatterOptions?: TooltipFormatterOptions) => TooltipSettings;
+export declare function treemapTooltipFormatter(context: TooltipFormatterContextObject, chartDataOptions: CategoricalChartDataOptionsInternal, designOptions: TreemapChartDesignOptions, formatterOptions?: TooltipFormatterOptions): string | false;
+export {};

package/dist/chart-options-processor/translations/types.d.ts

@@ -6,7 +6,7 @@ export type PolarChartType = (typeof POLAR_CHART_TYPES)[number];
 export declare const CARTESIAN_CHART_TYPES: readonly ["line", "area", "bar", "column", "polar"];
 /** Cartesian family of chart types @expandType */
 export type CartesianChartType = (typeof CARTESIAN_CHART_TYPES)[number];
-export declare const CATEGORICAL_CHART_TYPES: readonly ["pie", "funnel", "treemap"];
+export declare const CATEGORICAL_CHART_TYPES: readonly ["pie", "funnel", "treemap", "sunburst"];
 /** Categorical family of chart types  @expandType */
 export type CategoricalChartType = (typeof CATEGORICAL_CHART_TYPES)[number];
 export declare const SCATTER_CHART_TYPES: readonly ["scatter"];
@@ -28,7 +28,7 @@ export type ChartConfig = {
     designOptions: ChartDesignOptions;
 };
 export declare const isCartesian: (chartType: ChartType) => chartType is "area" | "line" | "bar" | "column" | "polar";
-export declare const isCategorical: (chartType: ChartType) => chartType is "pie" | "funnel" | "treemap";
+export declare const isCategorical: (chartType: ChartType) => chartType is "pie" | "funnel" | "treemap" | "sunburst";
 export declare const isScatter: (chartType: ChartType) => chartType is "scatter";
 export declare const isIndicator: (chartType: ChartType) => chartType is "indicator";
 export declare const isPolar: (chartType: ChartType) => chartType is "polar";

package/dist/chart.d.ts

@@ -75,6 +75,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}
+ * @returns Chart component representing a chart type as specified in `ChartProps.`{@link ChartProps.chartType | chartType}
  */
 export declare const Chart: import("react").FunctionComponent<ChartProps>;

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

@@ -6,13 +6,14 @@ export declare const enum WidgetType {
     AreaChart = "chart/area",
     FunnelChart = "chart/funnel",
     TreemapChart = "treemap",
+    SunburstChart = "sunburst",
     ScatterChart = "chart/scatter",
     IndicatorChart = "indicator",
     PolarChart = "chart/polar",
     Table = "tablewidget",
     TableWithAggregation = "tablewidgetagg"
 }
-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';
+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';
 export type Datasource = {
     title: string;
     id: string;
@@ -327,7 +328,13 @@ export type TreemapWidgetStyle = {
     'tooltip/contribution': boolean;
     'tooltip/value': boolean;
 };
-export type WidgetStyle = CartesianWidgetStyle | PolarWidgetStyle | FunnelWidgetStyle | ScatterWidgetStyle | TableWidgetStyle | IndicatorWidgetStyle | TreemapWidgetStyle;
+export type SunburstWidgetStyle = {
+    'legend/enabled': boolean;
+    'legend/position': 'top' | 'bottom' | 'left' | 'right';
+    'tooltip/contribution': boolean;
+    'tooltip/value': boolean;
+};
+export type WidgetStyle = CartesianWidgetStyle | PolarWidgetStyle | FunnelWidgetStyle | ScatterWidgetStyle | TableWidgetStyle | IndicatorWidgetStyle | TreemapWidgetStyle | SunburstWidgetStyle;
 export declare enum FiltersMergeStrategyEnum {
     WIDGET_FIRST = "widgetFirst",
     CODE_FIRST = "codeFirst",

package/dist/index.d.ts

@@ -26,6 +26,7 @@ export * from './scatter-chart';
 export * from './indicator-chart';
 export * from './table';
 export * from './treemap-chart';
+export * from './sunburst-chart';
 export * from './sisense-context/custom-sisense-context-provider';
 export * from './theme-provider/custom-theme-provider';
 export { getThemeSettingsByOid } from './themes/theme-loader';