@automattic/charts 1.11.0 → 1.12.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/CHANGELOG.md +10 -2
- package/TOKENS.md +12 -1
- package/dist/index.cjs +751 -97
- package/dist/index.cjs.map +1 -1
- package/dist/index.css +11 -28
- package/dist/index.d.cts +58 -6
- package/dist/index.d.ts +58 -6
- package/dist/index.js +751 -97
- package/dist/index.js.map +1 -1
- package/package.json +2 -1
- package/src/charts/area-chart/area-chart.tsx +28 -8
- package/src/charts/area-chart/test/area-chart.test.tsx +102 -0
- package/src/charts/area-chart/types.ts +20 -6
- package/src/charts/bar-chart/bar-chart.tsx +33 -9
- package/src/charts/bar-chart/test/bar-chart.test.tsx +117 -0
- package/src/charts/line-chart/line-chart.tsx +40 -5
- package/src/charts/line-chart/test/line-chart.test.tsx +190 -1
- package/src/charts/line-chart/types.ts +14 -0
- package/src/charts/private/x-zoom/index.ts +1 -0
- package/src/charts/private/{test → x-zoom/test}/x-zoom.test.tsx +46 -3
- package/src/charts/private/x-zoom/x-zoom.module.scss +43 -0
- package/src/charts/private/{x-zoom.tsx → x-zoom/x-zoom.tsx} +52 -24
- package/src/components/legend/hooks/test/use-chart-legend-items.test.tsx +152 -0
- package/src/components/legend/hooks/use-chart-legend-items.ts +118 -16
- package/src/components/legend/private/base-legend.tsx +21 -9
- package/src/components/legend/test/legend-config-types.test.tsx +32 -0
- package/src/components/legend/test/legend.test.tsx +121 -1
- package/src/components/legend/types.ts +6 -0
- package/src/index.ts +1 -0
- package/src/types.ts +16 -0
- package/src/charts/private/x-zoom.module.scss +0 -50
package/dist/index.css
CHANGED
|
@@ -99,45 +99,28 @@
|
|
|
99
99
|
min-width: 0;
|
|
100
100
|
min-height: 0;
|
|
101
101
|
}
|
|
102
|
-
.a8ccharts-
|
|
103
|
-
fill: #
|
|
104
|
-
|
|
102
|
+
.a8ccharts-ur9dWW-x-zoom__selection {
|
|
103
|
+
fill: var(--a8c-charts-color-zoom-selection, var(--wpds-color-background-interactive-brand-strong, #3858e9));
|
|
104
|
+
fill-opacity: .16;
|
|
105
|
+
stroke: var(--a8c-charts-color-zoom-selection-stroke, var(--wpds-color-stroke-interactive-brand, #3858e9));
|
|
106
|
+
stroke-opacity: .65;
|
|
105
107
|
stroke-width: var(--wpds-border-width-xs, 1px);
|
|
106
108
|
pointer-events: none;
|
|
107
109
|
}
|
|
108
110
|
|
|
109
|
-
.a8ccharts-
|
|
111
|
+
.a8ccharts-ur9dWW-x-zoom__reset {
|
|
110
112
|
top: var(--wpds-dimension-gap-sm, 8px);
|
|
111
113
|
right: var(--wpds-dimension-gap-sm, 8px);
|
|
112
114
|
z-index: 2;
|
|
113
|
-
width: 28px;
|
|
114
|
-
height: 28px;
|
|
115
|
-
color: var(--wpds-color-foreground-content-neutral, #1e1e1e);
|
|
116
|
-
border: var(--wpds-border-width-xs, 1px) solid #00000029;
|
|
117
|
-
border-radius: var(--wpds-border-radius-md, 4px);
|
|
118
|
-
cursor: pointer;
|
|
119
115
|
box-shadow: var(--wpds-elevation-xs, 0 1px 1px 0 #00000008, 0 1px 2px 0 #00000005, 0 3px 3px 0 #00000005, 0 4px 4px 0 #00000003);
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
padding: 0;
|
|
124
|
-
display: inline-flex;
|
|
116
|
+
--wp-ui-button-aspect-ratio: 1;
|
|
117
|
+
--wp-ui-button-padding-inline: 0;
|
|
118
|
+
--wp-ui-button-min-width: unset;
|
|
125
119
|
position: absolute;
|
|
126
120
|
}
|
|
127
121
|
|
|
128
|
-
.a8ccharts-
|
|
129
|
-
background: #fff;
|
|
130
|
-
}
|
|
131
|
-
|
|
132
|
-
.a8ccharts-y6bXNq-x-zoom__reset:focus-visible {
|
|
133
|
-
outline: 2px solid var(--a8c-charts-color-focus, var(--wpds-color-stroke-focus, #3858e9));
|
|
134
|
-
outline-offset: 1px;
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
.a8ccharts-y6bXNq-x-zoom__reset-icon {
|
|
138
|
-
flex-shrink: 0;
|
|
139
|
-
width: 16px;
|
|
140
|
-
height: 16px;
|
|
122
|
+
.a8ccharts-ur9dWW-x-zoom__reset:not(:hover, :active, :focus) {
|
|
123
|
+
background-color: var(--a8c-charts-color-background, var(--wpds-color-background-surface-neutral-strong, #fff));
|
|
141
124
|
}
|
|
142
125
|
.a8ccharts-inuQka-line-chart {
|
|
143
126
|
position: relative;
|
package/dist/index.d.cts
CHANGED
|
@@ -481,6 +481,21 @@ type ChartLegendConfig<T = DataPoint | DataPointDate | LeaderboardEntry> = {
|
|
|
481
481
|
*/
|
|
482
482
|
shapeStyles?: LegendShapeStyles;
|
|
483
483
|
};
|
|
484
|
+
/**
|
|
485
|
+
* Legend config for charts built from `SeriesData` (line, bar, area). Adds `collapseGroups` on top
|
|
486
|
+
* of the shared config. It is intentionally absent from the base `ChartLegendConfig` so point-based
|
|
487
|
+
* charts (pie, semi-circle pie) — whose data points carry `group` only to coordinate colours — can't
|
|
488
|
+
* set it.
|
|
489
|
+
*/
|
|
490
|
+
type SeriesChartLegendConfig = ChartLegendConfig<SeriesData[]> & {
|
|
491
|
+
/**
|
|
492
|
+
* Collapse series that share a `group` into a single legend item, labelled by the group's
|
|
493
|
+
* primary series (its first non-comparison member). Off by default, so every series keeps its
|
|
494
|
+
* own item. Combines with `interactive`: a collapsed item toggles every series in its group, an
|
|
495
|
+
* uncollapsed one toggles only its own.
|
|
496
|
+
*/
|
|
497
|
+
collapseGroups?: boolean;
|
|
498
|
+
};
|
|
484
499
|
/**
|
|
485
500
|
* Base properties shared across all chart components
|
|
486
501
|
*/
|
|
@@ -644,6 +659,12 @@ type BaseLegendItem = {
|
|
|
644
659
|
glyphSize?: number;
|
|
645
660
|
renderGlyph?: <Datum extends object>(props: GlyphProps<Datum>) => ReactNode;
|
|
646
661
|
shapeStyle?: CSSProperties & LineStyles$1;
|
|
662
|
+
/**
|
|
663
|
+
* The series labels this legend item controls. For a grouped item this is every series
|
|
664
|
+
* sharing the group (primary first); for a single series it is just its own label. Used by
|
|
665
|
+
* the interactive legend to toggle a whole group's visibility from one item.
|
|
666
|
+
*/
|
|
667
|
+
seriesLabels?: string[];
|
|
647
668
|
};
|
|
648
669
|
//#endregion
|
|
649
670
|
//#region src/components/legend/legend.d.ts
|
|
@@ -661,6 +682,11 @@ interface ChartLegendOptions {
|
|
|
661
682
|
showValues?: boolean;
|
|
662
683
|
legendValueDisplay?: LegendValueDisplay;
|
|
663
684
|
legendShape?: LegendShape<SeriesData[], number>;
|
|
685
|
+
/**
|
|
686
|
+
* Collapse series that share a `group` into a single legend item, labelled by the group's
|
|
687
|
+
* primary series. Off by default, so every series gets its own item.
|
|
688
|
+
*/
|
|
689
|
+
collapseGroups?: boolean;
|
|
664
690
|
}
|
|
665
691
|
/**
|
|
666
692
|
* Hook to transform chart data into legend items
|
|
@@ -736,6 +762,10 @@ type RenderLineGlyphProps<Datum extends object> = GlyphProps<Datum> & {
|
|
|
736
762
|
position?: 'start' | 'end';
|
|
737
763
|
};
|
|
738
764
|
interface LineChartProps extends BaseChartProps<SeriesData[]> {
|
|
765
|
+
/**
|
|
766
|
+
* Legend configuration. Supports `collapseGroups` on top of the shared options.
|
|
767
|
+
*/
|
|
768
|
+
legend?: SeriesChartLegendConfig;
|
|
739
769
|
withGradientFill: boolean;
|
|
740
770
|
smoothing?: boolean;
|
|
741
771
|
curveType?: CurveType;
|
|
@@ -755,6 +785,15 @@ interface LineChartProps extends BaseChartProps<SeriesData[]> {
|
|
|
755
785
|
* button appears in the top-right of the chart while zoomed.
|
|
756
786
|
*/
|
|
757
787
|
zoomable?: boolean;
|
|
788
|
+
/**
|
|
789
|
+
* Whether the Y axis rescales to fit only the visible series when series are
|
|
790
|
+
* hidden or shown through the interactive legend.
|
|
791
|
+
* Defaults to `true` (the pre-existing behaviour). Set to `false` to pin the Y
|
|
792
|
+
* axis to the full data extent so hiding series does not move the chart's
|
|
793
|
+
* baseline — useful for comparison charts. Matches `AreaChart`.
|
|
794
|
+
* @default true
|
|
795
|
+
*/
|
|
796
|
+
rescaleYOnVisibilityChange?: boolean;
|
|
758
797
|
children?: ReactNode;
|
|
759
798
|
}
|
|
760
799
|
type TooltipDatum = {
|
|
@@ -764,6 +803,10 @@ type TooltipDatum = {
|
|
|
764
803
|
//#endregion
|
|
765
804
|
//#region src/charts/area-chart/types.d.ts
|
|
766
805
|
interface AreaChartProps extends BaseChartProps<SeriesData[]> {
|
|
806
|
+
/**
|
|
807
|
+
* Legend configuration. Supports `collapseGroups` on top of the shared options.
|
|
808
|
+
*/
|
|
809
|
+
legend?: SeriesChartLegendConfig;
|
|
767
810
|
/**
|
|
768
811
|
* Whether series should be stacked on top of each other.
|
|
769
812
|
* When false, series are rendered as overlapping filled areas.
|
|
@@ -814,13 +857,18 @@ interface AreaChartProps extends BaseChartProps<SeriesData[]> {
|
|
|
814
857
|
*/
|
|
815
858
|
zoomable?: boolean;
|
|
816
859
|
/**
|
|
817
|
-
*
|
|
818
|
-
*
|
|
819
|
-
*
|
|
820
|
-
* the
|
|
821
|
-
* not move the chart's baseline.
|
|
860
|
+
* Whether the Y axis rescales to fit only the visible series when series are
|
|
861
|
+
* hidden or shown through the interactive legend.
|
|
862
|
+
* Defaults to `true`, matching LineChart. Set to `false` to pin the Y axis to
|
|
863
|
+
* the full data extent so hiding series does not move the chart's baseline.
|
|
822
864
|
* @default true
|
|
823
865
|
*/
|
|
866
|
+
rescaleYOnVisibilityChange?: boolean;
|
|
867
|
+
/**
|
|
868
|
+
* @deprecated Use `rescaleYOnVisibilityChange`. The behaviour keys off series
|
|
869
|
+
* visibility changing, not specifically a legend toggle. Still honoured when
|
|
870
|
+
* `rescaleYOnVisibilityChange` is not set.
|
|
871
|
+
*/
|
|
824
872
|
rescaleYOnLegendToggle?: boolean;
|
|
825
873
|
children?: ReactNode;
|
|
826
874
|
}
|
|
@@ -859,6 +907,10 @@ declare const AreaChartResponsive: AreaChartResponsiveComponent;
|
|
|
859
907
|
//#endregion
|
|
860
908
|
//#region src/charts/bar-chart/bar-chart.d.ts
|
|
861
909
|
interface BarChartProps extends BaseChartProps<SeriesData[]> {
|
|
910
|
+
/**
|
|
911
|
+
* Legend configuration. Supports `collapseGroups` on top of the shared options.
|
|
912
|
+
*/
|
|
913
|
+
legend?: SeriesChartLegendConfig;
|
|
862
914
|
renderTooltip?: (params: RenderTooltipParams<DataPointDate>) => ReactNode;
|
|
863
915
|
orientation?: 'horizontal' | 'vertical';
|
|
864
916
|
withPatterns?: boolean;
|
|
@@ -2008,5 +2060,5 @@ declare const useGlobalChartsTheme: () => CompleteChartTheme;
|
|
|
2008
2060
|
*/
|
|
2009
2061
|
declare const defaultTheme: CompleteChartTheme;
|
|
2010
2062
|
//#endregion
|
|
2011
|
-
export { AccessibleTooltip, type AnnotationStyles, type ArcData, AreaChartResponsive as AreaChart, type AreaChartProps, AreaChart as AreaChartUnresponsive, type AxisOptions, BarChartResponsive as BarChart, type BarChartProps, BarChart as BarChartUnresponsive, BarListChartResponsive as BarListChart, type BarListChartProps, BarListChart as BarListChartUnresponsive, type BaseChartProps, type BaseLegendItem, type BaseLegendProps, BaseTooltip, type BaseTooltipProps, type CalendarHeatmapResult, type ChartLegendConfig, type ChartLegendOptions, type ChartTheme, type CompleteChartTheme, ConversionFunnelChartWithProvider as ConversionFunnelChart, type ConversionFunnelChartProps, type CurveType, type DataPoint, type DataPointDate, type DataPointPercentage, type EventHandlerParams, type FunnelStep, GeoChartResponsive as GeoChart, type GeoChartError, type GeoChartProps, GeoChartWithProvider as GeoChartUnresponsive, type GeoData, type GeoRegion, type GeoResolution, GlobalChartsContext, GlobalChartsProvider, GlobalChartsProvider as ThemeProvider, type GoogleDataTableColumn, type GoogleDataTableColumnRoleType, type GoogleDataTableRow, type GradientConfig, type GradientStop, type GridProps, type GridStyles, type HeatmapCell, HeatmapChartResponsive as HeatmapChart, type HeatmapChartProps, HeatmapChart as HeatmapChartUnresponsive, type HeatmapColumn, type HeatmapTooltipData, LeaderboardChartResponsive as LeaderboardChart, type LeaderboardChartProps, LeaderboardChart as LeaderboardChartUnresponsive, type LeaderboardEntry, Legend, type LegendItemStyles, type LegendLabelStyles, type LegendPosition, type LegendProps, type LegendShape, type LegendShapeLabel, type LegendShapeRenderProps, type LegendShapeStyles, type LegendValueDisplay, LineChartResponsive as LineChart, type LineChartAnnotationProps, type LineChartProps, LineChart as LineChartUnresponsive, type LineStyles, type MainMetricRenderProps, type MetricValueType, type MultipleDataPointsDate, type Optional, type OrientationType, PieChartResponsive as PieChart, type PieChartProps, type PieChartRenderTooltipParams, PieChart as PieChartUnresponsive, PieSemiCircleChartResponsive as PieSemiCircleChart, type PieSemiCircleChartProps, type PieSemiCircleChartRenderTooltipParams, PieSemiCircleChart as PieSemiCircleChartUnresponsive, type RenderLabelProps, type RenderLineGlyphProps, type RenderTooltipGlyphProps, type RenderTooltipParams, type RenderValueProps, type ScaleOptions, type SeriesData, type SeriesDataOptions, Sparkline, type SparklineDataPoint, type SparklineProps, SparklineUnresponsive, type StepLabelRenderProps, type StepRateRenderProps, type TooltipData, type TooltipDatum, type TooltipProps, type TooltipRenderProps, type TrendDirection, TrendIndicator, type TrendIndicatorProps, type XyChartTooltipProps, buildCalendarHeatmapData, defaultTheme, formatMetricValue, formatPercentage, getColorDistance, hexToRgba, isValidHexColor, lightenHexColor, mergeThemes, mixHexColors, normalizeColorToHex, parseAsLocalDate, parseHslString, parseRgbString, prefersLightText, relativeLuminance, useChartLegendItems, useGlobalChartsContext, useGlobalChartsTheme, useLeaderboardLegendItems, validateHexColor };
|
|
2063
|
+
export { AccessibleTooltip, type AnnotationStyles, type ArcData, AreaChartResponsive as AreaChart, type AreaChartProps, AreaChart as AreaChartUnresponsive, type AxisOptions, BarChartResponsive as BarChart, type BarChartProps, BarChart as BarChartUnresponsive, BarListChartResponsive as BarListChart, type BarListChartProps, BarListChart as BarListChartUnresponsive, type BaseChartProps, type BaseLegendItem, type BaseLegendProps, BaseTooltip, type BaseTooltipProps, type CalendarHeatmapResult, type ChartLegendConfig, type ChartLegendOptions, type ChartTheme, type CompleteChartTheme, ConversionFunnelChartWithProvider as ConversionFunnelChart, type ConversionFunnelChartProps, type CurveType, type DataPoint, type DataPointDate, type DataPointPercentage, type EventHandlerParams, type FunnelStep, GeoChartResponsive as GeoChart, type GeoChartError, type GeoChartProps, GeoChartWithProvider as GeoChartUnresponsive, type GeoData, type GeoRegion, type GeoResolution, GlobalChartsContext, GlobalChartsProvider, GlobalChartsProvider as ThemeProvider, type GoogleDataTableColumn, type GoogleDataTableColumnRoleType, type GoogleDataTableRow, type GradientConfig, type GradientStop, type GridProps, type GridStyles, type HeatmapCell, HeatmapChartResponsive as HeatmapChart, type HeatmapChartProps, HeatmapChart as HeatmapChartUnresponsive, type HeatmapColumn, type HeatmapTooltipData, LeaderboardChartResponsive as LeaderboardChart, type LeaderboardChartProps, LeaderboardChart as LeaderboardChartUnresponsive, type LeaderboardEntry, Legend, type LegendItemStyles, type LegendLabelStyles, type LegendPosition, type LegendProps, type LegendShape, type LegendShapeLabel, type LegendShapeRenderProps, type LegendShapeStyles, type LegendValueDisplay, LineChartResponsive as LineChart, type LineChartAnnotationProps, type LineChartProps, LineChart as LineChartUnresponsive, type LineStyles, type MainMetricRenderProps, type MetricValueType, type MultipleDataPointsDate, type Optional, type OrientationType, PieChartResponsive as PieChart, type PieChartProps, type PieChartRenderTooltipParams, PieChart as PieChartUnresponsive, PieSemiCircleChartResponsive as PieSemiCircleChart, type PieSemiCircleChartProps, type PieSemiCircleChartRenderTooltipParams, PieSemiCircleChart as PieSemiCircleChartUnresponsive, type RenderLabelProps, type RenderLineGlyphProps, type RenderTooltipGlyphProps, type RenderTooltipParams, type RenderValueProps, type ScaleOptions, type SeriesChartLegendConfig, type SeriesData, type SeriesDataOptions, Sparkline, type SparklineDataPoint, type SparklineProps, SparklineUnresponsive, type StepLabelRenderProps, type StepRateRenderProps, type TooltipData, type TooltipDatum, type TooltipProps, type TooltipRenderProps, type TrendDirection, TrendIndicator, type TrendIndicatorProps, type XyChartTooltipProps, buildCalendarHeatmapData, defaultTheme, formatMetricValue, formatPercentage, getColorDistance, hexToRgba, isValidHexColor, lightenHexColor, mergeThemes, mixHexColors, normalizeColorToHex, parseAsLocalDate, parseHslString, parseRgbString, prefersLightText, relativeLuminance, useChartLegendItems, useGlobalChartsContext, useGlobalChartsTheme, useLeaderboardLegendItems, validateHexColor };
|
|
2012
2064
|
//# sourceMappingURL=index.d.cts.map
|
package/dist/index.d.ts
CHANGED
|
@@ -481,6 +481,21 @@ type ChartLegendConfig<T = DataPoint | DataPointDate | LeaderboardEntry> = {
|
|
|
481
481
|
*/
|
|
482
482
|
shapeStyles?: LegendShapeStyles;
|
|
483
483
|
};
|
|
484
|
+
/**
|
|
485
|
+
* Legend config for charts built from `SeriesData` (line, bar, area). Adds `collapseGroups` on top
|
|
486
|
+
* of the shared config. It is intentionally absent from the base `ChartLegendConfig` so point-based
|
|
487
|
+
* charts (pie, semi-circle pie) — whose data points carry `group` only to coordinate colours — can't
|
|
488
|
+
* set it.
|
|
489
|
+
*/
|
|
490
|
+
type SeriesChartLegendConfig = ChartLegendConfig<SeriesData[]> & {
|
|
491
|
+
/**
|
|
492
|
+
* Collapse series that share a `group` into a single legend item, labelled by the group's
|
|
493
|
+
* primary series (its first non-comparison member). Off by default, so every series keeps its
|
|
494
|
+
* own item. Combines with `interactive`: a collapsed item toggles every series in its group, an
|
|
495
|
+
* uncollapsed one toggles only its own.
|
|
496
|
+
*/
|
|
497
|
+
collapseGroups?: boolean;
|
|
498
|
+
};
|
|
484
499
|
/**
|
|
485
500
|
* Base properties shared across all chart components
|
|
486
501
|
*/
|
|
@@ -644,6 +659,12 @@ type BaseLegendItem = {
|
|
|
644
659
|
glyphSize?: number;
|
|
645
660
|
renderGlyph?: <Datum extends object>(props: GlyphProps<Datum>) => ReactNode;
|
|
646
661
|
shapeStyle?: CSSProperties & LineStyles$1;
|
|
662
|
+
/**
|
|
663
|
+
* The series labels this legend item controls. For a grouped item this is every series
|
|
664
|
+
* sharing the group (primary first); for a single series it is just its own label. Used by
|
|
665
|
+
* the interactive legend to toggle a whole group's visibility from one item.
|
|
666
|
+
*/
|
|
667
|
+
seriesLabels?: string[];
|
|
647
668
|
};
|
|
648
669
|
//#endregion
|
|
649
670
|
//#region src/components/legend/legend.d.ts
|
|
@@ -661,6 +682,11 @@ interface ChartLegendOptions {
|
|
|
661
682
|
showValues?: boolean;
|
|
662
683
|
legendValueDisplay?: LegendValueDisplay;
|
|
663
684
|
legendShape?: LegendShape<SeriesData[], number>;
|
|
685
|
+
/**
|
|
686
|
+
* Collapse series that share a `group` into a single legend item, labelled by the group's
|
|
687
|
+
* primary series. Off by default, so every series gets its own item.
|
|
688
|
+
*/
|
|
689
|
+
collapseGroups?: boolean;
|
|
664
690
|
}
|
|
665
691
|
/**
|
|
666
692
|
* Hook to transform chart data into legend items
|
|
@@ -736,6 +762,10 @@ type RenderLineGlyphProps<Datum extends object> = GlyphProps<Datum> & {
|
|
|
736
762
|
position?: 'start' | 'end';
|
|
737
763
|
};
|
|
738
764
|
interface LineChartProps extends BaseChartProps<SeriesData[]> {
|
|
765
|
+
/**
|
|
766
|
+
* Legend configuration. Supports `collapseGroups` on top of the shared options.
|
|
767
|
+
*/
|
|
768
|
+
legend?: SeriesChartLegendConfig;
|
|
739
769
|
withGradientFill: boolean;
|
|
740
770
|
smoothing?: boolean;
|
|
741
771
|
curveType?: CurveType;
|
|
@@ -755,6 +785,15 @@ interface LineChartProps extends BaseChartProps<SeriesData[]> {
|
|
|
755
785
|
* button appears in the top-right of the chart while zoomed.
|
|
756
786
|
*/
|
|
757
787
|
zoomable?: boolean;
|
|
788
|
+
/**
|
|
789
|
+
* Whether the Y axis rescales to fit only the visible series when series are
|
|
790
|
+
* hidden or shown through the interactive legend.
|
|
791
|
+
* Defaults to `true` (the pre-existing behaviour). Set to `false` to pin the Y
|
|
792
|
+
* axis to the full data extent so hiding series does not move the chart's
|
|
793
|
+
* baseline — useful for comparison charts. Matches `AreaChart`.
|
|
794
|
+
* @default true
|
|
795
|
+
*/
|
|
796
|
+
rescaleYOnVisibilityChange?: boolean;
|
|
758
797
|
children?: ReactNode;
|
|
759
798
|
}
|
|
760
799
|
type TooltipDatum = {
|
|
@@ -764,6 +803,10 @@ type TooltipDatum = {
|
|
|
764
803
|
//#endregion
|
|
765
804
|
//#region src/charts/area-chart/types.d.ts
|
|
766
805
|
interface AreaChartProps extends BaseChartProps<SeriesData[]> {
|
|
806
|
+
/**
|
|
807
|
+
* Legend configuration. Supports `collapseGroups` on top of the shared options.
|
|
808
|
+
*/
|
|
809
|
+
legend?: SeriesChartLegendConfig;
|
|
767
810
|
/**
|
|
768
811
|
* Whether series should be stacked on top of each other.
|
|
769
812
|
* When false, series are rendered as overlapping filled areas.
|
|
@@ -814,13 +857,18 @@ interface AreaChartProps extends BaseChartProps<SeriesData[]> {
|
|
|
814
857
|
*/
|
|
815
858
|
zoomable?: boolean;
|
|
816
859
|
/**
|
|
817
|
-
*
|
|
818
|
-
*
|
|
819
|
-
*
|
|
820
|
-
* the
|
|
821
|
-
* not move the chart's baseline.
|
|
860
|
+
* Whether the Y axis rescales to fit only the visible series when series are
|
|
861
|
+
* hidden or shown through the interactive legend.
|
|
862
|
+
* Defaults to `true`, matching LineChart. Set to `false` to pin the Y axis to
|
|
863
|
+
* the full data extent so hiding series does not move the chart's baseline.
|
|
822
864
|
* @default true
|
|
823
865
|
*/
|
|
866
|
+
rescaleYOnVisibilityChange?: boolean;
|
|
867
|
+
/**
|
|
868
|
+
* @deprecated Use `rescaleYOnVisibilityChange`. The behaviour keys off series
|
|
869
|
+
* visibility changing, not specifically a legend toggle. Still honoured when
|
|
870
|
+
* `rescaleYOnVisibilityChange` is not set.
|
|
871
|
+
*/
|
|
824
872
|
rescaleYOnLegendToggle?: boolean;
|
|
825
873
|
children?: ReactNode;
|
|
826
874
|
}
|
|
@@ -859,6 +907,10 @@ declare const AreaChartResponsive: AreaChartResponsiveComponent;
|
|
|
859
907
|
//#endregion
|
|
860
908
|
//#region src/charts/bar-chart/bar-chart.d.ts
|
|
861
909
|
interface BarChartProps extends BaseChartProps<SeriesData[]> {
|
|
910
|
+
/**
|
|
911
|
+
* Legend configuration. Supports `collapseGroups` on top of the shared options.
|
|
912
|
+
*/
|
|
913
|
+
legend?: SeriesChartLegendConfig;
|
|
862
914
|
renderTooltip?: (params: RenderTooltipParams<DataPointDate>) => ReactNode;
|
|
863
915
|
orientation?: 'horizontal' | 'vertical';
|
|
864
916
|
withPatterns?: boolean;
|
|
@@ -2008,5 +2060,5 @@ declare const useGlobalChartsTheme: () => CompleteChartTheme;
|
|
|
2008
2060
|
*/
|
|
2009
2061
|
declare const defaultTheme: CompleteChartTheme;
|
|
2010
2062
|
//#endregion
|
|
2011
|
-
export { AccessibleTooltip, type AnnotationStyles, type ArcData, AreaChartResponsive as AreaChart, type AreaChartProps, AreaChart as AreaChartUnresponsive, type AxisOptions, BarChartResponsive as BarChart, type BarChartProps, BarChart as BarChartUnresponsive, BarListChartResponsive as BarListChart, type BarListChartProps, BarListChart as BarListChartUnresponsive, type BaseChartProps, type BaseLegendItem, type BaseLegendProps, BaseTooltip, type BaseTooltipProps, type CalendarHeatmapResult, type ChartLegendConfig, type ChartLegendOptions, type ChartTheme, type CompleteChartTheme, ConversionFunnelChartWithProvider as ConversionFunnelChart, type ConversionFunnelChartProps, type CurveType, type DataPoint, type DataPointDate, type DataPointPercentage, type EventHandlerParams, type FunnelStep, GeoChartResponsive as GeoChart, type GeoChartError, type GeoChartProps, GeoChartWithProvider as GeoChartUnresponsive, type GeoData, type GeoRegion, type GeoResolution, GlobalChartsContext, GlobalChartsProvider, GlobalChartsProvider as ThemeProvider, type GoogleDataTableColumn, type GoogleDataTableColumnRoleType, type GoogleDataTableRow, type GradientConfig, type GradientStop, type GridProps, type GridStyles, type HeatmapCell, HeatmapChartResponsive as HeatmapChart, type HeatmapChartProps, HeatmapChart as HeatmapChartUnresponsive, type HeatmapColumn, type HeatmapTooltipData, LeaderboardChartResponsive as LeaderboardChart, type LeaderboardChartProps, LeaderboardChart as LeaderboardChartUnresponsive, type LeaderboardEntry, Legend, type LegendItemStyles, type LegendLabelStyles, type LegendPosition, type LegendProps, type LegendShape, type LegendShapeLabel, type LegendShapeRenderProps, type LegendShapeStyles, type LegendValueDisplay, LineChartResponsive as LineChart, type LineChartAnnotationProps, type LineChartProps, LineChart as LineChartUnresponsive, type LineStyles, type MainMetricRenderProps, type MetricValueType, type MultipleDataPointsDate, type Optional, type OrientationType, PieChartResponsive as PieChart, type PieChartProps, type PieChartRenderTooltipParams, PieChart as PieChartUnresponsive, PieSemiCircleChartResponsive as PieSemiCircleChart, type PieSemiCircleChartProps, type PieSemiCircleChartRenderTooltipParams, PieSemiCircleChart as PieSemiCircleChartUnresponsive, type RenderLabelProps, type RenderLineGlyphProps, type RenderTooltipGlyphProps, type RenderTooltipParams, type RenderValueProps, type ScaleOptions, type SeriesData, type SeriesDataOptions, Sparkline, type SparklineDataPoint, type SparklineProps, SparklineUnresponsive, type StepLabelRenderProps, type StepRateRenderProps, type TooltipData, type TooltipDatum, type TooltipProps, type TooltipRenderProps, type TrendDirection, TrendIndicator, type TrendIndicatorProps, type XyChartTooltipProps, buildCalendarHeatmapData, defaultTheme, formatMetricValue, formatPercentage, getColorDistance, hexToRgba, isValidHexColor, lightenHexColor, mergeThemes, mixHexColors, normalizeColorToHex, parseAsLocalDate, parseHslString, parseRgbString, prefersLightText, relativeLuminance, useChartLegendItems, useGlobalChartsContext, useGlobalChartsTheme, useLeaderboardLegendItems, validateHexColor };
|
|
2063
|
+
export { AccessibleTooltip, type AnnotationStyles, type ArcData, AreaChartResponsive as AreaChart, type AreaChartProps, AreaChart as AreaChartUnresponsive, type AxisOptions, BarChartResponsive as BarChart, type BarChartProps, BarChart as BarChartUnresponsive, BarListChartResponsive as BarListChart, type BarListChartProps, BarListChart as BarListChartUnresponsive, type BaseChartProps, type BaseLegendItem, type BaseLegendProps, BaseTooltip, type BaseTooltipProps, type CalendarHeatmapResult, type ChartLegendConfig, type ChartLegendOptions, type ChartTheme, type CompleteChartTheme, ConversionFunnelChartWithProvider as ConversionFunnelChart, type ConversionFunnelChartProps, type CurveType, type DataPoint, type DataPointDate, type DataPointPercentage, type EventHandlerParams, type FunnelStep, GeoChartResponsive as GeoChart, type GeoChartError, type GeoChartProps, GeoChartWithProvider as GeoChartUnresponsive, type GeoData, type GeoRegion, type GeoResolution, GlobalChartsContext, GlobalChartsProvider, GlobalChartsProvider as ThemeProvider, type GoogleDataTableColumn, type GoogleDataTableColumnRoleType, type GoogleDataTableRow, type GradientConfig, type GradientStop, type GridProps, type GridStyles, type HeatmapCell, HeatmapChartResponsive as HeatmapChart, type HeatmapChartProps, HeatmapChart as HeatmapChartUnresponsive, type HeatmapColumn, type HeatmapTooltipData, LeaderboardChartResponsive as LeaderboardChart, type LeaderboardChartProps, LeaderboardChart as LeaderboardChartUnresponsive, type LeaderboardEntry, Legend, type LegendItemStyles, type LegendLabelStyles, type LegendPosition, type LegendProps, type LegendShape, type LegendShapeLabel, type LegendShapeRenderProps, type LegendShapeStyles, type LegendValueDisplay, LineChartResponsive as LineChart, type LineChartAnnotationProps, type LineChartProps, LineChart as LineChartUnresponsive, type LineStyles, type MainMetricRenderProps, type MetricValueType, type MultipleDataPointsDate, type Optional, type OrientationType, PieChartResponsive as PieChart, type PieChartProps, type PieChartRenderTooltipParams, PieChart as PieChartUnresponsive, PieSemiCircleChartResponsive as PieSemiCircleChart, type PieSemiCircleChartProps, type PieSemiCircleChartRenderTooltipParams, PieSemiCircleChart as PieSemiCircleChartUnresponsive, type RenderLabelProps, type RenderLineGlyphProps, type RenderTooltipGlyphProps, type RenderTooltipParams, type RenderValueProps, type ScaleOptions, type SeriesChartLegendConfig, type SeriesData, type SeriesDataOptions, Sparkline, type SparklineDataPoint, type SparklineProps, SparklineUnresponsive, type StepLabelRenderProps, type StepRateRenderProps, type TooltipData, type TooltipDatum, type TooltipProps, type TooltipRenderProps, type TrendDirection, TrendIndicator, type TrendIndicatorProps, type XyChartTooltipProps, buildCalendarHeatmapData, defaultTheme, formatMetricValue, formatPercentage, getColorDistance, hexToRgba, isValidHexColor, lightenHexColor, mergeThemes, mixHexColors, normalizeColorToHex, parseAsLocalDate, parseHslString, parseRgbString, prefersLightText, relativeLuminance, useChartLegendItems, useGlobalChartsContext, useGlobalChartsTheme, useLeaderboardLegendItems, validateHexColor };
|
|
2012
2064
|
//# sourceMappingURL=index.d.ts.map
|