@sisense/sdk-ui 1.0.0 → 1.1.0

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

@@ -0,0 +1,3 @@
+import { AreamapStyleOptions } from '../../types.js';
+import { AreamapChartDesignOptions } from '../translations/design-options.js';
+export declare const getAreamapChartDesignOptions: (styleOptions: AreamapStyleOptions) => AreamapChartDesignOptions;

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

@@ -1,5 +1,6 @@
 import { LineType, StackType } from './translations/translations-to-highcharts';
 import { IndicatorStyleType, PolarType, BoxplotType } from './translations/design-options';
+import { AreamapType } from '../types';
 /**
  * Property of {@link LineStyleOptions}
  *
@@ -90,7 +91,8 @@ export type TreemapSubtype = 'treemap';
 export type SunburstSubtype = 'sunburst';
 export type BoxplotSubtype = 'boxplot/full' | 'boxplot/hollow';
 export type ScattermapSubtype = 'scattermap';
-export type ChartSubtype = LineSubtype | AreaSubtype | StackableSubtype | PieSubtype | PolarSubtype | IndicatorSubtype | TreemapSubtype | SunburstSubtype | BoxplotSubtype | ScattermapSubtype;
+export type AreamapSubtype = 'areamap/world' | 'areamap/usa';
+export type ChartSubtype = LineSubtype | AreaSubtype | StackableSubtype | PieSubtype | PolarSubtype | IndicatorSubtype | TreemapSubtype | SunburstSubtype | BoxplotSubtype | ScattermapSubtype | AreamapSubtype;
 export declare const chartSubtypeToDesignOptions: Readonly<Record<ChartSubtype, {
     lineType?: LineType | undefined;
     stackType?: StackType | undefined;
@@ -98,4 +100,5 @@ export declare const chartSubtypeToDesignOptions: Readonly<Record<ChartSubtype,
     polarType?: PolarType | undefined;
     indicatorType?: IndicatorStyleType | undefined;
     boxplotType?: BoxplotType | undefined;
+    mapType?: AreamapType | undefined;
 }>>;

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

@@ -1,3 +1,4 @@
+import { TFunction } from '@sisense/sdk-common';
 import { BoxplotChartDataOptionsInternal } from '../../../chart-data-options/types';
 import { TooltipSettings } from '../tooltip-utils';
-export declare const getBoxplotTooltipSettings: (dataOptions: BoxplotChartDataOptionsInternal) => TooltipSettings;
+export declare const getBoxplotTooltipSettings: (dataOptions: BoxplotChartDataOptionsInternal, translate: TFunction) => TooltipSettings;

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, ScattermapMarkers, SunburstStyleOptions, TreemapStyleOptions } from '../../types';
+import { AreamapType, Convolution, ScattermapMarkers, SunburstStyleOptions, TreemapStyleOptions } from '../../types';
 import { ScatterMarkerSize } from './scatter-plot-options';
 type DataLimits = {
     seriesCapacity: number;
@@ -48,6 +48,12 @@ export type SunburstChartDesignOptions = BaseDesignOptionsType & SunburstStyleOp
 export type ScatterChartDesignOptions = BaseDesignOptionsType & {
     markerSize?: ScatterMarkerSize;
 };
+/**
+ * Configuration for Areamap design options
+ */
+export type AreamapChartDesignOptions = BaseDesignOptionsType & {
+    mapType: AreamapType;
+};
 /**
  * Configuration for Table design options
  *

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

@@ -1,6 +1,6 @@
 import { ChartDataOptionsInternal } from '../../chart-data-options/types';
 import { ChartType } from '../../types';
-import { LineChartDesignOptions, AreaChartDesignOptions, BarChartDesignOptions, ColumnChartDesignOptions, PieChartDesignOptions, FunnelChartDesignOptions, IndicatorChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, TreemapChartDesignOptions, BoxplotChartDesignOptions, ScattermapChartDesignOptions } from './design-options';
+import { LineChartDesignOptions, AreaChartDesignOptions, BarChartDesignOptions, ColumnChartDesignOptions, PieChartDesignOptions, FunnelChartDesignOptions, IndicatorChartDesignOptions, PolarChartDesignOptions, ScatterChartDesignOptions, TreemapChartDesignOptions, BoxplotChartDesignOptions, AreamapChartDesignOptions, ScattermapChartDesignOptions } from './design-options';
 export declare const POLAR_CHART_TYPES: readonly ["polar"];
 export type PolarChartType = (typeof POLAR_CHART_TYPES)[number];
 export declare const CARTESIAN_CHART_TYPES: readonly ["line", "area", "bar", "column", "polar"];
@@ -21,13 +21,16 @@ export type IndicatorChartType = (typeof INDICATOR_CHART_TYPES)[number];
 declare const BOXPLOT_CHART_TYPES: readonly ["boxplot"];
 /** Boxplot chart types  @expandType */
 export type BoxplotChartType = (typeof BOXPLOT_CHART_TYPES)[number];
+declare const AREAMAP_CHART_TYPES: readonly ["areamap"];
+/** Areamap chart types @expandType */
+export type AreamapChartType = (typeof AREAMAP_CHART_TYPES)[number];
 declare const IMAGE_CHART_TYPES: readonly ["image"];
 export type ImageChartType = (typeof IMAGE_CHART_TYPES)[number];
 export declare const SCATTERMAP_CHART_TYPES: readonly ["scattermap"];
 /** Scattermap chart types  @expandType */
 export type ScattermapChartType = (typeof SCATTERMAP_CHART_TYPES)[number];
-export type ChartDataType = 'cartesian' | 'categorical' | 'scatter' | 'table' | 'indicator';
-export type ChartDesignOptions = LineChartDesignOptions | AreaChartDesignOptions | BarChartDesignOptions | ColumnChartDesignOptions | PieChartDesignOptions | FunnelChartDesignOptions | PolarChartDesignOptions | IndicatorChartDesignOptions | ScatterChartDesignOptions | TreemapChartDesignOptions | BoxplotChartDesignOptions | ScattermapChartDesignOptions;
+export type ChartDataType = 'cartesian' | 'categorical' | 'scatter' | 'table' | 'indicator' | 'areamap';
+export type ChartDesignOptions = LineChartDesignOptions | AreaChartDesignOptions | BarChartDesignOptions | ColumnChartDesignOptions | PieChartDesignOptions | FunnelChartDesignOptions | PolarChartDesignOptions | IndicatorChartDesignOptions | ScatterChartDesignOptions | TreemapChartDesignOptions | BoxplotChartDesignOptions | AreamapChartDesignOptions | ScattermapChartDesignOptions;
 export type ChartConfig = {
     chartType: ChartType;
     dataOptions: ChartDataOptionsInternal;
@@ -41,4 +44,5 @@ export declare const isIndicator: (chartType: ChartType) => chartType is "indica
 export declare const isPolar: (chartType: ChartType) => chartType is "polar";
 export declare const isTable: (chartType: ChartType | TableType) => chartType is "table";
 export declare const isBoxplot: (chartType: ChartType) => chartType is "boxplot";
+export declare const isAreamap: (chartType: ChartType) => chartType is "areamap";
 export {};

package/dist/charts/map-charts/areamap/alternative-country-names-dictionary.d.ts

@@ -0,0 +1,9 @@
+/**
+ * List of alternative country names (synonyms) that can be used to match country names from data.
+ * For example, 'United States', 'USA' and 'United States of America' should be understood as the same country.
+ */
+export declare const ALTERNATIVE_COUNTRY_NAMES_DICTIONARY: {
+    officialName: string;
+    allNames: string[];
+    id: string;
+}[];

package/dist/charts/map-charts/areamap/areamap-map.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+import { FeatureCollection as GeoJsonFeatureCollection } from 'geojson';
+import { GeoDataElement } from '../../../chart-data/types.js';
+import { AreamapType } from '../../../types.js';
+export type AreamapProps = {
+    geoJson: GeoJsonFeatureCollection;
+    geoData: GeoDataElement[];
+    dataOptions: {
+        originalValueTitle: string;
+    };
+    mapType: AreamapType;
+};
+/**
+ * Component that renders a map with areas (countries or states) for using in Areamap chart
+ */
+export declare const AreamapMap: React.FC<AreamapProps>;

package/dist/charts/map-charts/areamap/areamap.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+import { AreamapChartDataOptionsInternal, ChartDataOptionsInternal } from '../../../chart-data-options/types.js';
+import { AreamapData, ChartData } from '../../../chart-data/types.js';
+import { AreamapChartDesignOptions } from '../../../chart-options-processor/translations/design-options.js';
+import { ChartDesignOptions } from '../../../chart-options-processor/translations/types.js';
+import { ThemeSettings } from '../../../types.js';
+export type AreamapChartProps = {
+    chartData: AreamapData;
+    dataOptions: AreamapChartDataOptionsInternal;
+    designOptions: AreamapChartDesignOptions;
+    themeSettings: ThemeSettings;
+};
+export declare const Areamap: React.FC<AreamapChartProps>;
+export declare const isAreamapData: (chartData: ChartData) => chartData is AreamapData;
+export declare const isAreamapDataOptions: (dataOptions: ChartDataOptionsInternal) => dataOptions is AreamapChartDataOptionsInternal;
+export declare const isAreamapChartDesignOptions: (designOptions: ChartDesignOptions) => designOptions is AreamapChartDesignOptions;

package/dist/charts/map-charts/areamap/feature-styles-dictionary.d.ts

@@ -0,0 +1,16 @@
+import { Feature as GeoJsonFeature } from 'geojson';
+import { PathOptions } from 'leaflet';
+import { GeoDataElement } from '../../../chart-data/types.js';
+import { AreamapType } from '../../../types.js';
+export type FeatureId = GeoJsonFeature['id'] & string;
+export type FeatureInfo = {
+    /** Corresponding GeoDataElement from GeoData */
+    geoDataElement?: GeoDataElement;
+    style: PathOptions;
+    displayName: string;
+};
+export type FeaturesDictionary = Record<FeatureId, FeatureInfo>;
+/**
+ * Creates a dictionary of feature styles for each feature in geoJson
+ */
+export declare function createFeatureStylesDictionary(geoFeatures: GeoJsonFeature[], geoData: GeoDataElement[], mapType: AreamapType): FeaturesDictionary;

package/dist/charts/map-charts/areamap/use-geo-json.d.ts

@@ -0,0 +1,9 @@
+import { FeatureCollection as GeoJsonFeatureCollection } from 'geojson';
+import { AreamapType } from '../../../types.js';
+/**
+ * Hook to get geoJson from API or cache (LocalStorage)
+ */
+export declare const useGeoJson: (mapType: AreamapType) => {
+    geoJson: GeoJsonFeatureCollection | undefined;
+    error: Error | undefined;
+};

package/dist/charts/map-charts/scattermap/hooks/use-locations.d.ts

@@ -0,0 +1,3 @@
+import { ScattermapLocationLevel } from '../../../../chart-data-options/types.js';
+import { ScattermapChartLocation } from '../../../../chart-data/types';
+export declare const useLocations: (locations: ScattermapChartLocation[], locationLevel: ScattermapLocationLevel) => ScattermapChartLocation[];

package/dist/charts/{scattermap → map-charts/scattermap}/hooks/use-tooltip-handler.d.ts

@@ -1,5 +1,5 @@
-import { ScattermapChartLocation } from '../../../chart-data/types';
-import { ScattermapChartDataOptionsInternal } from '../../../chart-data-options/types.js';
+import { ScattermapChartLocation } from '../../../../chart-data/types';
+import { ScattermapChartDataOptionsInternal } from '../../../../chart-data-options/types.js';
 import { DataSource, Filter } from '@sisense/sdk-data';
 export type TooltipOptions = {
     content: string;

package/dist/charts/{scattermap → map-charts/scattermap}/scattermap.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
-import { ScattermapChartData } from '../../chart-data/types.js';
-import { ScattermapChartDataOptionsInternal } from '../../chart-data-options/types.js';
-import { ScattermapChartDesignOptions } from '../../chart-options-processor/translations/design-options.js';
+import { ScattermapChartData } from '../../../chart-data/types.js';
+import { ScattermapChartDataOptionsInternal } from '../../../chart-data-options/types.js';
+import { ScattermapChartDesignOptions } from '../../../chart-options-processor/translations/design-options.js';
 import { DataSource, Filter, FilterRelation } from '@sisense/sdk-data';
 export type ScattermapProps = {
     chartData: ScattermapChartData;

package/dist/charts/map-charts/scattermap/utils/color.d.ts

@@ -0,0 +1,3 @@
+import { ScattermapChartLocation } from '../../../../chart-data/types.js';
+import { DataColorOptions } from '../../../../types.js';
+export declare function getLocationsMarkerColors(locations: ScattermapChartLocation[], colorOptions?: DataColorOptions): string[];

package/dist/charts/{scattermap → map-charts/scattermap}/utils/size.d.ts

@@ -1,2 +1,2 @@
-import { ScattermapChartLocation } from '../../../chart-data/types.js';
+import { ScattermapChartLocation } from '../../../../chart-data/types.js';
 export declare function getLocationsMarkerSizes(locations: ScattermapChartLocation[], minsize?: number, maxsize?: number): number[];

package/dist/charts/{scattermap → map-charts/scattermap}/utils/tooltip.d.ts

@@ -1,5 +1,5 @@
-import { ScattermapChartLocation } from '../../../chart-data/types';
-import { ScattermapChartDataOptionsInternal } from '../../../chart-data-options/types.js';
+import { ScattermapChartLocation } from '../../../../chart-data/types';
+import { ScattermapChartDataOptionsInternal } from '../../../../chart-data-options/types.js';
 export declare const enum TooltipShowDetails {
     YES = 0,
     NO = 1,

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

@@ -14,8 +14,8 @@ export type TabularWidgetType = 'tablewidget' | 'tablewidgetagg';
 /**
  * The type of a widget on a dashboard.
  */
-export type WidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter';
-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';
+export type WidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area';
+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",
     SELECT = "select"
@@ -322,7 +322,9 @@ export type ScattermapWidgetStyle = {
         };
     };
 };
-export type WidgetStyle = CartesianWidgetStyle | PolarWidgetStyle | FunnelWidgetStyle | ScatterWidgetStyle | TableWidgetStyle | IndicatorWidgetStyle | TreemapWidgetStyle | SunburstWidgetStyle | BoxplotWidgetStyle | ScattermapWidgetStyle;
+/** Currently, WidgetStyle for areamap is an empty object */
+export type AreamapWidgetStyle = {};
+export type WidgetStyle = CartesianWidgetStyle | PolarWidgetStyle | FunnelWidgetStyle | ScatterWidgetStyle | TableWidgetStyle | IndicatorWidgetStyle | TreemapWidgetStyle | SunburstWidgetStyle | BoxplotWidgetStyle | ScattermapWidgetStyle | AreamapWidgetStyle;
 export declare enum FiltersMergeStrategyEnum {
     WIDGET_FIRST = "widgetFirst",
     CODE_FIRST = "codeFirst",

package/dist/index.d.ts

@@ -29,6 +29,7 @@ export * from './treemap-chart';
 export * from './sunburst-chart';
 export * from './boxplot-chart';
 export * from './scattermap-chart';
+export * from './areamap-chart';
 export * from './sisense-context/custom-sisense-context-provider';
 export * from './theme-provider/custom-theme-provider';
 export { getThemeSettingsByOid } from './themes/theme-loader';