@sisense/sdk-ui 2.9.0 → 2.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/ai.cjs +32 -32
- package/dist/ai.js +426 -419
- package/dist/analytics-composer/node.cjs +3 -1
- package/dist/analytics-composer/node.js +521 -385
- package/dist/analytics-composer.cjs +1 -1
- package/dist/analytics-composer.js +6 -6
- package/dist/derive-chart-family-BauaWEEc.cjs +170 -0
- package/dist/derive-chart-family-BhAFg8OE.js +29535 -0
- package/dist/{dimensions-B2jz151s.js → dimensions-Bk74slQe.js} +1 -1
- package/dist/{dimensions-CVJeJ8mi.cjs → dimensions-DCxjxuyH.cjs} +1 -1
- package/dist/{execute-query-agpyzZz6.js → execute-query-CxMSGp-J.js} +292 -269
- package/dist/execute-query-uQ2s1ZNz.cjs +1 -0
- package/dist/index.cjs +25 -26
- package/dist/index.js +12805 -11832
- package/dist/index.umd.js +384 -374
- package/dist/packages/sdk-ui/src/ai/chart/nlq-chart-widget.d.ts +7 -1
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/common.d.ts +14 -0
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-dimensions.d.ts +2 -2
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-filters.d.ts +5 -5
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-measures.d.ts +3 -3
- package/dist/packages/sdk-ui/src/analytics-composer/types.d.ts +12 -0
- package/dist/packages/sdk-ui/src/app/client-application.d.ts +2 -2
- package/dist/packages/sdk-ui/src/calendar-heatmap-chart.d.ts +26 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/calendar-heatmap-chart-builder.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/constants.d.ts +118 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/data-options/data-options.d.ts +56 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/data-options/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/data.d.ts +34 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/design-options.d.ts +22 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/highcharts-options-builder.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/axes-options.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/chart-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/extras-options.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/index.d.ts +7 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/legend-options.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/plot-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/series-options/calendar-data-generator.d.ts +42 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/series-options/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/series-options/series-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/tooltip-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-heatmap-charts-grid.d.ts +34 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-heatmap.d.ts +15 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-pagination/calendar-pagination.d.ts +31 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-pagination/helpers.d.ts +3 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-pagination/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/helpers/data-helpers.d.ts +4 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/helpers/sizing-helpers.d.ts +14 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/helpers/view-helpers.d.ts +16 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/hooks/index.d.ts +4 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/hooks/use-calendar-heatmap-chart-options.d.ts +55 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/hooks/use-calendar-heatmap-navigation.d.ts +33 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/index.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/types.d.ts +13 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils/calendar-utils.d.ts +33 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils/index.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils/with-calendar-heatmap-data-coloring.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/helpers/data-options.d.ts +5 -1
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/helpers/highchart-options/legend.d.ts +3 -2
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/alerts/index.d.ts +5 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/data/index.d.ts +21 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/data-options/index.d.ts +32 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/design-options/index.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/funnel-chart-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/highchart-options/highcharts-options-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/funnel-chart/types.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/helpers/data-options.d.ts +22 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/helpers/data.d.ts +13 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/alerts/index.d.ts +5 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/data/index.d.ts +15 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/data-options/index.d.ts +32 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/design-options/index.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/highchart-options/highcharts-options-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/pie-chart-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/types.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/alerts/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/data/index.d.ts +7 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/data-options/index.d.ts +11 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/design-options/index.d.ts +6 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/highchart-options/highcharts-options-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/sunburst-chart-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/sunburst-chart/types.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/alerts/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/data/index.d.ts +7 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/data-options/index.d.ts +11 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/design-options/index.d.ts +6 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/highchart-options/highcharts-options-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/treemap-chart-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/treemap-chart/types.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/highcharts-based-chart-renderer.d.ts +2 -4
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/use-extra-config.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/types.d.ts +1 -1
- package/dist/packages/sdk-ui/src/chart/restructured-charts/types.d.ts +12 -10
- package/dist/packages/sdk-ui/src/chart-data/types.d.ts +2 -1
- package/dist/packages/sdk-ui/src/chart-data-options/translate-data-options.d.ts +2 -1
- package/dist/packages/sdk-ui/src/chart-data-options/types.d.ts +19 -2
- package/dist/packages/sdk-ui/src/chart-data-options/utils.d.ts +4 -4
- package/dist/packages/sdk-ui/src/chart-data-options/validate-data-options/validate-categorical-data-options.d.ts +14 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/cartesian/utils/series-processor.d.ts +23 -1
- package/dist/packages/sdk-ui/src/chart-options-processor/{category-chart-options.d.ts → category-chart-options/category-chart-options.d.ts} +9 -5
- package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options/funnel-chart-options.d.ts +15 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options/pie-chart-options.d.ts +15 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options/sunburst-chart-options.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options/treemap-chart-options.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/chart-options-service.d.ts +29 -3
- package/dist/packages/sdk-ui/src/chart-options-processor/scatter-chart-options.d.ts +3 -3
- package/dist/packages/sdk-ui/src/chart-options-processor/series-labels.d.ts +19 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/style-to-design-options-translator/translate-to-highcharts-options.d.ts +1 -3
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/axis-section.d.ts +6 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/boxplot/boxplot-plot-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/design-options.d.ts +43 -7
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/funnel-plot-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/funnel-series.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/legend-section.d.ts +28 -14
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/pie-plot-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/pie-series.d.ts +34 -6
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/scatter-series.d.ts +2 -1
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/sunburst/sunburst-options.d.ts +78 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/tooltip-utils.d.ts +10 -4
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/translations-to-highcharts.d.ts +1 -1
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/types.d.ts +50 -6
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/value-label-section.d.ts +14 -11
- package/dist/packages/sdk-ui/src/common/components/modal/modal-context.d.ts +1 -2
- package/dist/packages/sdk-ui/src/common/formatters/create-date-formatter.d.ts +10 -0
- package/dist/packages/sdk-ui/src/common/hooks/useDateFormatter.d.ts +7 -0
- package/dist/packages/sdk-ui/src/common/icons/double-arrow-end-icon.d.ts +6 -0
- package/dist/packages/sdk-ui/src/dashboard/components/editable-layout/utils.d.ts +0 -19
- package/dist/packages/sdk-ui/src/dashboard/components/jtd-dashboard.d.ts +5 -4
- package/dist/packages/sdk-ui/src/dashboard/dashboard-helpers.d.ts +109 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/index.d.ts +7 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/index.d.ts +20 -5
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-config-transformers.d.ts +85 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-filters.d.ts +15 -3
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-formatters.d.ts +80 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-handlers.d.ts +26 -4
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-menu.d.ts +1 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-types.d.ts +260 -5
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-widget-transforms.d.ts +29 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/use-dashboard-header-toolbar.d.ts +7 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/use-edit-mode-toolbar.d.ts +3 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/use-jtd-widget.d.ts +68 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/use-jtd.d.ts +33 -7
- package/dist/packages/sdk-ui/src/dashboard/hooks/use-tabber.d.ts +13 -0
- package/dist/packages/sdk-ui/src/dashboard/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/utils.d.ts +1 -3
- package/dist/packages/sdk-ui/src/index.d.ts +10 -1
- package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-utils.d.ts +26 -2
- package/dist/packages/sdk-ui/src/models/dashboard/types.d.ts +8 -4
- package/dist/packages/sdk-ui/src/pivot-table/formatters/header-cell-formatters/header-cell-value-formatter.d.ts +2 -1
- package/dist/packages/sdk-ui/src/pivot-table/formatters/types.d.ts +0 -1
- package/dist/packages/sdk-ui/src/polar-chart.d.ts +1 -1
- package/dist/packages/sdk-ui/src/props.d.ts +66 -7
- package/dist/packages/sdk-ui/src/sisense-chart/types.d.ts +2 -2
- package/dist/packages/sdk-ui/src/theme-provider/default-theme-settings.d.ts +1 -0
- package/dist/packages/sdk-ui/src/translation/resources/en.d.ts +11 -0
- package/dist/packages/sdk-ui/src/translation/resources/index.d.ts +22 -0
- package/dist/packages/sdk-ui/src/types.d.ts +444 -32
- package/dist/packages/sdk-ui/src/utils/combine-handlers.d.ts +19 -0
- package/dist/packages/sdk-ui/src/utils/create-level-attribute.d.ts +11 -0
- package/dist/packages/sdk-ui/src/utils/utility-types/transformer.d.ts +8 -0
- package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-style-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/widget-by-id/types.d.ts +45 -74
- package/dist/{types-QUSMO7gF.cjs → types-DhvOgfXa.cjs} +1 -1
- package/dist/{types-BYUVZb6u.js → types-Dxieyr4A.js} +1 -1
- package/dist/use-common-filters-DJyYvdev.js +91688 -0
- package/dist/use-common-filters-Qj9249s0.cjs +845 -0
- package/dist/{widget-composer-BG4HonVl.js → widget-composer-azihIMsw.js} +3 -3
- package/dist/{widget-composer-CGp5yOny.cjs → widget-composer-omIEhWNL.cjs} +1 -1
- package/package.json +13 -18
- package/dist/derive-chart-family-BLG1sO1D.js +0 -86946
- package/dist/derive-chart-family-QPmz5DJ3.cjs +0 -656
- package/dist/execute-query-Cp3se7Yb.cjs +0 -1
- package/dist/packages/sdk-ui/src/utils/__development-utils__/highcharts-options-builder-collector.d.ts +0 -61
- package/dist/packages/sdk-ui/src/utils/__development-utils__/input-output-collector.d.ts +0 -125
- package/dist/use-common-filters-DmdADAhl.cjs +0 -350
- package/dist/use-common-filters-wo5IRF5u.js +0 -31972
|
@@ -4,7 +4,7 @@ import { AreaSubtype, BoxplotSubtype, LineSubtype, PieSubtype, PolarSubtype, Sta
|
|
|
4
4
|
import { IndicatorComponents, TableColorOptions } from './chart-options-processor/translations/design-options';
|
|
5
5
|
import { FunnelDirection, FunnelSize, FunnelType } from './chart-options-processor/translations/funnel-plot-options';
|
|
6
6
|
import { ScatterMarkerSize } from './chart-options-processor/translations/scatter-plot-options';
|
|
7
|
-
import { CartesianChartType, ScatterChartType, CategoricalChartType, IndicatorChartType, TableType, AreamapChartType, BoxplotChartType, ScattermapChartType, RangeChartType, TableChartType } from './chart-options-processor/translations/types';
|
|
7
|
+
import { CartesianChartType, ScatterChartType, CategoricalChartType, IndicatorChartType, TableType, AreamapChartType, BoxplotChartType, ScattermapChartType, CalendarHeatmapChartType, RangeChartType, TableChartType, TextStyle } from './chart-options-processor/translations/types';
|
|
8
8
|
import { DataPointsEventHandler } from './props';
|
|
9
9
|
import { LegendPosition } from './chart-options-processor/translations/legend-section';
|
|
10
10
|
import { Coordinates } from './charts/map-charts/scattermap/types';
|
|
@@ -14,20 +14,14 @@ import { CSSProperties, ReactNode } from 'react';
|
|
|
14
14
|
import { GeoDataElement, RawGeoDataElement } from './chart/restructured-charts/areamap-chart/types';
|
|
15
15
|
import { TabCornerRadius, TabInterval, TabSize } from './widgets/tabber-widget';
|
|
16
16
|
import { SoftUnion } from './utils/utility-types';
|
|
17
|
+
import { CalendarDayOfWeek } from './chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils';
|
|
17
18
|
export type { SortDirection, PivotRowsSort } from '@sisense/sdk-data';
|
|
18
19
|
export type { AppConfig } from './app/client-application';
|
|
19
20
|
export type { DateConfig } from './query/date-formats';
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
* Enum for size measurement units
|
|
23
|
-
*/
|
|
24
|
-
export declare enum SizeMeasurement {
|
|
25
|
-
PERCENT = "%",
|
|
26
|
-
PIXEL = "px"
|
|
27
|
-
}
|
|
28
|
-
export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, StyledColumn, StyledMeasureColumn, } from './chart-data-options/types';
|
|
21
|
+
export type { CalendarDayOfWeek } from './chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils';
|
|
22
|
+
export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, CalendarHeatmapChartDataOptions, StyledColumn, StyledMeasureColumn, } from './chart-data-options/types';
|
|
29
23
|
export type { DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, } from './chart-data/data-coloring/types';
|
|
30
|
-
export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, TableChartType, AreaSubtype, AreaRangeSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, Coordinates, RangeChartType, TableColorOptions, };
|
|
24
|
+
export type { CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, CalendarHeatmapChartType, TableType, TableChartType, AreaSubtype, AreaRangeSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, IndicatorComponents, ScatterMarkerSize, LegendPosition, GeoDataElement, RawGeoDataElement, Coordinates, RangeChartType, TableColorOptions, TextStyle, };
|
|
31
25
|
export type { MonthOfYear, DayOfWeek, DateLevel } from './query/date-formats/apply-date-format';
|
|
32
26
|
export type { IndicatorRenderOptions } from './charts/indicator/indicator-render-options';
|
|
33
27
|
/**
|
|
@@ -53,6 +47,42 @@ export type LineWidth = {
|
|
|
53
47
|
/** Line width type */
|
|
54
48
|
width: 'thin' | 'bold' | 'thick';
|
|
55
49
|
};
|
|
50
|
+
/** Configuration that defines line dash type */
|
|
51
|
+
export type DashStyle = 'Solid' | 'ShortDash' | 'ShortDot' | 'ShortDashDot' | 'ShortDashDotDot' | 'Dot' | 'Dash' | 'LongDash' | 'DashDot' | 'LongDashDot' | 'LongDashDotDot';
|
|
52
|
+
/** Configuration that defines line end cap type */
|
|
53
|
+
export type EndCapType = 'Round' | 'Square';
|
|
54
|
+
/**
|
|
55
|
+
* Configuration options for styling lines in charts.
|
|
56
|
+
*
|
|
57
|
+
* This type is used to customize the visual appearance of lines in various chart types
|
|
58
|
+
* including Line charts, Area charts, and AreaRange charts.
|
|
59
|
+
*/
|
|
60
|
+
export type LineOptions = {
|
|
61
|
+
/**
|
|
62
|
+
* Width of the line in pixels.
|
|
63
|
+
*/
|
|
64
|
+
width?: number;
|
|
65
|
+
/**
|
|
66
|
+
* Dash pattern for the line.
|
|
67
|
+
*
|
|
68
|
+
* Defines the visual pattern of the line.
|
|
69
|
+
*/
|
|
70
|
+
dashStyle?: DashStyle;
|
|
71
|
+
/**
|
|
72
|
+
* Style of the line end caps.
|
|
73
|
+
*
|
|
74
|
+
* Controls how the ends of lines are rendered:
|
|
75
|
+
* - `'Round'`: Rounded ends for a softer appearance
|
|
76
|
+
* - `'Square'`: Sharp, flat ends for a crisp appearance
|
|
77
|
+
*/
|
|
78
|
+
endCap?: EndCapType;
|
|
79
|
+
/**
|
|
80
|
+
* Whether to apply a shadow effect to the line.
|
|
81
|
+
*
|
|
82
|
+
* When enabled, adds a subtle shadow behind the line for enhanced.
|
|
83
|
+
*/
|
|
84
|
+
shadow?: boolean;
|
|
85
|
+
};
|
|
56
86
|
/** Options that define markers - symbols or data points that highlight specific values. */
|
|
57
87
|
export type Markers = {
|
|
58
88
|
/** Boolean flag that defines if markers should be shown on the chart */
|
|
@@ -70,11 +100,23 @@ export type X2Title = {
|
|
|
70
100
|
enabled: boolean;
|
|
71
101
|
text?: string;
|
|
72
102
|
};
|
|
103
|
+
export type SeriesLabelsTextStyle = Omit<TextStyle, 'pointerEvents' | 'textOverflow' | 'color'> & {
|
|
104
|
+
/**
|
|
105
|
+
* Color of the labels text
|
|
106
|
+
* The default color setting is "contrast", which applies the maximum contrast between the background and the text
|
|
107
|
+
*
|
|
108
|
+
* @default 'contrast'
|
|
109
|
+
*/
|
|
110
|
+
color?: 'contrast' | string;
|
|
111
|
+
};
|
|
73
112
|
/** Options that define series labels - titles/names identifying data series in a chart. */
|
|
74
113
|
export type SeriesLabels = {
|
|
75
114
|
/** Boolean flag that defines if series labels should be shown on the chart */
|
|
76
115
|
enabled: boolean;
|
|
77
|
-
/**
|
|
116
|
+
/**
|
|
117
|
+
* Rotation of series labels (in degrees)
|
|
118
|
+
* Note that due to a more complex structure, backgrounds, borders and padding will be lost on a rotated data label
|
|
119
|
+
* */
|
|
78
120
|
rotation?: number;
|
|
79
121
|
/**
|
|
80
122
|
* Boolean flag that defines if value should be shown in series labels
|
|
@@ -86,6 +128,70 @@ export type SeriesLabels = {
|
|
|
86
128
|
* (only applicable for subtypes that support percentage, like "stacked100")
|
|
87
129
|
*/
|
|
88
130
|
showPercentage?: boolean;
|
|
131
|
+
/**
|
|
132
|
+
* Text to be shown before the series labels
|
|
133
|
+
*/
|
|
134
|
+
prefix?: string;
|
|
135
|
+
/**
|
|
136
|
+
* Text to be shown after the series labels
|
|
137
|
+
*/
|
|
138
|
+
suffix?: string;
|
|
139
|
+
/**
|
|
140
|
+
* If `true`, series labels appear inside bars/columns instead of at the datapoints. Not applicable for some chart types e.g. line, area
|
|
141
|
+
*/
|
|
142
|
+
alignInside?: boolean;
|
|
143
|
+
/**
|
|
144
|
+
* The horizontal alignment of the data label compared to the point
|
|
145
|
+
*/
|
|
146
|
+
align?: 'left' | 'center' | 'right';
|
|
147
|
+
/**
|
|
148
|
+
* The vertical alignment of the data label
|
|
149
|
+
*/
|
|
150
|
+
verticalAlign?: 'top' | 'middle' | 'bottom';
|
|
151
|
+
/**
|
|
152
|
+
* Styling for labels text
|
|
153
|
+
*/
|
|
154
|
+
textStyle?: SeriesLabelsTextStyle;
|
|
155
|
+
/**
|
|
156
|
+
* Background color of the labels. `auto` uses the same color as the data point
|
|
157
|
+
*/
|
|
158
|
+
backgroundColor?: 'auto' | string;
|
|
159
|
+
/**
|
|
160
|
+
* Color of the labels border
|
|
161
|
+
*/
|
|
162
|
+
borderColor?: string;
|
|
163
|
+
/**
|
|
164
|
+
* Border radius in pixels applied to the labels border, if visible
|
|
165
|
+
*
|
|
166
|
+
* @default 0
|
|
167
|
+
*/
|
|
168
|
+
borderRadius?: number;
|
|
169
|
+
/**
|
|
170
|
+
* Border width of the series labels, in pixels
|
|
171
|
+
*/
|
|
172
|
+
borderWidth?: number;
|
|
173
|
+
/**
|
|
174
|
+
* Padding of the series labels, in pixels
|
|
175
|
+
*/
|
|
176
|
+
padding?: number;
|
|
177
|
+
/**
|
|
178
|
+
* Horizontal offset of the labels in pixels, relative to its horizontal alignment specified via `align`
|
|
179
|
+
*
|
|
180
|
+
* @default 0
|
|
181
|
+
*/
|
|
182
|
+
xOffset?: number;
|
|
183
|
+
/**
|
|
184
|
+
* Vertical offset of the labels in pixels, relative to its vertical alignment specified via `verticalAlign`
|
|
185
|
+
*
|
|
186
|
+
* @default 0
|
|
187
|
+
*/
|
|
188
|
+
yOffset?: number;
|
|
189
|
+
/**
|
|
190
|
+
* The animation delay time in milliseconds. Set to 0 to render the data labels immediately
|
|
191
|
+
*
|
|
192
|
+
* @internal
|
|
193
|
+
*/
|
|
194
|
+
delay?: number;
|
|
89
195
|
};
|
|
90
196
|
/**
|
|
91
197
|
* @internal
|
|
@@ -96,13 +202,161 @@ export type TotalLabels = {
|
|
|
96
202
|
/** Rotation of total labels (in degrees) */
|
|
97
203
|
rotation?: number;
|
|
98
204
|
};
|
|
99
|
-
/**
|
|
100
|
-
|
|
205
|
+
/**
|
|
206
|
+
* Configuration for the legend title
|
|
207
|
+
*/
|
|
208
|
+
export interface LegendTitleOptions {
|
|
209
|
+
/** Whether the legend title is enabled */
|
|
210
|
+
enabled?: boolean;
|
|
211
|
+
/** The text content of the legend title */
|
|
212
|
+
text?: string;
|
|
213
|
+
/** Styling for the legend title */
|
|
214
|
+
textStyle?: TextStyle;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* Configuration for individual legend items
|
|
218
|
+
*/
|
|
219
|
+
export interface LegendItemsOptions {
|
|
220
|
+
/**
|
|
221
|
+
* Layout direction for legend items
|
|
222
|
+
*
|
|
223
|
+
* Can be one of 'horizontal' or 'vertical' or 'proximate'.
|
|
224
|
+
* When 'proximate', the legend items will be placed as close as possible to the graphs they're representing, except in inverted charts or when the legend position doesn't allow it.
|
|
225
|
+
*/
|
|
226
|
+
layout?: 'horizontal' | 'vertical' | 'proximate';
|
|
227
|
+
/** Distance between legend items in pixels */
|
|
228
|
+
distance?: number;
|
|
229
|
+
/** Top margin applied to each legend item, in pixels */
|
|
230
|
+
marginTop?: number;
|
|
231
|
+
/** Bottom margin applied to each legend item, in pixels */
|
|
232
|
+
marginBottom?: number;
|
|
233
|
+
/**
|
|
234
|
+
* Width of legend items, in pixels.
|
|
235
|
+
*
|
|
236
|
+
* @default undefined
|
|
237
|
+
*/
|
|
238
|
+
width?: number;
|
|
239
|
+
/** Styling for legend items text */
|
|
240
|
+
textStyle?: TextStyle;
|
|
241
|
+
/**
|
|
242
|
+
* Styling for legend items on hover
|
|
243
|
+
*
|
|
244
|
+
* @internal
|
|
245
|
+
*/
|
|
246
|
+
hoverTextStyle?: TextStyle;
|
|
247
|
+
/**
|
|
248
|
+
* Styling for hidden legend items
|
|
249
|
+
*
|
|
250
|
+
* @internal
|
|
251
|
+
*/
|
|
252
|
+
hiddenTextStyle?: TextStyle;
|
|
253
|
+
}
|
|
254
|
+
/**
|
|
255
|
+
* Configuration for legend symbols
|
|
256
|
+
*/
|
|
257
|
+
export interface LegendSymbolsOptions {
|
|
258
|
+
/** Width of the legend symbol in pixels */
|
|
259
|
+
width?: number;
|
|
260
|
+
/** Height of the legend symbol in pixels */
|
|
261
|
+
height?: number;
|
|
262
|
+
/**
|
|
263
|
+
* If true, the `width` of the symbol will be the same as the `height`.
|
|
264
|
+
*
|
|
265
|
+
* @default true
|
|
266
|
+
*/
|
|
267
|
+
squared?: boolean;
|
|
268
|
+
/** Border radius applied to symbols. Set to half of the `height` value to create a circle*/
|
|
269
|
+
radius?: number;
|
|
270
|
+
/** Padding between the symbol and text of each legend item, in pixels */
|
|
271
|
+
padding?: number;
|
|
272
|
+
}
|
|
273
|
+
/**
|
|
274
|
+
* Options that define legend - a key that provides information about the data series or colors used in chart.
|
|
275
|
+
*/
|
|
276
|
+
export type LegendOptions = {
|
|
101
277
|
/** Boolean flag that defines if legend should be shown on the chart */
|
|
102
278
|
enabled: boolean;
|
|
103
|
-
/**
|
|
279
|
+
/**
|
|
280
|
+
* Position of the legend
|
|
281
|
+
*
|
|
282
|
+
* @deprecated Please use `align`, `verticalAlign` and `items.layout` properties instead
|
|
283
|
+
*/
|
|
104
284
|
position?: LegendPosition;
|
|
285
|
+
/** Horizontal alignment of the legend */
|
|
286
|
+
align?: 'left' | 'center' | 'right';
|
|
287
|
+
/** Vertical alignment of the legend */
|
|
288
|
+
verticalAlign?: 'top' | 'middle' | 'bottom';
|
|
289
|
+
/**
|
|
290
|
+
* Maximum height of the legend in pixels.
|
|
291
|
+
* When the maximum height is exceeded by the number of items in the legend, scroll navigation arrows will appear
|
|
292
|
+
*/
|
|
293
|
+
maxHeight?: number;
|
|
294
|
+
/** Margin in pixels between the legend and the axis labels or plot area */
|
|
295
|
+
margin?: number;
|
|
296
|
+
/** Padding inside the legend, in pixels */
|
|
297
|
+
padding?: number;
|
|
298
|
+
/** Background color of the legend */
|
|
299
|
+
backgroundColor?: string;
|
|
300
|
+
/** Width of the legend border in pixels */
|
|
301
|
+
borderWidth?: number;
|
|
302
|
+
/** Color of the legend border */
|
|
303
|
+
borderColor?: string;
|
|
304
|
+
/**
|
|
305
|
+
* Border radius in pixels applied to the legend border, if visible.
|
|
306
|
+
*
|
|
307
|
+
* @default 0
|
|
308
|
+
*/
|
|
309
|
+
borderRadius?: number;
|
|
310
|
+
/**
|
|
311
|
+
* Whether to show shadow on the legend
|
|
312
|
+
*
|
|
313
|
+
* @internal
|
|
314
|
+
*/
|
|
315
|
+
shadow?: boolean;
|
|
316
|
+
/** If `true`, the order of legend items is reversed.
|
|
317
|
+
*
|
|
318
|
+
* @default false
|
|
319
|
+
*/
|
|
320
|
+
reversed?: boolean;
|
|
321
|
+
/**
|
|
322
|
+
* If `true`, legend items are displayed right-to-left.
|
|
323
|
+
*
|
|
324
|
+
* @default false
|
|
325
|
+
*/
|
|
326
|
+
rtl?: boolean;
|
|
327
|
+
/**
|
|
328
|
+
* If `true`, the legend can float over the chart.
|
|
329
|
+
*
|
|
330
|
+
* @default false
|
|
331
|
+
*/
|
|
332
|
+
floating?: boolean;
|
|
333
|
+
/** Width of the legend, specified in pixels e.g. `200` or percentage of the chart width e.g. `'30%'` */
|
|
334
|
+
width?: number | string;
|
|
335
|
+
/** Configuration for the legend title */
|
|
336
|
+
title?: LegendTitleOptions;
|
|
337
|
+
/** Configuration for legend items */
|
|
338
|
+
items?: LegendItemsOptions;
|
|
339
|
+
/** Configuration for legend symbols in pixels */
|
|
340
|
+
symbols?: LegendSymbolsOptions;
|
|
341
|
+
/**
|
|
342
|
+
* Horizontal offset of the legend in pixels, relative to its horizontal alignment specified via `align`.
|
|
343
|
+
*
|
|
344
|
+
* @default 0
|
|
345
|
+
*/
|
|
346
|
+
xOffset?: number;
|
|
347
|
+
/**
|
|
348
|
+
* Vertical offset of the legend in pixels, relative to its vertical alignment specified via `verticalAlign`.
|
|
349
|
+
*
|
|
350
|
+
* @default 0
|
|
351
|
+
*/
|
|
352
|
+
yOffset?: number;
|
|
105
353
|
};
|
|
354
|
+
/**
|
|
355
|
+
* Alias for LegendOptions for backward compatibility
|
|
356
|
+
*
|
|
357
|
+
* @deprecated Please use {@link LegendOptions} instead
|
|
358
|
+
*/
|
|
359
|
+
export type Legend = LegendOptions;
|
|
106
360
|
/** Configuration that defines behavior of data labels on chart */
|
|
107
361
|
export type Labels = {
|
|
108
362
|
/** Boolean flag that defines if categories names should be shown */
|
|
@@ -198,12 +452,12 @@ export interface DataLimits {
|
|
|
198
452
|
* @internal
|
|
199
453
|
*/
|
|
200
454
|
export interface BaseStyleOptions extends ReservedStyleOptions {
|
|
201
|
-
/**
|
|
202
|
-
|
|
455
|
+
/**
|
|
456
|
+
* Configuration for legend - a key that provides information about the data series or colors used in chart
|
|
457
|
+
* */
|
|
458
|
+
legend?: LegendOptions;
|
|
203
459
|
/**
|
|
204
460
|
* Configuration for series labels - titles/names identifying data series in a chart
|
|
205
|
-
*
|
|
206
|
-
* @internal
|
|
207
461
|
*/
|
|
208
462
|
seriesLabels?: SeriesLabels;
|
|
209
463
|
/**
|
|
@@ -253,8 +507,15 @@ export interface BaseAxisStyleOptions {
|
|
|
253
507
|
export type CartesianStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions;
|
|
254
508
|
/** Configuration options that define functional style of the various elements of LineChart */
|
|
255
509
|
export interface LineStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
|
|
256
|
-
/**
|
|
510
|
+
/**
|
|
511
|
+
* Configuration that defines line width
|
|
512
|
+
*
|
|
513
|
+
* @deprecated
|
|
514
|
+
* Use line.width instead
|
|
515
|
+
*/
|
|
257
516
|
lineWidth?: LineWidth;
|
|
517
|
+
/** Configuration that defines line style */
|
|
518
|
+
line?: LineOptions;
|
|
258
519
|
/** Subtype of LineChart */
|
|
259
520
|
subtype?: LineSubtype;
|
|
260
521
|
/**
|
|
@@ -271,15 +532,29 @@ export interface LineStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions
|
|
|
271
532
|
}
|
|
272
533
|
/** Configuration options that define functional style of the various elements of AreaRangeChart */
|
|
273
534
|
export interface AreaRangeStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
|
|
274
|
-
/**
|
|
535
|
+
/**
|
|
536
|
+
* Configuration that defines line width
|
|
537
|
+
*
|
|
538
|
+
* @deprecated
|
|
539
|
+
* Use line.width instead
|
|
540
|
+
*/
|
|
275
541
|
lineWidth?: LineWidth;
|
|
542
|
+
/** Configuration that defines line style */
|
|
543
|
+
line?: LineOptions;
|
|
276
544
|
/** Subtype of AreaRangeChart */
|
|
277
545
|
subtype?: AreaRangeSubtype;
|
|
278
546
|
}
|
|
279
547
|
/** Configuration options that define functional style of the various elements of AreaChart */
|
|
280
548
|
export interface AreaStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
|
|
281
|
-
/**
|
|
549
|
+
/**
|
|
550
|
+
* Configuration that defines line width
|
|
551
|
+
*
|
|
552
|
+
* @deprecated
|
|
553
|
+
* Use line.width instead
|
|
554
|
+
*/
|
|
282
555
|
lineWidth?: LineWidth;
|
|
556
|
+
/** Configuration that defines line style */
|
|
557
|
+
line?: LineOptions;
|
|
283
558
|
/** Subtype of AreaChart*/
|
|
284
559
|
subtype?: AreaSubtype;
|
|
285
560
|
}
|
|
@@ -287,9 +562,34 @@ export interface AreaStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions
|
|
|
287
562
|
export interface StackableStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
|
|
288
563
|
/** Subtype of stackable chart */
|
|
289
564
|
subtype?: StackableSubtype;
|
|
565
|
+
/**
|
|
566
|
+
* Configuration for series styling
|
|
567
|
+
*/
|
|
568
|
+
series?: {
|
|
569
|
+
/**
|
|
570
|
+
* Padding between each column or bar, in x axis units.
|
|
571
|
+
*
|
|
572
|
+
* @default 0.01
|
|
573
|
+
*/
|
|
574
|
+
padding?: number;
|
|
575
|
+
/**
|
|
576
|
+
* Padding between each value groups, in x axis units.
|
|
577
|
+
*
|
|
578
|
+
* @default 0.1
|
|
579
|
+
*/
|
|
580
|
+
groupPadding?: number;
|
|
581
|
+
/**
|
|
582
|
+
* The corner radius of the border surrounding each column or bar.
|
|
583
|
+
* A number signifies pixels.
|
|
584
|
+
* A percentage string, like for example 50%, signifies a relative size.
|
|
585
|
+
*
|
|
586
|
+
* @default 0
|
|
587
|
+
*/
|
|
588
|
+
borderRadius?: number | string;
|
|
589
|
+
};
|
|
290
590
|
}
|
|
291
591
|
/** Configuration options that define functional style of the various elements of Pie chart */
|
|
292
|
-
export interface PieStyleOptions extends BaseStyleOptions {
|
|
592
|
+
export interface PieStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
|
|
293
593
|
/**
|
|
294
594
|
* Configuration that defines the ability of the Pie chart to collapse (convolve) and
|
|
295
595
|
* hide part of the data under the single category "Others".
|
|
@@ -301,7 +601,7 @@ export interface PieStyleOptions extends BaseStyleOptions {
|
|
|
301
601
|
subtype?: PieSubtype;
|
|
302
602
|
}
|
|
303
603
|
/** Configuration options that define functional style of the various elements of FunnelChart */
|
|
304
|
-
export interface FunnelStyleOptions extends BaseStyleOptions {
|
|
604
|
+
export interface FunnelStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
|
|
305
605
|
/** Visual size of the lowest slice (degree of funnel narrowing from highest to lowest slices)*/
|
|
306
606
|
funnelSize?: FunnelSize;
|
|
307
607
|
/** Visual type of the lowest slice of FunnelChart */
|
|
@@ -500,13 +800,13 @@ export interface GaugeIndicatorStyleOptions extends BaseIndicatorStyleOptions {
|
|
|
500
800
|
tickerBarHeight?: number;
|
|
501
801
|
}
|
|
502
802
|
/** Configuration options that define functional style of the various elements of ScatterChart */
|
|
503
|
-
export interface ScatterStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
|
|
803
|
+
export interface ScatterStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'>, BaseAxisStyleOptions {
|
|
504
804
|
/** Subtype of ScatterChart*/
|
|
505
805
|
subtype?: never;
|
|
506
806
|
markerSize?: ScatterMarkerSize;
|
|
507
807
|
}
|
|
508
808
|
/** Configuration options that define functional style of the various elements of TreemapChart */
|
|
509
|
-
export interface TreemapStyleOptions extends BaseStyleOptions {
|
|
809
|
+
export interface TreemapStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
|
|
510
810
|
/** Labels options object */
|
|
511
811
|
labels?: {
|
|
512
812
|
/** Array with single label options objects (order of items relative to dataOptions.category) */
|
|
@@ -522,7 +822,7 @@ export interface TreemapStyleOptions extends BaseStyleOptions {
|
|
|
522
822
|
};
|
|
523
823
|
}
|
|
524
824
|
/** Configuration options that define functional style of the various elements of the SunburstChart component */
|
|
525
|
-
export interface SunburstStyleOptions extends BaseStyleOptions {
|
|
825
|
+
export interface SunburstStyleOptions extends Omit<BaseStyleOptions, 'seriesLabels'> {
|
|
526
826
|
/** Labels options object */
|
|
527
827
|
labels?: {
|
|
528
828
|
/** Array with single label options objects (order of items relative to dataOptions.category) */
|
|
@@ -574,12 +874,105 @@ export interface ScattermapStyleOptions extends Pick<BaseStyleOptions, 'width' |
|
|
|
574
874
|
subtype?: never;
|
|
575
875
|
markers?: ScattermapMarkers;
|
|
576
876
|
}
|
|
877
|
+
/**
|
|
878
|
+
* Configuration for day numbers (1-31) labels in calendar-heatmap cells
|
|
879
|
+
*/
|
|
880
|
+
export type CalendarHeatmapCellLabels = {
|
|
881
|
+
/**
|
|
882
|
+
* Boolean flag that defines if calendar day numbers should be shown in cells
|
|
883
|
+
*
|
|
884
|
+
* @default true
|
|
885
|
+
*/
|
|
886
|
+
enabled?: boolean;
|
|
887
|
+
/** Style configuration for calendar day numbers in cells */
|
|
888
|
+
style?: Omit<TextStyle, 'color'> & {
|
|
889
|
+
/**
|
|
890
|
+
* Color of the labels text
|
|
891
|
+
*
|
|
892
|
+
* The "contrast" color applies the maximum contrast between the background and the text
|
|
893
|
+
*/
|
|
894
|
+
color?: string | 'contrast';
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
/**
|
|
898
|
+
* Configuration options that define functional style of the various elements of calendar-heatmap chart
|
|
899
|
+
*/
|
|
900
|
+
export interface CalendarHeatmapStyleOptions extends Pick<BaseStyleOptions, 'width' | 'height'> {
|
|
901
|
+
/**
|
|
902
|
+
* {@inheritDoc CalendarHeatmapViewType}
|
|
903
|
+
*/
|
|
904
|
+
viewType?: CalendarHeatmapViewType;
|
|
905
|
+
/**
|
|
906
|
+
* Determines which day of the week to start the calendar with
|
|
907
|
+
* @default 'sunday'
|
|
908
|
+
*/
|
|
909
|
+
startOfWeek?: CalendarDayOfWeek;
|
|
910
|
+
/**
|
|
911
|
+
* Configuration for day numbers (1-31) in calendar cells
|
|
912
|
+
*/
|
|
913
|
+
cellLabels?: CalendarHeatmapCellLabels;
|
|
914
|
+
/**
|
|
915
|
+
* Configuration for weekday names in the header
|
|
916
|
+
*/
|
|
917
|
+
dayLabels?: {
|
|
918
|
+
/**
|
|
919
|
+
* Boolean flag that defines if calendar weekday names should be shown
|
|
920
|
+
*
|
|
921
|
+
* @default true
|
|
922
|
+
*/
|
|
923
|
+
enabled?: boolean;
|
|
924
|
+
/** Style configuration for calendar weekday names */
|
|
925
|
+
style?: TextStyle;
|
|
926
|
+
};
|
|
927
|
+
/**
|
|
928
|
+
* Configuration for month names in multi-month view types
|
|
929
|
+
*/
|
|
930
|
+
monthLabels?: {
|
|
931
|
+
/**
|
|
932
|
+
* Boolean flag that defines if month names should be shown
|
|
933
|
+
*
|
|
934
|
+
* @default true
|
|
935
|
+
*/
|
|
936
|
+
enabled?: boolean;
|
|
937
|
+
/** Style configuration for month names */
|
|
938
|
+
style?: TextStyle;
|
|
939
|
+
};
|
|
940
|
+
/**
|
|
941
|
+
* Configuration for weekend days
|
|
942
|
+
*/
|
|
943
|
+
weekends?: {
|
|
944
|
+
/**
|
|
945
|
+
* Boolean flag that enables/disables weekend highlighting
|
|
946
|
+
*
|
|
947
|
+
* @default false
|
|
948
|
+
*/
|
|
949
|
+
enabled?: boolean;
|
|
950
|
+
/** Weekend days - defaults to ['saturday', 'sunday'] */
|
|
951
|
+
days?: CalendarDayOfWeek[];
|
|
952
|
+
/**
|
|
953
|
+
* Calendar cell color for weekend days
|
|
954
|
+
*
|
|
955
|
+
* @default '#e6e6e6'
|
|
956
|
+
*/
|
|
957
|
+
cellColor?: string;
|
|
958
|
+
/**
|
|
959
|
+
* Whether to hide values in tooltip for weekend days
|
|
960
|
+
*
|
|
961
|
+
* @default false
|
|
962
|
+
*/
|
|
963
|
+
hideValues?: boolean;
|
|
964
|
+
};
|
|
965
|
+
}
|
|
966
|
+
/**
|
|
967
|
+
* View type determines how many months to display: 'month' (1), 'quarter' (3), 'half-year' (6), 'year' (12)
|
|
968
|
+
*/
|
|
969
|
+
export type CalendarHeatmapViewType = 'month' | 'quarter' | 'half-year' | 'year';
|
|
577
970
|
/**
|
|
578
971
|
* Configuration options that define functional style of the various elements of chart.
|
|
579
972
|
*/
|
|
580
973
|
export type ChartStyleOptions = RegularChartStyleOptions | TabularChartStyleOptions;
|
|
581
974
|
/** Style options for regular chart types */
|
|
582
|
-
export type RegularChartStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions | PieStyleOptions | FunnelStyleOptions | PolarStyleOptions | IndicatorStyleOptions | ScatterStyleOptions | TreemapStyleOptions | SunburstStyleOptions | BoxplotStyleOptions | AreamapStyleOptions | ScattermapStyleOptions | AreaRangeStyleOptions;
|
|
975
|
+
export type RegularChartStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions | PieStyleOptions | FunnelStyleOptions | PolarStyleOptions | IndicatorStyleOptions | ScatterStyleOptions | TreemapStyleOptions | SunburstStyleOptions | BoxplotStyleOptions | AreamapStyleOptions | ScattermapStyleOptions | AreaRangeStyleOptions | CalendarHeatmapStyleOptions;
|
|
583
976
|
/** Mapping of each of the chart value series to colors. */
|
|
584
977
|
export type ValueToColorMap = {
|
|
585
978
|
[value: string]: string;
|
|
@@ -591,7 +984,7 @@ export type MultiColumnValueToColorMap = {
|
|
|
591
984
|
/**
|
|
592
985
|
* Chart type of one of the supported chart families
|
|
593
986
|
*/
|
|
594
|
-
export type ChartType = CartesianChartType | CategoricalChartType | ScatterChartType | IndicatorChartType | AreamapChartType | BoxplotChartType | ScattermapChartType | RangeChartType | TableChartType;
|
|
987
|
+
export type ChartType = CartesianChartType | CategoricalChartType | ScatterChartType | IndicatorChartType | AreamapChartType | BoxplotChartType | ScattermapChartType | CalendarHeatmapChartType | RangeChartType | TableChartType;
|
|
595
988
|
/** Chart type of the regular charts */
|
|
596
989
|
export type RegularChartType = Exclude<ChartType, TableChartType>;
|
|
597
990
|
/**
|
|
@@ -888,6 +1281,8 @@ export interface TypographyThemeSettings {
|
|
|
888
1281
|
primaryTextColor?: string;
|
|
889
1282
|
/** Secondary text color */
|
|
890
1283
|
secondaryTextColor?: string;
|
|
1284
|
+
/** Hyperlink color */
|
|
1285
|
+
hyperlinkColor?: string;
|
|
891
1286
|
/** Settings for font loading */
|
|
892
1287
|
fontsLoader?: FontsLoaderSettings;
|
|
893
1288
|
}
|
|
@@ -1367,17 +1762,17 @@ export type DrilldownSelection = {
|
|
|
1367
1762
|
/**
|
|
1368
1763
|
* Data points in a chart. Array of data points of the same data point type.
|
|
1369
1764
|
*/
|
|
1370
|
-
export type ChartDataPoints = DataPoint[] | ScatterDataPoint[] | BoxplotDataPoint[] | AreamapDataPoint[] | ScattermapDataPoint[];
|
|
1765
|
+
export type ChartDataPoints = DataPoint[] | ScatterDataPoint[] | BoxplotDataPoint[] | AreamapDataPoint[] | ScattermapDataPoint[] | CalendarHeatmapDataPoint[];
|
|
1371
1766
|
/**
|
|
1372
1767
|
* Abstract data point in a chart - union of all types of data points.
|
|
1373
1768
|
*/
|
|
1374
|
-
export type ChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint | AreamapDataPoint | ScattermapDataPoint;
|
|
1769
|
+
export type ChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint | AreamapDataPoint | ScattermapDataPoint | CalendarHeatmapDataPoint;
|
|
1375
1770
|
/**
|
|
1376
1771
|
* Abstract data point in a chart that based on Highcharts.
|
|
1377
1772
|
*
|
|
1378
1773
|
* @internal
|
|
1379
1774
|
*/
|
|
1380
|
-
export type HighchartsBasedChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint;
|
|
1775
|
+
export type HighchartsBasedChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint | CalendarHeatmapDataPoint;
|
|
1381
1776
|
/**
|
|
1382
1777
|
* Abstract event handler for data point click event
|
|
1383
1778
|
*
|
|
@@ -1490,6 +1885,20 @@ export type IndicatorDataPoint = {
|
|
|
1490
1885
|
max?: DataPointEntry;
|
|
1491
1886
|
};
|
|
1492
1887
|
};
|
|
1888
|
+
/**
|
|
1889
|
+
* Data point in a CalendarHeatmap chart.
|
|
1890
|
+
*/
|
|
1891
|
+
export type CalendarHeatmapDataPoint = {
|
|
1892
|
+
/**
|
|
1893
|
+
* A collection of data point entries that represents values for all related `dataOptions`.
|
|
1894
|
+
*
|
|
1895
|
+
* @internal
|
|
1896
|
+
*/
|
|
1897
|
+
entries?: {
|
|
1898
|
+
date: DataPointEntry;
|
|
1899
|
+
value?: DataPointEntry;
|
|
1900
|
+
};
|
|
1901
|
+
};
|
|
1493
1902
|
/**
|
|
1494
1903
|
* Data point that represents the entire Text widget data.
|
|
1495
1904
|
*
|
|
@@ -1619,6 +2028,9 @@ export type HighchartsPoint = {
|
|
|
1619
2028
|
level?: number;
|
|
1620
2029
|
levelsCount?: number;
|
|
1621
2030
|
};
|
|
2031
|
+
date?: number;
|
|
2032
|
+
dateString?: string;
|
|
2033
|
+
value?: number;
|
|
1622
2034
|
q1?: number;
|
|
1623
2035
|
median?: number;
|
|
1624
2036
|
q3?: number;
|
|
@@ -1,3 +1,22 @@
|
|
|
1
|
+
import { RenderTitleHandler, RenderToolbarHandler, TextWidgetRenderToolbarHandler } from '../types';
|
|
1
2
|
type AnyFunction = (...args: any[]) => any;
|
|
2
3
|
export declare function combineHandlers<Handler extends AnyFunction>(handlers: (Handler | undefined)[], chainHandlers?: boolean): Handler;
|
|
4
|
+
/**
|
|
5
|
+
* Compose multiple RenderToolbarHandler functions into one.
|
|
6
|
+
* Each handler gets a chance to modify the toolbar.
|
|
7
|
+
* If it returns `null`, the previous toolbar is passed to the next handler.
|
|
8
|
+
*/
|
|
9
|
+
export declare function composeToolbarHandlers(...handlers: (RenderToolbarHandler | undefined)[]): RenderToolbarHandler;
|
|
10
|
+
/**
|
|
11
|
+
* Compose multiple TextWidgetRenderToolbarHandler functions into one.
|
|
12
|
+
* Each handler gets a chance to modify the toolbar.
|
|
13
|
+
* If it returns `null`, the previous toolbar is passed to the next handler.
|
|
14
|
+
*/
|
|
15
|
+
export declare function composeTextWidgetToolbarHandlers(...handlers: (TextWidgetRenderToolbarHandler | undefined)[]): TextWidgetRenderToolbarHandler;
|
|
16
|
+
/**
|
|
17
|
+
* Compose multiple RenderTitleHandler functions into one.
|
|
18
|
+
* Each handler gets a chance to modify the title.
|
|
19
|
+
* If it returns `null`, the previous tile is passed to the next handler.
|
|
20
|
+
*/
|
|
21
|
+
export declare function composeTitleHandlers(...handlers: (RenderTitleHandler | undefined)[]): RenderTitleHandler;
|
|
3
22
|
export {};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { TFunction } from '@sisense/sdk-common';
|
|
2
|
+
import { DimensionalLevelAttribute } from '@sisense/sdk-data';
|
|
3
|
+
/**
|
|
4
|
+
* Creates a level attribute from a base level attribute and a granularity
|
|
5
|
+
*
|
|
6
|
+
* @param baseLevelAttribute - The base level attribute
|
|
7
|
+
* @param granularity - The granularity
|
|
8
|
+
* @param t - The translation function
|
|
9
|
+
* @returns The level attribute
|
|
10
|
+
*/
|
|
11
|
+
export declare function createLevelAttribute(baseLevelAttribute: DimensionalLevelAttribute, granularity: string, t?: TFunction): DimensionalLevelAttribute;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Context-based transformer type for pure functional transformations
|
|
3
|
+
*/
|
|
4
|
+
export type ContextfulTransformer<T, C = void> = (ctx: C) => (input: Readonly<T>) => T;
|
|
5
|
+
/**
|
|
6
|
+
* Contextless transformer type for pure functional transformations
|
|
7
|
+
*/
|
|
8
|
+
export type Transformer<T> = (input: Readonly<T>) => T;
|