@actioneer/ads 0.5.3 → 0.5.4

package/components/chart.d.ts

@@ -78,6 +78,7 @@ interface BaseChartProps {
     annotations?: ChartAnnotation[];
     /** Plot height in px (the frame is fluid-width). */
     height?: number;
+    /** Interior gridlines. OFF by default — the two axis lines carry the frame. */
     grid?: boolean;
     /** Defaults to on when there is more than one series. */
     legend?: boolean;
@@ -99,17 +100,27 @@ export interface LineChartProps extends BaseChartProps {
     curve?: "linear" | "natural" | "step";
     /** Series keys that render dashed — projections, not observations. */
     forecastKeys?: string[];
+    /**
+     * Print each observation's value above its dot. On by default for a SINGLE
+     * series (the reader shouldn't have to hover to read a number that fits);
+     * off once there are several, where the labels would collide.
+     */
+    showValues?: boolean;
 }
 export interface AreaChartProps extends BaseChartProps {
     curve?: "linear" | "natural" | "step";
     stacked?: boolean;
     /** Series keys that render dashed — projections, not observations. */
     forecastKeys?: string[];
+    /** Print each observation's value above its dot — see {@link LineChartProps.showValues}. */
+    showValues?: boolean;
 }
 export interface BarChartProps extends BaseChartProps {
     stacked?: boolean;
     /** Visual bar direction: vertical columns (default) or horizontal bars. */
     layout?: "vertical" | "horizontal";
+    /** Print each bar's value past its end. On by default for a single series. */
+    showValues?: boolean;
 }
 export interface ComboChartProps extends BaseChartProps {
     /** Series keys drawn as lines; the rest draw as bars. */
@@ -183,6 +194,7 @@ export interface ScatterChartProps {
     labelKey?: string;
     annotations?: ChartAnnotation[];
     height?: number;
+    /** Interior gridlines. OFF by default — the two axis lines carry the frame. */
     grid?: boolean;
     showYAxis?: boolean;
     formatValue?: (value: number) => string;
@@ -212,6 +224,8 @@ export interface FunnelChartProps {
     tooltip?: ChartTooltipRenderer | false;
     className?: string;
 }
+/** Chart floor — every chart is at least this tall (ChartFrame clamps). */
+export declare const MIN_HEIGHT = 300;
 export declare const LineChart: React.ForwardRefExoticComponent<LineChartProps & React.RefAttributes<HTMLDivElement>>;
 export declare const AreaChart: React.ForwardRefExoticComponent<AreaChartProps & React.RefAttributes<HTMLDivElement>>;
 export declare const BarChart: React.ForwardRefExoticComponent<BarChartProps & React.RefAttributes<HTMLDivElement>>;