@sproutsocial/seeds-react-data-viz 0.4.3 → 0.5.1

package/dist/index.d.mts

@@ -4,6 +4,7 @@ import { TimeTicksInfoObject, AxisLabelsFormatterContextObject, Chart, Annotatio
 import * as _sproutsocial_seeds_react_box from '@sproutsocial/seeds-react-box';
 import { TypeBoxProps } from '@sproutsocial/seeds-react-box';
 import { Table } from '@sproutsocial/seeds-react-table';
+import { TypeIconName } from '@sproutsocial/seeds-react-icon';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as styled_components from 'styled-components';
 
@@ -228,6 +229,15 @@ type TypeChartTooltipTitleProps = {
 };
 declare const ChartTooltipTitle: react.NamedExoticComponent<TypeChartTooltipTitleProps>;
 
+declare const ChartXAnnotationDetails: react.NamedExoticComponent<Readonly<{
+    iconName: TypeIconName;
+    text: string;
+}>>;
+
+declare const ChartXAnnotationMarker: react.NamedExoticComponent<Readonly<{
+    iconName: TypeIconName;
+}>>;
+
 type TypeColorBoxProps = TypeBoxProps;
 /**
  * ColorBox extends Box to apply basic styles.
@@ -269,13 +279,15 @@ type TypeDonutChartTooltipProps = Readonly<{
     value: number | null;
     icon?: ReactNode;
 }>;
+type TypeDonutChartDataItem = Readonly<{
+    name: string;
+    value: number;
+    key?: string;
+    icon?: ReactNode;
+    styles?: TypeChartDataStyles;
+}>;
 type TypeDonutChartProps = Readonly<{
-    data: ReadonlyArray<Readonly<{
-        name: string;
-        value: number;
-        icon?: ReactNode;
-        styles?: TypeChartDataStyles;
-    }>>;
+    data: ReadonlyArray<TypeDonutChartDataItem>;
     numberLocale: Intl.LocalesArgument;
     textLocale: Intl.LocalesArgument;
     currency?: string;
@@ -283,18 +295,13 @@ type TypeDonutChartProps = Readonly<{
     hideLegend?: boolean;
     numberFormat?: TypeChartNumberFormat;
     tooltip?: ({ color, name, percent, value, }: TypeDonutChartTooltipProps) => ReactNode;
-    onClick?: ({ x }: Readonly<{
+    onClick?: (data: Readonly<{
         x: string;
-    }>) => void;
+    } & TypeDonutChartDataItem>) => void;
     tooltipClickLabel?: ReactNode;
 }>;
 declare const DonutChart: react.NamedExoticComponent<Readonly<{
-    data: ReadonlyArray<Readonly<{
-        name: string;
-        value: number;
-        icon?: ReactNode;
-        styles?: TypeChartDataStyles;
-    }>>;
+    data: ReadonlyArray<TypeDonutChartDataItem>;
     numberLocale: Intl.LocalesArgument;
     textLocale: Intl.LocalesArgument;
     currency?: string;
@@ -302,9 +309,9 @@ declare const DonutChart: react.NamedExoticComponent<Readonly<{
     hideLegend?: boolean;
     numberFormat?: TypeChartNumberFormat;
     tooltip?: ({ color, name, percent, value, }: TypeDonutChartTooltipProps) => ReactNode;
-    onClick?: ({ x }: Readonly<{
+    onClick?: (data: Readonly<{
         x: string;
-    }>) => void;
+    } & TypeDonutChartDataItem>) => void;
     tooltipClickLabel?: ReactNode;
 }>>;
 
@@ -376,6 +383,40 @@ declare const LineChart: react.NamedExoticComponent<Readonly<{
     xAnnotations?: TypeChartXAnnotations;
 }>>;
 
+declare const VerticalBarChart: react.NamedExoticComponent<Readonly<{
+    data: ReadonlyArray<Readonly<{
+        name: string;
+        points: ReadonlyArray<TypeChartDataPoint>;
+        icon?: ReactNode;
+        styles?: TypeChartDataStyles & Readonly<{
+            pattern?: TypeChartStylePattern;
+        }>;
+    }>>;
+    invalidNumberLabel: ReactNode;
+    numberLocale: Intl.LocalesArgument;
+    textLocale: Intl.LocalesArgument;
+    tooltipDateFormatter: TypeChartTooltipDateFormatter;
+    currency?: string;
+    numberFormat?: TypeChartNumberFormat;
+    seriesLimit?: number;
+    showSeriesLimitWarning?: boolean;
+    tooltip?: ({ data, x }: TypeChartTooltipProps) => ReactNode;
+    yAxisLabelFormatter?: TypeChartYAxisLabelFormatter;
+    onClick?: ({ x }: Readonly<{
+        x: number;
+    }>) => void;
+    tooltipClickLabel?: ReactNode;
+    timeFormat?: TypeChartTimeFormat;
+    xAnnotations?: TypeChartXAnnotations;
+    xAxisLabelFormatter?: (params: {
+        textLocale: Intl.LocalesArgument;
+        tickPositions: number[];
+        unitName: string;
+        value: string | number;
+        timeFormat?: string;
+    }) => string;
+}>>;
+
 declare const baseChartOptions: Options;
 declare const TIME_SERIES_CHART_HEIGHT = 275;
 declare const timeSeriesChartOptions: Options;
@@ -510,4 +551,4 @@ declare const donutChartStyles: styled_components.FlattenInterpolation<styled_co
     $hasOnClick: TypeChartStyleHasOnClick;
 }>, any>>;
 
-export { AreaChart, ChartLegend, ChartLegendLabel, ChartTable, ChartTooltip, ChartTooltipFooter, ChartTooltipHeader, ChartTooltipPortal, ChartTooltipTable, ChartTooltipTitle, ColorBox, DONUT_CHART_HALO_SIZE, DONUT_CHART_HEIGHT, DONUT_CHART_WIDTH, DatavizColorBox, DonutChart, DonutChartLegendTable, type ExtendedAxisLabelsFormatterContextObject, type ExtendedTimeTicksInfoObject, GlobalChartStyleOverrides, LineChart, NetworkColorBox, TIME_SERIES_CHART_HEIGHT, type TypeAreaChartProps, type TypeChartDataPoint, type TypeChartDataStyles, type TypeChartLegendLabelProps, type TypeChartLegendProps, type TypeChartNumberFormat, type TypeChartStyleColor, type TypeChartStyleHasOnClick, type TypeChartStylePattern, type TypeChartTableProps, type TypeChartTimeFormat, type TypeChartTooltipDateFormatter, type TypeChartTooltipProps, type TypeChartTooltipTableProps, type TypeChartXAnnotations, type TypeChartXAnnotationsDetails, type TypeChartYAxisLabelFormatter, type TypeColorBoxProps, type TypeDatavizColorBox, type TypeDatavizColorBoxProps, type TypeDonutChartLegendTableProps, type TypeDonutChartProps, type TypeDonutChartTooltipProps, type TypeExtendedChart, type TypeLegendLabel, type TypeLineChartProps, type TypeSeriesType, type TypeVerticalBarChartProps, VERTICAL_BAR_CHART_DEFAULT_SERIES_LIMIT, areaChartOptions, areaChartStyles, baseChartOptions, baseChartStyles, columnChartOptions, donutChartOptions, donutChartStyles, generateChartTooltipPortalId, getDatavizColor, getDatavizColorWithAlpha, getDatavizOpacity, getStorybookCategoricalData, getStorybookSparseTimelineData, isCategoricalHourData, isHourlyTimeData, lineChartOptions, lineChartStyles, timeSeriesChartOptions, timeSeriesChartStyles, transformDataToSeries, transformTimeSeriesTooltipData, xAxisLabelFormatter, yAxisLabelFormatter };
+export { AreaChart, ChartLegend, ChartLegendLabel, ChartTable, ChartTooltip, ChartTooltipFooter, ChartTooltipHeader, ChartTooltipPortal, ChartTooltipTable, ChartTooltipTitle, ChartXAnnotationDetails, ChartXAnnotationMarker, ColorBox, DONUT_CHART_HALO_SIZE, DONUT_CHART_HEIGHT, DONUT_CHART_WIDTH, DatavizColorBox, DonutChart, DonutChartLegendTable, type ExtendedAxisLabelsFormatterContextObject, type ExtendedTimeTicksInfoObject, GlobalChartStyleOverrides, LineChart, NetworkColorBox, TIME_SERIES_CHART_HEIGHT, type TypeAreaChartProps, type TypeChartDataPoint, type TypeChartDataStyles, type TypeChartLegendLabelProps, type TypeChartLegendProps, type TypeChartNumberFormat, type TypeChartStyleColor, type TypeChartStyleHasOnClick, type TypeChartStylePattern, type TypeChartTableProps, type TypeChartTimeFormat, type TypeChartTooltipDateFormatter, type TypeChartTooltipProps, type TypeChartTooltipTableProps, type TypeChartXAnnotations, type TypeChartXAnnotationsDetails, type TypeChartYAxisLabelFormatter, type TypeColorBoxProps, type TypeDatavizColorBox, type TypeDatavizColorBoxProps, type TypeDonutChartDataItem, type TypeDonutChartLegendTableProps, type TypeDonutChartProps, type TypeDonutChartTooltipProps, type TypeExtendedChart, type TypeLegendLabel, type TypeLineChartProps, type TypeSeriesType, type TypeVerticalBarChartProps, VERTICAL_BAR_CHART_DEFAULT_SERIES_LIMIT, VerticalBarChart, areaChartOptions, areaChartStyles, baseChartOptions, baseChartStyles, columnChartOptions, donutChartOptions, donutChartStyles, generateChartTooltipPortalId, getDatavizColor, getDatavizColorWithAlpha, getDatavizOpacity, getStorybookCategoricalData, getStorybookSparseTimelineData, isCategoricalHourData, isHourlyTimeData, lineChartOptions, lineChartStyles, timeSeriesChartOptions, timeSeriesChartStyles, transformDataToSeries, transformTimeSeriesTooltipData, xAxisLabelFormatter, yAxisLabelFormatter };

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { TimeTicksInfoObject, AxisLabelsFormatterContextObject, Chart, Annotatio
 import * as _sproutsocial_seeds_react_box from '@sproutsocial/seeds-react-box';
 import { TypeBoxProps } from '@sproutsocial/seeds-react-box';
 import { Table } from '@sproutsocial/seeds-react-table';
+import { TypeIconName } from '@sproutsocial/seeds-react-icon';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as styled_components from 'styled-components';
 
@@ -228,6 +229,15 @@ type TypeChartTooltipTitleProps = {
 };
 declare const ChartTooltipTitle: react.NamedExoticComponent<TypeChartTooltipTitleProps>;
 
+declare const ChartXAnnotationDetails: react.NamedExoticComponent<Readonly<{
+    iconName: TypeIconName;
+    text: string;
+}>>;
+
+declare const ChartXAnnotationMarker: react.NamedExoticComponent<Readonly<{
+    iconName: TypeIconName;
+}>>;
+
 type TypeColorBoxProps = TypeBoxProps;
 /**
  * ColorBox extends Box to apply basic styles.
@@ -269,13 +279,15 @@ type TypeDonutChartTooltipProps = Readonly<{
     value: number | null;
     icon?: ReactNode;
 }>;
+type TypeDonutChartDataItem = Readonly<{
+    name: string;
+    value: number;
+    key?: string;
+    icon?: ReactNode;
+    styles?: TypeChartDataStyles;
+}>;
 type TypeDonutChartProps = Readonly<{
-    data: ReadonlyArray<Readonly<{
-        name: string;
-        value: number;
-        icon?: ReactNode;
-        styles?: TypeChartDataStyles;
-    }>>;
+    data: ReadonlyArray<TypeDonutChartDataItem>;
     numberLocale: Intl.LocalesArgument;
     textLocale: Intl.LocalesArgument;
     currency?: string;
@@ -283,18 +295,13 @@ type TypeDonutChartProps = Readonly<{
     hideLegend?: boolean;
     numberFormat?: TypeChartNumberFormat;
     tooltip?: ({ color, name, percent, value, }: TypeDonutChartTooltipProps) => ReactNode;
-    onClick?: ({ x }: Readonly<{
+    onClick?: (data: Readonly<{
         x: string;
-    }>) => void;
+    } & TypeDonutChartDataItem>) => void;
     tooltipClickLabel?: ReactNode;
 }>;
 declare const DonutChart: react.NamedExoticComponent<Readonly<{
-    data: ReadonlyArray<Readonly<{
-        name: string;
-        value: number;
-        icon?: ReactNode;
-        styles?: TypeChartDataStyles;
-    }>>;
+    data: ReadonlyArray<TypeDonutChartDataItem>;
     numberLocale: Intl.LocalesArgument;
     textLocale: Intl.LocalesArgument;
     currency?: string;
@@ -302,9 +309,9 @@ declare const DonutChart: react.NamedExoticComponent<Readonly<{
     hideLegend?: boolean;
     numberFormat?: TypeChartNumberFormat;
     tooltip?: ({ color, name, percent, value, }: TypeDonutChartTooltipProps) => ReactNode;
-    onClick?: ({ x }: Readonly<{
+    onClick?: (data: Readonly<{
         x: string;
-    }>) => void;
+    } & TypeDonutChartDataItem>) => void;
     tooltipClickLabel?: ReactNode;
 }>>;
 
@@ -376,6 +383,40 @@ declare const LineChart: react.NamedExoticComponent<Readonly<{
     xAnnotations?: TypeChartXAnnotations;
 }>>;
 
+declare const VerticalBarChart: react.NamedExoticComponent<Readonly<{
+    data: ReadonlyArray<Readonly<{
+        name: string;
+        points: ReadonlyArray<TypeChartDataPoint>;
+        icon?: ReactNode;
+        styles?: TypeChartDataStyles & Readonly<{
+            pattern?: TypeChartStylePattern;
+        }>;
+    }>>;
+    invalidNumberLabel: ReactNode;
+    numberLocale: Intl.LocalesArgument;
+    textLocale: Intl.LocalesArgument;
+    tooltipDateFormatter: TypeChartTooltipDateFormatter;
+    currency?: string;
+    numberFormat?: TypeChartNumberFormat;
+    seriesLimit?: number;
+    showSeriesLimitWarning?: boolean;
+    tooltip?: ({ data, x }: TypeChartTooltipProps) => ReactNode;
+    yAxisLabelFormatter?: TypeChartYAxisLabelFormatter;
+    onClick?: ({ x }: Readonly<{
+        x: number;
+    }>) => void;
+    tooltipClickLabel?: ReactNode;
+    timeFormat?: TypeChartTimeFormat;
+    xAnnotations?: TypeChartXAnnotations;
+    xAxisLabelFormatter?: (params: {
+        textLocale: Intl.LocalesArgument;
+        tickPositions: number[];
+        unitName: string;
+        value: string | number;
+        timeFormat?: string;
+    }) => string;
+}>>;
+
 declare const baseChartOptions: Options;
 declare const TIME_SERIES_CHART_HEIGHT = 275;
 declare const timeSeriesChartOptions: Options;
@@ -510,4 +551,4 @@ declare const donutChartStyles: styled_components.FlattenInterpolation<styled_co
     $hasOnClick: TypeChartStyleHasOnClick;
 }>, any>>;
 
-export { AreaChart, ChartLegend, ChartLegendLabel, ChartTable, ChartTooltip, ChartTooltipFooter, ChartTooltipHeader, ChartTooltipPortal, ChartTooltipTable, ChartTooltipTitle, ColorBox, DONUT_CHART_HALO_SIZE, DONUT_CHART_HEIGHT, DONUT_CHART_WIDTH, DatavizColorBox, DonutChart, DonutChartLegendTable, type ExtendedAxisLabelsFormatterContextObject, type ExtendedTimeTicksInfoObject, GlobalChartStyleOverrides, LineChart, NetworkColorBox, TIME_SERIES_CHART_HEIGHT, type TypeAreaChartProps, type TypeChartDataPoint, type TypeChartDataStyles, type TypeChartLegendLabelProps, type TypeChartLegendProps, type TypeChartNumberFormat, type TypeChartStyleColor, type TypeChartStyleHasOnClick, type TypeChartStylePattern, type TypeChartTableProps, type TypeChartTimeFormat, type TypeChartTooltipDateFormatter, type TypeChartTooltipProps, type TypeChartTooltipTableProps, type TypeChartXAnnotations, type TypeChartXAnnotationsDetails, type TypeChartYAxisLabelFormatter, type TypeColorBoxProps, type TypeDatavizColorBox, type TypeDatavizColorBoxProps, type TypeDonutChartLegendTableProps, type TypeDonutChartProps, type TypeDonutChartTooltipProps, type TypeExtendedChart, type TypeLegendLabel, type TypeLineChartProps, type TypeSeriesType, type TypeVerticalBarChartProps, VERTICAL_BAR_CHART_DEFAULT_SERIES_LIMIT, areaChartOptions, areaChartStyles, baseChartOptions, baseChartStyles, columnChartOptions, donutChartOptions, donutChartStyles, generateChartTooltipPortalId, getDatavizColor, getDatavizColorWithAlpha, getDatavizOpacity, getStorybookCategoricalData, getStorybookSparseTimelineData, isCategoricalHourData, isHourlyTimeData, lineChartOptions, lineChartStyles, timeSeriesChartOptions, timeSeriesChartStyles, transformDataToSeries, transformTimeSeriesTooltipData, xAxisLabelFormatter, yAxisLabelFormatter };
+export { AreaChart, ChartLegend, ChartLegendLabel, ChartTable, ChartTooltip, ChartTooltipFooter, ChartTooltipHeader, ChartTooltipPortal, ChartTooltipTable, ChartTooltipTitle, ChartXAnnotationDetails, ChartXAnnotationMarker, ColorBox, DONUT_CHART_HALO_SIZE, DONUT_CHART_HEIGHT, DONUT_CHART_WIDTH, DatavizColorBox, DonutChart, DonutChartLegendTable, type ExtendedAxisLabelsFormatterContextObject, type ExtendedTimeTicksInfoObject, GlobalChartStyleOverrides, LineChart, NetworkColorBox, TIME_SERIES_CHART_HEIGHT, type TypeAreaChartProps, type TypeChartDataPoint, type TypeChartDataStyles, type TypeChartLegendLabelProps, type TypeChartLegendProps, type TypeChartNumberFormat, type TypeChartStyleColor, type TypeChartStyleHasOnClick, type TypeChartStylePattern, type TypeChartTableProps, type TypeChartTimeFormat, type TypeChartTooltipDateFormatter, type TypeChartTooltipProps, type TypeChartTooltipTableProps, type TypeChartXAnnotations, type TypeChartXAnnotationsDetails, type TypeChartYAxisLabelFormatter, type TypeColorBoxProps, type TypeDatavizColorBox, type TypeDatavizColorBoxProps, type TypeDonutChartDataItem, type TypeDonutChartLegendTableProps, type TypeDonutChartProps, type TypeDonutChartTooltipProps, type TypeExtendedChart, type TypeLegendLabel, type TypeLineChartProps, type TypeSeriesType, type TypeVerticalBarChartProps, VERTICAL_BAR_CHART_DEFAULT_SERIES_LIMIT, VerticalBarChart, areaChartOptions, areaChartStyles, baseChartOptions, baseChartStyles, columnChartOptions, donutChartOptions, donutChartStyles, generateChartTooltipPortalId, getDatavizColor, getDatavizColorWithAlpha, getDatavizOpacity, getStorybookCategoricalData, getStorybookSparseTimelineData, isCategoricalHourData, isHourlyTimeData, lineChartOptions, lineChartStyles, timeSeriesChartOptions, timeSeriesChartStyles, transformDataToSeries, transformTimeSeriesTooltipData, xAxisLabelFormatter, yAxisLabelFormatter };