td-plots 1.3.2 → 1.4.1

package/dist/components/Histogram.d.ts

@@ -15,6 +15,7 @@ export type HistogramPlotProps = {
     plotId?: string;
     selectByBin?: boolean;
     dateTickFormat?: string;
+    binSizeOverride?: number;
 };
 export declare const HistogramPlot: (props: HistogramPlotProps) => import("react/jsx-runtime").JSX.Element;
 export default HistogramPlot;

package/dist/components/Utils.d.ts

@@ -2,3 +2,5 @@ export declare const isNumberArray: (arr: unknown[]) => arr is number[];
 export declare const isDateArray: (arr: unknown[]) => arr is Date[];
 export declare function calculateMean(arr: number[] | Date[]): number | undefined;
 export declare const formatDateMDY: (timestamp: number) => string;
+export declare const roundToNextDay: (timestamp: number) => string;
+export declare const roundToPrevDay: (timestamp: number) => string;

package/dist/index.d.ts

@@ -4,4 +4,5 @@ export type { HistogramPlotProps } from './components/Histogram';
 export { RadialHistogramPlot } from './components/RadialHistogram';
 export type { RadialHistogramPlotProps } from './components/RadialHistogram';
 export { default as TestPlot } from './components/TestPlot';
+export { isDateArray, isNumberArray } from './components/Utils';
 export type { PlotParams } from 'react-plotly.js';

package/dist/index.esm.js

@@ -57,6 +57,18 @@ function calculateMean(arr) {
         return sum / arr.length;
     }
 }
+// Utilities for rounding dates to the nearest day.
+// Helpful for making nice bins
+var roundToNextDay = function (timestamp) {
+    var date = new Date(timestamp);
+    date.setHours(23, 59, 59, 999); // End of day
+    return date.toISOString();
+};
+var roundToPrevDay = function (timestamp) {
+    var date = new Date(timestamp);
+    date.setHours(0, 0, 0, 0); // Start of day
+    return date.toISOString();
+};
 
 function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
@@ -5840,7 +5852,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.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, dateTickFormat = props.dateTickFormat;
+    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, dateTickFormat = props.dateTickFormat, binSizeOverride = props.binSizeOverride;
     // Ref for plot container
     var containerRef = useRef(null);
     // Track any selections made in this plot so we can style the selection box.
@@ -6023,10 +6035,59 @@ var HistogramPlot = function (props) {
                 layer: 'above' // Ensure the selection box is above the bars
             }];
     }, [selectedRange, unselectedData]);
+    // 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 = (showMeanLines && data.length > 0) ? [{
+            type: 'line',
+            x0: meanValue,
+            y0: 1 - meanLineRadius,
+            x1: meanValue,
+            yref: 'paper',
+            y1: 1 + meanLineRadius + 0.04, // Add extra length above to make the line look centered on the y-axis top.
+            line: {
+                color: barColor,
+                width: 1.5,
+            }
+        }] : [];
+    // 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 = (showMeanLines && unselectedData.length > 0 && data.length > 0) ? [{
+            type: 'line',
+            x0: allDataMeanValue,
+            y0: 1 - meanLineRadius,
+            x1: allDataMeanValue,
+            yref: 'paper',
+            y1: 1 + meanLineRadius + 0.04, // Add extra length above to make the line look centered on the y-axis top.
+            line: {
+                color: unselectedBarColor,
+                width: 1.5,
+            }
+        }] : [];
+    // If binSizeOverride is provided, use it to set the bin size and range explicitly. 
+    // Plotly does a better job of setting bins and ending them at nice numbers, so only use
+    // this prop when necessary.
+    var xBins = binSizeOverride
+        ? (isDateArray(allData)
+            ? {
+                start: roundToPrevDay(Math.min.apply(Math, allData.map(function (d) { return d.getTime(); }))), // Find a nice round number as a starting point.
+                end: roundToNextDay(Math.max.apply(Math, allData.map(function (d) { return d.getTime(); }))),
+                size: binSizeOverride // bin size in milliseconds
+            }
+            : isNumberArray(allData)
+                ? {
+                    start: Math.floor(Math.min.apply(Math, allData)),
+                    end: Math.ceil(Math.max.apply(Math, allData)),
+                    size: binSizeOverride
+                }
+                : undefined)
+        : undefined;
     var unselectedTrace = {
         x: unselectedData,
         type: 'histogram',
         autobinx: false,
+        xbins: xBins,
         // nbinsx is valid but not included in the type definition
         //@ts-ignore
         nbinsx: nBins, // Maximum number of bins. Plotly may adjust to make bins "nicer".
@@ -6044,6 +6105,7 @@ var HistogramPlot = function (props) {
             x: data,
             type: 'histogram',
             autobinx: false,
+            xbins: xBins,
             // nbinsx is valid but not included in the type definition
             //@ts-ignore
             nbinsx: nBins, // Maximum number of bins. Plotly may adjust to make bins "nicer".
@@ -6058,36 +6120,6 @@ var HistogramPlot = function (props) {
         },
         unselectedTrace,
     ];
-    // 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 = (showMeanLines && data.length > 0) ? [{
-            type: 'line',
-            x0: meanValue,
-            y0: 1 - meanLineRadius,
-            x1: meanValue,
-            yref: 'paper',
-            y1: 1 + meanLineRadius + 0.04, // Add extra length above to make the line look centered on the y-axis top.
-            line: {
-                color: barColor,
-                width: 1.5,
-            }
-        }] : [];
-    // 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 = (showMeanLines && unselectedData.length > 0 && data.length > 0) ? [{
-            type: 'line',
-            x0: allDataMeanValue,
-            y0: 1 - meanLineRadius,
-            x1: allDataMeanValue,
-            yref: 'paper',
-            y1: 1 + meanLineRadius + 0.04, // Add extra length above to make the line look centered on the y-axis top.
-            line: {
-                color: unselectedBarColor,
-                width: 1.5,
-            }
-        }] : [];
     var layout = {
         title: {
             text: title,
@@ -6308,5 +6340,5 @@ var TestPlot = function (props) {
     return jsx(Plot, { data: data, layout: layout });
 };
 
-export { HistogramPlot, RadialHistogramPlot, TestPlot };
+export { HistogramPlot, RadialHistogramPlot, TestPlot, isDateArray, isNumberArray };
 //# sourceMappingURL=index.esm.js.map