td-plots 1.2.2 → 1.3.1

package/dist/components/Histogram.d.ts

@@ -3,8 +3,7 @@ import './plotStyles.scss';
 export type HistogramPlotProps = {
     data: number[] | Date[];
     unselectedData?: number[] | Date[];
-    showMeanLine?: boolean;
-    showAllDataMeanLine?: boolean;
+    showMeanLines?: boolean;
     title?: string;
     xAxisTitle?: string;
     barColor?: string;
@@ -14,6 +13,7 @@ export type HistogramPlotProps = {
     containerStyleOverrides?: React.CSSProperties;
     onDeselect?: () => void;
     plotId?: string;
+    selectByBin?: boolean;
 };
 export declare const HistogramPlot: (props: HistogramPlotProps) => import("react/jsx-runtime").JSX.Element;
 export default HistogramPlot;

package/dist/index.esm.js

@@ -5840,7 +5840,7 @@ var Loading = function () {
 var Plot$2 = lazy(function () { return import('react-plotly.js'); });
 var HistogramPlot = function (props) {
     var _a, _b;
-    var data = props.data, title = props.title, xAxisTitle = props.xAxisTitle, _c = props.barColor, barColor = _c === void 0 ? 'rgb(72, 72, 74)' : _c, _d = props.unselectedBarColor, unselectedBarColor = _d === void 0 ? 'rgba(203, 195, 195, 0.88)' : _d, _e = props.selectorsColor, selectorsColor = _e === void 0 ? 'black' : _e, _f = props.showMeanLine, showMeanLine = _f === void 0 ? true : _f, _g = props.showAllDataMeanLine, showAllDataMeanLine = _g === void 0 ? true : _g, containerStyleOverrides = props.containerStyleOverrides, _h = props.unselectedData, unselectedData = _h === void 0 ? [] : _h, _j = props.handleClickOrSelection, handleClickOrSelection = _j === void 0 ? function () { } : _j, _k = props.onDeselect, onDeselect = _k === void 0 ? function () { } : _k, plotId = props.plotId;
+    var data = props.data, title = props.title, xAxisTitle = props.xAxisTitle, _c = props.barColor, barColor = _c === void 0 ? 'rgb(72, 72, 74)' : _c, _d = props.unselectedBarColor, unselectedBarColor = _d === void 0 ? 'rgba(203, 195, 195, 0.88)' : _d, _e = props.selectorsColor, selectorsColor = _e === void 0 ? 'black' : _e, _f = props.showMeanLines, showMeanLines = _f === void 0 ? true : _f, containerStyleOverrides = props.containerStyleOverrides, _g = props.unselectedData, unselectedData = _g === void 0 ? [] : _g, _h = props.handleClickOrSelection, handleClickOrSelection = _h === void 0 ? function () { } : _h, _j = props.onDeselect, onDeselect = _j === void 0 ? function () { } : _j, plotId = props.plotId, _k = props.selectByBin, selectByBin = _k === void 0 ? false : _k;
     // Ref for plot container
     var containerRef = useRef(null);
     // Track any selections made in this plot so we can style the selection box.
@@ -5851,14 +5851,23 @@ var HistogramPlot = function (props) {
     // to access that information once the plot has been initialized so that we can prevent the
     // axis range from changing during interaction. Dates use strings.
     var _m = useState(undefined), fixedXAxisRange = _m[0], setFixedXAxisRange = _m[1];
+    // Once the plot is drawn, record the initial axis range so we can keep it fixed.
     // figure should be Readonly<Plotly.Figure> but react-plotly.js doesn't expose that type, so we use any.
-    var handlePlotInitialized = function (figure, graphDiv) {
-        var _a, _b;
-        if (((_b = (_a = figure.layout) === null || _a === void 0 ? void 0 : _a.xaxis) === null || _b === void 0 ? void 0 : _b.range) && !fixedXAxisRange) {
-            var computedRange = typeof (figure.layout.xaxis.range[0]) === 'string'
-                ? [new Date(figure.layout.xaxis.range[0]), new Date(figure.layout.xaxis.range[1])]
-                : [figure.layout.xaxis.range[0], figure.layout.xaxis.range[1]];
-            setFixedXAxisRange(computedRange);
+    var handlePlotUpdate = function (figure, graphDiv) {
+        var _a;
+        if (!fixedXAxisRange) {
+            var currentLayout = graphDiv._fullLayout;
+            if ((_a = currentLayout === null || currentLayout === void 0 ? void 0 : currentLayout.xaxis) === null || _a === void 0 ? void 0 : _a.range) {
+                var range = currentLayout.xaxis.range;
+                // Skip temporary [-1, 1] range
+                if (range[0] === -1 && range[1] === 1) {
+                    return;
+                }
+                var computedRange = typeof (range[0]) === 'string'
+                    ? [new Date(range[0]), new Date(range[1])]
+                    : [range[0], range[1]];
+                setFixedXAxisRange(computedRange);
+            }
         }
     };
     // Create handler for click event that can use event data to update the plot if desired.
@@ -5927,22 +5936,73 @@ var HistogramPlot = function (props) {
         var minValue;
         var maxValue;
         if (typeof event.range.x[0] === 'string' && typeof event.range.x[1] === 'string') {
-            // Then we must be dealing with dates
-            minValue = new Date(event.range.x[0]);
-            maxValue = new Date(event.range.x[1]);
-            setSelectedRange([minValue, maxValue]);
+            // Then we are must be dealing with dates
+            if (selectByBin) {
+                // Set selected range to include the whole bin if at least half the bin is within the explicit range
+                // Plotly already tells us which bins were selected based on this logic. These are the points in the event.
+                if (event.points && event.points.length > 0) {
+                    // Means at least one bin has been selected
+                    var firstBinMidPoint = new Date(event.points[0].x).getTime();
+                    var lastBinMidPoint = new Date(event.points[event.points.length - 1].x).getTime();
+                    var binSize = event.points[0].data.xbins.size;
+                    minValue = new Date(firstBinMidPoint - binSize / 2);
+                    maxValue = new Date(lastBinMidPoint + binSize / 2);
+                }
+                else {
+                    // No bins selected, so the range should be empty.
+                    minValue = new Date(event.range.x[0]);
+                    maxValue = minValue;
+                }
+            }
+            else {
+                // Set the range based on the explicit selection boundaries
+                minValue = new Date(event.range.x[0]);
+                maxValue = new Date(event.range.x[1]);
+            }
         }
         else {
-            minValue = event.range.x[0];
-            maxValue = event.range.x[1];
-            setSelectedRange([minValue, maxValue]);
+            // Handle selection for numbers
+            if (selectByBin) {
+                // Set the range based on the bins selected. Plotly will include a bin in event.points if
+                // at least half of it is selected.
+                if (event.points && event.points.length > 0) {
+                    var firstBinMidPoint = event.points[0].x;
+                    var lastBinMidPoint = event.points[event.points.length - 1].x;
+                    var binSize = event.points[0].data.xbins.size;
+                    var roundedMinValue = firstBinMidPoint - binSize / 2;
+                    var roundedMaxValue = lastBinMidPoint + binSize / 2;
+                    minValue = roundedMinValue;
+                    maxValue = roundedMaxValue;
+                }
+                else {
+                    // No bins selected, so set the range to be empty.
+                    minValue = event.range.x[0];
+                    maxValue = minValue;
+                }
+            }
+            else {
+                // Set the range based on the explicit selection boundaries
+                minValue = event.range.x[0];
+                maxValue = event.range.x[1];
+            }
+        }
+        if (minValue !== undefined && maxValue !== undefined) {
+            // Update selected range. Have to be strict about types.
+            if (typeof minValue === 'number' && typeof maxValue === 'number') {
+                setSelectedRange([minValue, maxValue]);
+            }
+            else if (minValue instanceof Date && maxValue instanceof Date) {
+                setSelectedRange([minValue, maxValue]);
+            }
+            handleClickOrSelection(minValue, maxValue);
         }
-        handleClickOrSelection(minValue, maxValue);
     };
     // Create the selected range box
     var selectedRangeBox = useMemo(function () {
         if (!selectedRange)
             return [];
+        if (unselectedData.length === 0)
+            return []; // Don't show the box if the entire dataset is selected.
         // Create a multiply-like effect by using a semi-transparent dark overlay
         var multiplyColor = 'rgba(29, 104, 185, 0.1)';
         return [{
@@ -5959,7 +6019,7 @@ var HistogramPlot = function (props) {
                 },
                 layer: 'above' // Ensure the selection box is above the bars
             }];
-    }, [selectedRange]);
+    }, [selectedRange, unselectedData]);
     var unselectedTrace = {
         x: unselectedData,
         type: 'histogram',
@@ -5998,7 +6058,7 @@ var HistogramPlot = function (props) {
     // Calculate the mean of the selected data using normalized data
     var meanValue = (_a = calculateMean(data)) !== null && _a !== void 0 ? _a : 0; // Default to 0 if no data
     var meanLineRadius = 0.01; // distance from the top of the y axis to the top/bottom end of the mean line
-    var meanLine = showMeanLine ? [{
+    var meanLine = (showMeanLines && data.length > 0) ? [{
             type: 'line',
             x0: meanValue,
             y0: 1 - meanLineRadius,
@@ -6013,7 +6073,7 @@ var HistogramPlot = function (props) {
     // Draw mean line for all data
     var allData = __spreadArray(__spreadArray([], data, true), unselectedData, true);
     var allDataMeanValue = (_b = calculateMean(allData)) !== null && _b !== void 0 ? _b : 0;
-    var allDataMeanLine = (showAllDataMeanLine && unselectedData.length > 0) ? [{
+    var allDataMeanLine = (showMeanLines && unselectedData.length > 0 && data.length > 0) ? [{
             type: 'line',
             x0: allDataMeanValue,
             y0: 1 - meanLineRadius,
@@ -6082,7 +6142,7 @@ var HistogramPlot = function (props) {
         dragmode: 'select', // Enable drag to select
         selectdirection: 'h', // User can select in horizontal direction only
         shapes: __spreadArray(__spreadArray(__spreadArray([], allDataMeanLine, true), meanLine, true), selectedRangeBox, true), // Add the mean line and selection box
-        annotations: (showMeanLine && meanLine) ? [{
+        annotations: (showMeanLines && meanLine && data.length > 0) ? [{
                 x: meanValue,
                 y: 1 + meanLineRadius + 0.04, // Position above the mean line. Value set with respect to the paper coordinates.
                 yref: 'paper',
@@ -6111,7 +6171,7 @@ var HistogramPlot = function (props) {
     return (jsx("div", { ref: containerRef, className: "plot-container ".concat(plotId), style: __assign({ '--selection-color': selectorsColor }, containerStyles), children: jsx(Suspense, { fallback: jsx(Loading, {}), children: jsx(Fragment, { children: jsx(Plot$2, { data: plotlyData, layout: layout, config: config, onSelected: handleSelection, onClick: handleClick, onDeselect: function () {
                         onDeselect();
                         setSelectedRange(null); // Remove selected box
-                    }, onInitialized: handlePlotInitialized, useResizeHandler: true, style: {
+                    }, onUpdate: handlePlotUpdate, useResizeHandler: true, style: {
                         width: "100%",
                         height: "100%",
                         display: "block"