@czi-sds/data-viz 0.14.0 → 0.14.1

package/dist/index.cjs.d.ts

@@ -166,8 +166,8 @@ interface StackedBarChartDataItem {
      */
     color?: string;
     /**
-     * Unit label to display with the value in amount mode (e.g., "GB", "datasets", "MB")
-     * Only shown in legend when mode is "amount"
+     * Unit label to display with the value in cumulative mode (e.g., "GB", "datasets", "MB")
+     * Only shown in legend when mode is "cumulative"
      */
     unit?: string;
     /**
@@ -175,7 +175,10 @@ interface StackedBarChartDataItem {
      * @default false
      */
     disabled?: boolean;
-    tooltip: TooltipTableContentProps;
+    /**
+     * Optional tooltip to display when hovering over the segment
+     */
+    tooltip?: TooltipTableContentProps;
 }
 interface StackedBarChartProps extends HTMLAttributes<HTMLDivElement> {
     /**
@@ -205,7 +208,7 @@ interface StackedBarChartProps extends HTMLAttributes<HTMLDivElement> {
      */
     width?: number | string;
     /**
-     * Height of the bar in pixels
+     * Height of the bar in pixels (minimum 1px)
      * @default 16
      */
     barHeight?: number;
@@ -219,6 +222,13 @@ interface StackedBarChartProps extends HTMLAttributes<HTMLDivElement> {
      * @default true
      */
     showLegendValues?: boolean;
+    /**
+     * Format for legend values
+     * - "percentage": Shows percentage of the item in the bar chart (e.g., "20%")
+     * - "count": Shows the count from the data object with the unit defined by the unit prop
+     * @default "percentage"
+     */
+    legendValueFormat?: "percentage" | "count";
     /**
      * Array of selected item indices (controlled component)
      */
@@ -227,33 +237,40 @@ interface StackedBarChartProps extends HTMLAttributes<HTMLDivElement> {
      * Callback when legend selection changes
      */
     onSelectionChange?: (selectedIndices: number[], selectedData: StackedBarChartDataItem[]) => void;
+    /**
+     * Behavior to apply when items are selected
+     * - "dim": Non-selected segments become semi-transparent (20% opacity)
+     * - "hide": Non-selected segments are hidden from the bar chart
+     * @default "dim"
+     */
+    selectionBehavior?: "dim" | "hide";
     /**
      * Chart mode - controls how segments are calculated
-     * - "percentage": Segments fill entire bar (100%), proportional to their values
-     * - "amount": Segments sized based on actual values relative to maxAmount
-     * @default "percentage"
+     * - "porportional": Segments fill entire bar (100%), proportional to their values
+     * - "cumulative": Segments sized based on actual values relative to maxAmount
+     * @default "porportional"
      */
-    mode?: "percentage" | "amount";
+    mode?: "porportional" | "cumulative";
     /**
-     * Maximum amount for the bar (used only in "amount" mode)
+     * Maximum amount for the bar (used only in "cumulative" mode)
      * If not provided, defaults to sum of all values (no remaining segment)
      * If provided and sum < maxAmount, shows gray "remaining" segment
      */
     maxAmount?: number;
     /**
-     * Label for the remaining/unknown segment in amount mode
+     * Label for the remaining/unknown segment in cumulative mode
      * @default "Remaining"
      */
     remainingLabel?: string;
     /**
-     * Unit to display with the remaining segment value in amount mode
+     * Unit to display with the remaining segment value in cumulative mode
      * If not provided, uses the unit from the first data item (if available)
      */
     remainingUnit?: string;
     /**
-     * Global unit to display with values in amount mode (e.g., "GB", "datasets", "K")
+     * Global unit to display with values in cumulative mode (e.g., "GB", "datasets", "K")
      * Individual data items can override this with their own unit property
-     * Only shown when mode is "amount"
+     * Only shown when mode is "cumulative"
      */
     unit?: string;
     /**