@fluentui/react-charting 5.21.14 → 5.21.16

package/lib-amd/utilities/utilities.js

@@ -2,7 +2,7 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
     "use strict";
     var _a;
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.isScalePaddingDefined = exports.getScalePadding = exports.getBarWidth = exports.formatValueWithSIPrefix = exports.wrapTextInsideDonut = exports.rotateXAxisLabels = exports.convertToLocaleString = exports.getAccessibleDataObject = exports.pointTypes = exports.CustomPoints = exports.Points = exports.getTypeOfAxis = exports.getMinMaxOfYAxis = exports.findHBCWANumericMinMaxOfY = exports.findVerticalNumericMinMaxOfY = exports.findVSBCNumericMinMaxOfY = exports.findNumericMinMaxOfY = exports.getDomainNRangeValues = exports.domainRageOfVerticalNumeric = exports.domainRangeOfDateForAreaLineVerticalBarChart = exports.domainRangeOfVSBCNumeric = exports.domainRangeOfXStringAxis = exports.domainRangeOfNumericForHorizontalBarChartWithAxis = exports.domainRangeOfNumericForAreaChart = exports.getXAxisType = exports.tooltipOfXAxislabels = exports.calculateLongestLabelWidth = exports.wrapContent = exports.createYAxisLabels = exports.createWrapOfXLabels = exports.silceOrAppendToArray = exports.getUnique = exports.calloutData = exports.createStringYAxisForOtherCharts = exports.createStringYAxisForHorizontalBarChartWithAxis = exports.createStringYAxis = exports.createYAxisForOtherCharts = exports.createYAxisForHorizontalBarChartWithAxis = exports.createYAxis = exports.prepareDatapoints = exports.createStringXAxis = exports.createDateXAxis = exports.createNumericXAxis = exports.YAxisType = exports.XAxisTypes = exports.ChartTypes = void 0;
+    exports.formatDate = exports.isScalePaddingDefined = exports.getScalePadding = exports.getBarWidth = exports.formatValueWithSIPrefix = exports.wrapTextInsideDonut = exports.rotateXAxisLabels = exports.convertToLocaleString = exports.getAccessibleDataObject = exports.pointTypes = exports.CustomPoints = exports.Points = exports.getTypeOfAxis = exports.findHBCWANumericMinMaxOfY = exports.findVerticalNumericMinMaxOfY = exports.findVSBCNumericMinMaxOfY = exports.findNumericMinMaxOfY = exports.domainRageOfVerticalNumeric = exports.domainRangeOfDateForAreaLineVerticalBarChart = exports.domainRangeOfVSBCNumeric = exports.domainRangeOfXStringAxis = exports.domainRangeOfNumericForHorizontalBarChartWithAxis = exports.domainRangeOfNumericForAreaChart = exports.getXAxisType = exports.tooltipOfXAxislabels = exports.calculateLongestLabelWidth = exports.wrapContent = exports.createYAxisLabels = exports.createWrapOfXLabels = exports.silceOrAppendToArray = exports.getUnique = exports.calloutData = exports.createStringYAxis = exports.createStringYAxisForHorizontalBarChartWithAxis = exports.createNumericYAxis = exports.createYAxisForHorizontalBarChartWithAxis = exports.prepareDatapoints = exports.createStringXAxis = exports.createDateXAxis = exports.createNumericXAxis = exports.YAxisType = exports.XAxisTypes = exports.ChartTypes = void 0;
     var ChartTypes;
     (function (ChartTypes) {
         ChartTypes[ChartTypes["AreaChart"] = 0] = "AreaChart";
@@ -54,8 +54,8 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
         return { xScale: xAxisScale, tickValues: tickValues };
     }
     exports.createNumericXAxis = createNumericXAxis;
-    function multiFormat(date, locale) {
-        var timeFormat = locale ? locale.format : d3_time_format_1.timeFormat;
+    function multiFormat(date, locale, useUTC) {
+        var timeFormat = locale ? (useUTC ? locale.utcFormat : locale.format) : useUTC ? d3_time_format_1.utcFormat : d3_time_format_1.timeFormat;
         var formatMillisecond = timeFormat('.%L');
         var formatSecond = timeFormat(':%S');
         var formatMinute = timeFormat('%I:%M');
@@ -64,19 +64,26 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
         var formatWeek = timeFormat('%b %d');
         var formatMonth = timeFormat('%B');
         var formatYear = timeFormat('%Y');
-        return ((0, d3_time_1.timeSecond)(date) < date
+        var timeSecond = useUTC ? d3_time_1.utcSecond : d3_time_1.timeSecond;
+        var timeMinute = useUTC ? d3_time_1.utcMinute : d3_time_1.timeMinute;
+        var timeHour = useUTC ? d3_time_1.utcHour : d3_time_1.timeHour;
+        var timeDay = useUTC ? d3_time_1.utcDay : d3_time_1.timeDay;
+        var timeMonth = useUTC ? d3_time_1.utcMonth : d3_time_1.timeMonth;
+        var timeWeek = useUTC ? d3_time_1.utcWeek : d3_time_1.timeWeek;
+        var timeYear = useUTC ? d3_time_1.utcYear : d3_time_1.timeYear;
+        return (timeSecond(date) < date
             ? formatMillisecond
-            : (0, d3_time_1.timeMinute)(date) < date
+            : timeMinute(date) < date
                 ? formatSecond
-                : (0, d3_time_1.timeHour)(date) < date
+                : timeHour(date) < date
                     ? formatMinute
-                    : (0, d3_time_1.timeDay)(date) < date
+                    : timeDay(date) < date
                         ? formatHour
-                        : (0, d3_time_1.timeMonth)(date) < date
-                            ? (0, d3_time_1.timeWeek)(date) < date
+                        : timeMonth(date) < date
+                            ? timeWeek(date) < date
                                 ? formatDay
                                 : formatWeek
-                            : (0, d3_time_1.timeYear)(date) < date
+                            : timeYear(date) < date
                                 ? formatMonth
                                 : formatYear)(date);
     }
@@ -86,10 +93,11 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
      * @param {IXAxisParams} xAxisParams
      * @param {ITickParams} tickParams
      */
-    function createDateXAxis(xAxisParams, tickParams, culture, options, timeFormatLocale, customDateTimeFormatter) {
+    function createDateXAxis(xAxisParams, tickParams, culture, options, timeFormatLocale, customDateTimeFormatter, useUTC) {
         var _a;
         var domainNRangeValues = xAxisParams.domainNRangeValues, xAxisElement = xAxisParams.xAxisElement, _b = xAxisParams.tickPadding, tickPadding = _b === void 0 ? 6 : _b, _c = xAxisParams.xAxistickSize, xAxistickSize = _c === void 0 ? 6 : _c, _d = xAxisParams.xAxisCount, xAxisCount = _d === void 0 ? 6 : _d;
-        var xAxisScale = (0, d3_scale_1.scaleUtc)()
+        var xAxisScale = useUTC ? (0, d3_scale_1.scaleUtc)() : (0, d3_scale_1.scaleTime)();
+        xAxisScale
             .domain([domainNRangeValues.dStartValue, domainNRangeValues.dEndValue])
             .range([domainNRangeValues.rStartValue, domainNRangeValues.rEndValue]);
         var xAxis = (0, d3_axis_1.axisBottom)(xAxisScale).tickSize(xAxistickSize).tickPadding(tickPadding).ticks(xAxisCount);
@@ -106,12 +114,14 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
         else if (timeFormatLocale) {
             var locale_1 = (0, d3_time_format_1.timeFormatLocale)(timeFormatLocale);
             xAxis.tickFormat(function (domainValue, _index) {
-                return multiFormat(domainValue, locale_1);
+                return multiFormat(domainValue, locale_1, useUTC);
             });
         }
         tickParams.tickValues ? xAxis.tickValues(tickParams.tickValues) : '';
         if (culture === undefined) {
-            tickParams.tickFormat ? xAxis.tickFormat((0, d3_time_format_1.timeFormat)(tickParams.tickFormat)) : '';
+            tickParams.tickFormat
+                ? xAxis.tickFormat(useUTC ? (0, d3_time_format_1.utcFormat)(tickParams.tickFormat) : (0, d3_time_format_1.timeFormat)(tickParams.tickFormat))
+                : '';
         }
         if (xAxisElement) {
             (0, d3_selection_1.select)(xAxisElement).call(xAxis).selectAll('text').attr('aria-hidden', 'true');
@@ -119,7 +129,7 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
         var tickValues = ((_a = tickParams.tickValues) !== null && _a !== void 0 ? _a : xAxisScale.ticks(xAxisCount)).map(function (val, idx) {
             var tickFormat = xAxis.tickFormat();
             // val is a Date object. So when the tick format is not set, format val as a string to calculate its width
-            return tickFormat ? tickFormat(val, idx) : multiFormat(val);
+            return tickFormat ? tickFormat(val, idx) : multiFormat(val, undefined, useUTC);
         });
         return { xScale: xAxisScale, tickValues: tickValues };
     }
@@ -176,23 +186,7 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
         return dataPointsArray;
     }
     exports.prepareDatapoints = prepareDatapoints;
-    /**
-     * Creating Numeric Y axis of the chart
-     * @export
-     * @param {IYAxisParams} yAxisParams
-     * @param {boolean} isRtl
-     */
-    function createYAxis(yAxisParams, isRtl, axisData, chartType, barWidth, isIntegralDataset, useSecondaryYScale) {
-        if (useSecondaryYScale === void 0) { useSecondaryYScale = false; }
-        switch (chartType) {
-            case ChartTypes.HorizontalBarChartWithAxis:
-                return createYAxisForHorizontalBarChartWithAxis(yAxisParams, isRtl, axisData, barWidth);
-            default:
-                return createYAxisForOtherCharts(yAxisParams, isRtl, axisData, isIntegralDataset, useSecondaryYScale);
-        }
-    }
-    exports.createYAxis = createYAxis;
-    function createYAxisForHorizontalBarChartWithAxis(yAxisParams, isRtl, axisData, barWidth) {
+    function createYAxisForHorizontalBarChartWithAxis(yAxisParams, isRtl) {
         var _a = yAxisParams.yMinMaxValues, yMinMaxValues = _a === void 0 ? { startValue: 0, endValue: 0 } : _a, _b = yAxisParams.yAxisElement, yAxisElement = _b === void 0 ? null : _b, _c = yAxisParams.yMaxValue, yMaxValue = _c === void 0 ? 0 : _c, _d = yAxisParams.yMinValue, yMinValue = _d === void 0 ? 0 : _d, containerHeight = yAxisParams.containerHeight, margins = yAxisParams.margins, _e = yAxisParams.tickPadding, tickPadding = _e === void 0 ? 12 : _e, _f = yAxisParams.maxOfYVal, maxOfYVal = _f === void 0 ? 0 : _f, yAxisTickFormat = yAxisParams.yAxisTickFormat, _g = yAxisParams.yAxisTickCount, yAxisTickCount = _g === void 0 ? 4 : _g;
         // maxOfYVal coming from only area chart and Grouped vertical bar chart(Calculation done at base file)
         var tempVal = maxOfYVal || yMinMaxValues.endValue;
@@ -208,7 +202,7 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
         return yAxisScale;
     }
     exports.createYAxisForHorizontalBarChartWithAxis = createYAxisForHorizontalBarChartWithAxis;
-    function createYAxisForOtherCharts(yAxisParams, isRtl, axisData, isIntegralDataset, useSecondaryYScale) {
+    function createNumericYAxis(yAxisParams, isRtl, axisData, isIntegralDataset, useSecondaryYScale) {
         if (useSecondaryYScale === void 0) { useSecondaryYScale = false; }
         var _a = yAxisParams.yMinMaxValues, yMinMaxValues = _a === void 0 ? { startValue: 0, endValue: 0 } : _a, _b = yAxisParams.yAxisElement, yAxisElement = _b === void 0 ? null : _b, _c = yAxisParams.yMaxValue, yMaxValue = _c === void 0 ? 0 : _c, _d = yAxisParams.yMinValue, yMinValue = _d === void 0 ? 0 : _d, containerHeight = yAxisParams.containerHeight, containerWidth = yAxisParams.containerWidth, margins = yAxisParams.margins, _e = yAxisParams.tickPadding, tickPadding = _e === void 0 ? 12 : _e, _f = yAxisParams.maxOfYVal, maxOfYVal = _f === void 0 ? 0 : _f, yAxisTickFormat = yAxisParams.yAxisTickFormat, _g = yAxisParams.yAxisTickCount, yAxisTickCount = _g === void 0 ? 4 : _g, eventAnnotationProps = yAxisParams.eventAnnotationProps, eventLabelHeight = yAxisParams.eventLabelHeight;
         // maxOfYVal coming from only area chart and Grouped vertical bar chart(Calculation done at base file)
@@ -229,23 +223,14 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
         axisData.yAxisDomainValues = domainValues;
         return yAxisScale;
     }
-    exports.createYAxisForOtherCharts = createYAxisForOtherCharts;
-    var createStringYAxis = function (yAxisParams, dataPoints, isRtl, chartType, barWidth, culture) {
-        switch (chartType) {
-            case ChartTypes.HorizontalBarChartWithAxis:
-                return (0, exports.createStringYAxisForHorizontalBarChartWithAxis)(yAxisParams, dataPoints, isRtl, barWidth, culture);
-            default:
-                return (0, exports.createStringYAxisForOtherCharts)(yAxisParams, dataPoints, isRtl);
-        }
-    };
-    exports.createStringYAxis = createStringYAxis;
+    exports.createNumericYAxis = createNumericYAxis;
     /**
      * Creating String Y axis of the chart for Horizontal Bar Chart With Axis
      * @param yAxisParams
      * @param dataPoints
      * @param isRtl
      */
-    var createStringYAxisForHorizontalBarChartWithAxis = function (yAxisParams, dataPoints, isRtl, barWidth, culture) {
+    var createStringYAxisForHorizontalBarChartWithAxis = function (yAxisParams, dataPoints, isRtl, barWidth) {
         var containerHeight = yAxisParams.containerHeight, _a = yAxisParams.tickPadding, tickPadding = _a === void 0 ? 12 : _a, margins = yAxisParams.margins, yAxisTickFormat = yAxisParams.yAxisTickFormat, yAxisElement = yAxisParams.yAxisElement;
         var yAxisScale = (0, d3_scale_1.scaleBand)()
             .domain(dataPoints)
@@ -265,7 +250,7 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
      * @param dataPoints
      * @param isRtl
      */
-    var createStringYAxisForOtherCharts = function (yAxisParams, dataPoints, isRtl) {
+    var createStringYAxis = function (yAxisParams, dataPoints, isRtl) {
         var containerHeight = yAxisParams.containerHeight, _a = yAxisParams.tickPadding, tickPadding = _a === void 0 ? 12 : _a, margins = yAxisParams.margins, yAxisTickFormat = yAxisParams.yAxisTickFormat, yAxisElement = yAxisParams.yAxisElement, _b = yAxisParams.yAxisPadding, yAxisPadding = _b === void 0 ? 0 : _b;
         var yAxisScale = (0, d3_scale_1.scaleBand)()
             .domain(dataPoints)
@@ -279,7 +264,7 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
         yAxisElement ? (0, d3_selection_1.select)(yAxisElement).call(yAxis).selectAll('text') : '';
         return yAxisScale;
     };
-    exports.createStringYAxisForOtherCharts = createStringYAxisForOtherCharts;
+    exports.createStringYAxis = createStringYAxis;
     /**
      * For area chart and line chart, while displaying stackCallout, Need to form a callout data object.
      * This methos creates an object for those 2 charts.
@@ -472,7 +457,7 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     function createYAxisLabels(node, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    yAxis, noOfCharsToTruncate, truncateLabel, xValue, isRtl) {
+    yAxis, noOfCharsToTruncate, truncateLabel, isRtl) {
         if (node === null) {
             return;
         }
@@ -774,71 +759,6 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
             : { dStartValue: xMin, dEndValue: xMax, rStartValue: rMin, rEndValue: rMax };
     }
     exports.domainRageOfVerticalNumeric = domainRageOfVerticalNumeric;
-    /**
-     * For creating X axis, need to calculate x axis domain and range values from given points.
-     * This may vary based on chart type and type of x axis
-     * So, this method will define which method need to call based on chart type and axis type.
-     * @export
-     * @param {*} points
-     * @param {IMargins} margins
-     * @param {number} width
-     * @param {ChartTypes} chartType
-     * @param {boolean} isRTL
-     * @param {XAxisTypes} xAxisType
-     * @param {number} [barWidth]
-     * @returns {IDomainNRange}
-     */
-    function getDomainNRangeValues(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    points, margins, width, chartType, isRTL, xAxisType, barWidth, tickValues, shiftX) {
-        var domainNRangeValue;
-        if (xAxisType === XAxisTypes.NumericAxis) {
-            switch (chartType) {
-                case ChartTypes.AreaChart:
-                case ChartTypes.LineChart:
-                    domainNRangeValue = domainRangeOfNumericForAreaChart(points, margins, width, isRTL);
-                    break;
-                case ChartTypes.VerticalStackedBarChart:
-                    domainNRangeValue = domainRangeOfVSBCNumeric(points, margins, width, isRTL, barWidth);
-                    break;
-                case ChartTypes.VerticalBarChart:
-                    domainNRangeValue = domainRageOfVerticalNumeric(points, margins, width, isRTL, barWidth);
-                    break;
-                case ChartTypes.HorizontalBarChartWithAxis:
-                    domainNRangeValue = domainRangeOfNumericForHorizontalBarChartWithAxis(points, margins, width, isRTL, shiftX);
-                    break;
-                default:
-                    domainNRangeValue = { dStartValue: 0, dEndValue: 0, rStartValue: 0, rEndValue: 0 };
-            }
-        }
-        else if (xAxisType === XAxisTypes.DateAxis) {
-            switch (chartType) {
-                case ChartTypes.AreaChart:
-                case ChartTypes.LineChart:
-                case ChartTypes.VerticalBarChart:
-                case ChartTypes.VerticalStackedBarChart:
-                    domainNRangeValue = domainRangeOfDateForAreaLineVerticalBarChart(points, margins, width, isRTL, tickValues, chartType, barWidth);
-                    break;
-                default:
-                    domainNRangeValue = { dStartValue: 0, dEndValue: 0, rStartValue: 0, rEndValue: 0 };
-            }
-        }
-        else {
-            // String Axis type
-            switch (chartType) {
-                case ChartTypes.VerticalStackedBarChart:
-                case ChartTypes.GroupedVerticalBarChart:
-                case ChartTypes.VerticalBarChart:
-                case ChartTypes.HeatMapChart:
-                    domainNRangeValue = domainRangeOfXStringAxis(margins, width, isRTL);
-                    break;
-                default:
-                    domainNRangeValue = { dStartValue: 0, dEndValue: 0, rStartValue: 0, rEndValue: 0 };
-            }
-        }
-        return domainNRangeValue;
-    }
-    exports.getDomainNRangeValues = getDomainNRangeValues;
     /**
      * Calculating start and ending values of the Area chart and LineChart
      * @export
@@ -921,41 +841,6 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
         return { startValue: 0, endValue: 0 };
     }
     exports.findHBCWANumericMinMaxOfY = findHBCWANumericMinMaxOfY;
-    /**
-     * For creating Y axis, need to calculate y axis domain values from given points. This may vary based on chart type.
-     * So, this method will define which method need to call based on chart type to find out min and max values(For Domain).
-     * For grouped vertical bar chart, Calculating yMax value in the base file and sending as MaxOfYVal to cartesian.
-     * @export
-     * @param {*} points
-     * @param {ChartTypes} chartType
-     * @returns {{ startValue: number; endValue: number }}
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    function getMinMaxOfYAxis(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    points, chartType, yAxisType) {
-        if (yAxisType === void 0) { yAxisType = YAxisType.NumericAxis; }
-        var minMaxValues;
-        switch (chartType) {
-            case ChartTypes.AreaChart:
-            case ChartTypes.LineChart:
-                minMaxValues = findNumericMinMaxOfY(points);
-                break;
-            case ChartTypes.VerticalStackedBarChart:
-                minMaxValues = findVSBCNumericMinMaxOfY(points);
-                break;
-            case ChartTypes.VerticalBarChart:
-                minMaxValues = findVerticalNumericMinMaxOfY(points);
-                break;
-            case ChartTypes.HorizontalBarChartWithAxis:
-                minMaxValues = findHBCWANumericMinMaxOfY(points, yAxisType);
-                break;
-            default:
-                minMaxValues = { startValue: 0, endValue: 0 };
-        }
-        return minMaxValues;
-    }
-    exports.getMinMaxOfYAxis = getMinMaxOfYAxis;
     /**
      * @param p string or number or Date
      *
@@ -1191,5 +1076,10 @@ define(["require", "exports", "tslib", "d3-axis", "d3-array", "d3-scale", "d3-se
         return typeof prop === 'number' || typeof shorthandProp === 'number';
     };
     exports.isScalePaddingDefined = isScalePaddingDefined;
+    var formatDate = function (date, useUTC) {
+        var timeFormat = useUTC ? d3_time_format_1.utcFormat : d3_time_format_1.timeFormat;
+        return timeFormat('%-e %b %Y, %H:%M')(date) + (useUTC ? ' GMT' : '');
+    };
+    exports.formatDate = formatDate;
 });
 //# sourceMappingURL=utilities.js.map