pace-chart-lib 0.0.6 → 0.0.8

package/dist/components/Charts/ChartsWithAxis/LineFamily/LineChart.js

@@ -0,0 +1,452 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+//#region Imports
+import * as d3 from "d3";
+import * as d3Annotation from "d3-svg-annotation";
+import { useEffect, useRef } from "react";
+import { logError } from "../../../../Services/ErrorLog";
+import { staticLegendShape, staticLineStyle, } from "../../Core/Common.types";
+import { drawLegends, generalizedChartData, lineMarkers } from "../../Core/CommonFunctions";
+import { addDataTable, commonAnnotations, customYscaleLabelFormatting, dataTablePreCalculation, drawSeriesLabels, firstFunctionBeforeRender, getCurveType, getNumberWithFormat, initChartArea, initPlotArea, initSvg, initXaxis, initYaxis, initYaxisRight, marginCalculation, prepareDataForSeriesLabel, responsiveSecondaryYaxisLabel, responsiveXaxisLabel, responsiveYaxisLabel, setChartTitle, setDateFormats, setXaxistitle, yAxistitle, yAxistitleRight, } from "../ChartsWithAxisFunctions";
+import { actualChartTypes, } from "../ChartsWithAxisTypes.types";
+const LineChart = ({ title, data, yAxisObj, xAxisObj, chartId, formatOptions, }) => {
+    // adding variables as per requirement
+    const barWidth = 0; // coz line chart
+    const chartType = actualChartTypes.line;
+    const svgRef = useRef();
+    const seriesData = generalizedChartData(data.ChartData, data.DimensionList);
+    const dimensionList = data.DimensionList;
+    const barChart = false;
+    let isSecondaryAxisDrawn = false;
+    const isNormalizedChart = false;
+    let isPrimaryAxisDrawn = true;
+    let customYaxisMinValue = parseFloat(formatOptions.yAxisLabel.yAxisMinText);
+    let customYaxisMaxValue = parseFloat(formatOptions.yAxisLabel.yAxisMaxText);
+    let secondaryCustomYaxisMinValue = parseFloat(formatOptions.secondaryYAxisLabel.secondaryYAxisMinText);
+    let secondaryCustomYaxisMaxValue = parseFloat(formatOptions.secondaryYAxisLabel.secondaryYAxisMaxText);
+    let margin;
+    let yLabel;
+    let xLabel;
+    let yTitle;
+    let xTitle;
+    let dimensionHeightWidthArray;
+    let chartTitleHeight;
+    let secondaryAxisTitleWidth;
+    let legendMargin;
+    let secondaryYLabel;
+    let maxNumberForPrimaryAxis;
+    let maxNumberForSecondaryAxis;
+    let innerWidth;
+    let innerHeight;
+    let width;
+    let height;
+    let dataTable;
+    let dataTableHeight;
+    let svg;
+    let gTag;
+    let yScaleLeft;
+    let yScaleRight;
+    let xScale;
+    let seriesLabels;
+    let calculatedRange;
+    let seriesLabelWidth;
+    let yAxisLeft;
+    let xAxis;
+    let yAxisRight;
+    let filteredDimension;
+    let filteredData = [];
+    let scrollPosition = 0;
+    const visibleBars = 2;
+    let chartJSON = {
+        dimensionList: dimensionList,
+        chartType: chartType,
+        chartData: [],
+        formatOptions: formatOptions,
+        legendList: [],
+        secondaryAxisDrawn: false,
+        yMaxLeft: 0,
+        yMaxRight: 0,
+        yMinLeft: 0,
+        yMinRight: 0,
+        hideZeroValues: false,
+        formattedDimensionListMap: new Map(),
+    };
+    //#region UseEffect
+    useEffect(() => {
+        try {
+            createLineChart();
+        }
+        catch (error) {
+            logError("Linechart", "createLineChart", error);
+        }
+    }, [formatOptions]);
+    //#endregion
+    const createLineChart = () => {
+        ({ formatOptions, svg, width, height } = firstFunctionBeforeRender(svgRef, formatOptions));
+        preProcessChartData(); // preaparing data related to chart creation
+        // Applies custom Y-axis label formatting and calculates the necessary margin based on axis extremes.
+        ({ maxNumberForPrimaryAxis, maxNumberForSecondaryAxis } =
+            customYscaleLabelFormatting(
+            // for calculating primary/secondary axis max number so that we can calculate margin accordinglt
+            formatOptions, chartJSON.yMinLeft, chartJSON.yMaxLeft, chartJSON.yMinRight, chartJSON.yMaxRight));
+        ({
+            margin,
+            yLabel,
+            xLabel,
+            yTitle,
+            xTitle,
+            dimensionHeightWidthArray,
+            chartTitleHeight,
+            secondaryAxisTitleWidth,
+            legendMargin,
+            secondaryYLabel,
+        } = marginCalculation(
+        // for all margin related calculations
+        width, height, maxNumberForPrimaryAxis, maxNumberForSecondaryAxis, chartJSON.yMaxLeft, formatOptions, chartJSON.legendList, chartJSON.dimensionList, chartJSON.yMaxRight, isSecondaryAxisDrawn, isNormalizedChart));
+        setSVGContainer(margin); // for innerWidth/height static width/height
+        ({ dataTable, dataTableHeight } = dataTablePreCalculation(
+        // calculations for data tables
+        formatOptions, yLabel, yTitle, seriesData, chartJSON.dimensionList));
+        initSvg(
+        // for svg creation
+        svg, width, height, formatOptions);
+        gTag = initChartArea(svg, margin); // creating chart area
+        initPlotArea(gTag, formatOptions, dataTableHeight, innerWidth, innerHeight, chartType);
+        initScale();
+        initAxis();
+        initYaxis(gTag, formatOptions, dataTableHeight, yLabel, yAxisLeft, innerHeight);
+        if (isSecondaryAxisDrawn) {
+            initYaxisRight(gTag, formatOptions, dataTableHeight, secondaryYLabel, yAxisRight, innerHeight, innerWidth);
+        }
+        horizontalScrollBar(seriesData, height, svg, margin, innerWidth);
+        if (formatOptions.dataTableProperties &&
+            formatOptions.dataTableProperties.dataTable) {
+            if (formatOptions.xAxisLabel.xAxisPosition != "1")
+                formatOptions.xAxisLabel.xAxisLabelVisibility = false;
+            addDataTable(formatOptions.plotArea.fitChart, svg, gTag, dataTable, barWidth, yScaleLeft, xScale, undefined, undefined, undefined, dataTableHeight, "Line", formatOptions, yLabel, yTitle, chartJSON.dimensionList, innerWidth, calculatedRange, chartJSON.formattedDimensionListMap, chartId, margin, innerHeight);
+        }
+        setXaxistitle(formatOptions, barChart, svg, margin, xLabel, height, xTitle, chartJSON.chartType, yLabel, innerWidth, innerHeight);
+        yAxistitle(innerHeight, formatOptions, dataTableHeight, barChart, svg, margin, yTitle, yLabel);
+        yAxistitleRight(svg, isSecondaryAxisDrawn, margin, formatOptions, dataTableHeight, innerHeight, innerWidth, secondaryYLabel, secondaryAxisTitleWidth); // to be added later
+        setChartTitle(svg, formatOptions, width, chartTitleHeight);
+        drawLegends(height, svg, dimensionHeightWidthArray, chartTitleHeight, width, legendMargin, formatOptions, seriesData, chartId, staticLegendShape.line);
+    };
+    const preProcessChartData = () => {
+        const allChartData = [];
+        const legendList = [];
+        let formatedDimesionList = [];
+        let yMaxLeft = -Infinity;
+        let yMinLeft = Infinity;
+        let yMaxRight = -Infinity;
+        let yMinRight = Infinity;
+        seriesData.forEach((series) => {
+            legendList.push(series.legend);
+            series.data.forEach((point) => {
+                allChartData.push(point);
+                if (series.properties.axis === "Secondary") {
+                    isSecondaryAxisDrawn = true;
+                    yMaxRight = Math.max(yMaxRight, point.value);
+                    yMinRight = Math.min(yMinRight, point.value);
+                }
+                else {
+                    yMaxLeft = Math.max(yMaxLeft, point.value);
+                    yMinLeft = Math.min(yMinLeft, point.value);
+                }
+            });
+        });
+        chartJSON.chartData = allChartData;
+        chartJSON.legendList = legendList;
+        chartJSON.yMaxLeft = yMaxLeft;
+        chartJSON.yMinLeft = yMinLeft;
+        chartJSON.yMaxRight = yMaxRight;
+        chartJSON.yMinRight = yMinRight;
+        // Apply formatted dimensions
+        let xAxisObject = xAxisObj[0];
+        formatedDimesionList =
+            (xAxisObject.groupBy == "NA" || xAxisObject.groupBy == undefined) &&
+                xAxisObject.dataType === "DATE"
+                ? setDateFormats(formatOptions.xAxisLabel.xAxisNumberFormat, chartJSON.dimensionList).map((d) => d[0])
+                : chartJSON.dimensionList;
+        chartJSON.dimensionList.forEach((dim, i) => {
+            chartJSON.formattedDimensionListMap.set(dim, formatedDimesionList[i]);
+        });
+        filteredData = JSON.parse(JSON.stringify(seriesData));
+        if (!formatOptions.plotArea.fitChart) {
+            filteredDimension = chartJSON.dimensionList.slice(scrollPosition, scrollPosition + visibleBars);
+        }
+        else {
+            filteredDimension = chartJSON.dimensionList;
+        }
+        if (formatOptions.plotArea.hideZeroValues) {
+            chartJSON.hideZeroValues = true;
+        }
+    };
+    const initScale = () => {
+        // rounding the ymin & ymax
+        let yAxisLabelArray = responsiveYaxisLabel(customYaxisMaxValue ? customYaxisMaxValue : chartJSON.yMaxLeft, chartJSON.yMinLeft, innerHeight, formatOptions, chartJSON, customYaxisMinValue, customYaxisMaxValue).yAxisLabelArray;
+        chartJSON.yMaxLeft = yAxisLabelArray[yAxisLabelArray.length - 1];
+        chartJSON.yMinLeft = yAxisLabelArray[0];
+        if (isPrimaryAxisDrawn) {
+            yScaleLeft = d3
+                .scaleLinear()
+                .domain([
+                customYaxisMinValue !== undefined &&
+                    !Number.isNaN(customYaxisMinValue)
+                    ? customYaxisMinValue
+                    : chartJSON.yMinLeft < 0
+                        ? chartJSON.yMinLeft * 1.1
+                        : chartJSON.yMinLeft * 0.9,
+                chartJSON.yMaxLeft <= 0
+                    ? 0
+                    : customYaxisMaxValue !== undefined &&
+                        !Number.isNaN(customYaxisMaxValue)
+                        ? customYaxisMaxValue
+                        : chartJSON.yMaxLeft * 1.1,
+            ])
+                .range([
+                dataTableHeight > 0 ? innerHeight - dataTableHeight : innerHeight,
+                0,
+            ]);
+        }
+        if (isSecondaryAxisDrawn) {
+            yScaleRight = d3
+                .scaleLinear()
+                .domain([
+                chartJSON.yMinRight >= 0
+                    ? (secondaryCustomYaxisMinValue ||
+                        secondaryCustomYaxisMinValue == 0) &&
+                        !Number.isNaN(secondaryCustomYaxisMinValue)
+                        ? secondaryCustomYaxisMinValue
+                        : 0
+                    : (secondaryCustomYaxisMinValue ||
+                        secondaryCustomYaxisMinValue == 0) &&
+                        !Number.isNaN(secondaryCustomYaxisMinValue)
+                        ? secondaryCustomYaxisMinValue
+                        : chartJSON.yMinRight * 1.1,
+                chartJSON.yMaxRight <= 0
+                    ? secondaryCustomYaxisMaxValue
+                        ? secondaryCustomYaxisMaxValue
+                        : 0
+                    : secondaryCustomYaxisMaxValue
+                        ? secondaryCustomYaxisMaxValue
+                        : chartJSON.yMaxRight * 1.1,
+            ])
+                .range([
+                dataTableHeight > 0 ? innerHeight - dataTableHeight : innerHeight,
+                0,
+            ]);
+        }
+        calculatedRange = [0, innerWidth];
+        if (formatOptions.seriesLabel.seriesLabelVisibility) {
+            let labelObj = prepareDataForSeriesLabel(innerWidth, yScaleLeft, formatOptions, filteredData, yScaleRight, isSecondaryAxisDrawn);
+            seriesLabels = labelObj.labelArray;
+            formatOptions.seriesLabel.seriesLabelPosition == "Right" &&
+                (seriesLabelWidth = labelObj.heightWidth[0]);
+            formatOptions.seriesLabel.seriesLabelPosition == "Right"
+                ? (calculatedRange = [0, innerWidth - labelObj.heightWidth[0]])
+                : (calculatedRange = [labelObj.heightWidth[0], innerWidth]);
+        }
+        getXScale();
+    };
+    const getXScale = () => {
+        xScale = d3
+            .scalePoint()
+            .domain(filteredDimension)
+            .range(calculatedRange)
+            .padding(0.5);
+    };
+    const initAxis = () => {
+        getXAxis();
+        if (isPrimaryAxisDrawn) {
+            yAxisLeft = d3
+                .axisLeft(yScaleLeft)
+                .tickFormat((d) => getNumberWithFormat(d, formatOptions.yAxisLabel.yAxisDisplayUnits, formatOptions.yAxisLabel.yAxisNumberFormat, formatOptions.yAxisLabel.yAxisLabelDecimalPrecision))
+                .tickSize(formatOptions.plotArea.gridLinesVisibility
+                ? formatOptions.plotArea.gridLinesHorizontal
+                    ? -innerWidth + (seriesLabelWidth ? seriesLabelWidth : 0)
+                    : 0
+                : 0)
+                .tickValues(responsiveYaxisLabel(customYaxisMaxValue ? customYaxisMaxValue : chartJSON.yMaxLeft, chartJSON.yMinLeft, innerHeight, formatOptions, chartJSON, customYaxisMinValue, customYaxisMaxValue).yAxisLabelArray)
+                .ticks(responsiveYaxisLabel(customYaxisMaxValue ? customYaxisMaxValue : chartJSON.yMaxLeft, chartJSON.yMinLeft, innerHeight, formatOptions, chartJSON, customYaxisMinValue, customYaxisMaxValue).customTickValue ??
+                (dataTableHeight > 0
+                    ? (innerHeight - dataTableHeight) / 30
+                    : innerHeight / 30))
+                .tickSizeOuter(0);
+        }
+        if (isSecondaryAxisDrawn) {
+            yAxisRight = d3
+                .axisRight(yScaleRight)
+                .tickFormat((d) => getNumberWithFormat(d, formatOptions.secondaryYAxisLabel.secondaryYAxisDisplayUnits, formatOptions.secondaryYAxisLabel.secondaryYAxisNumberFormat, formatOptions.secondaryYAxisLabel
+                .secondaryYAxisLabelDecimalPrecision))
+                .tickValues(responsiveSecondaryYaxisLabel(secondaryCustomYaxisMaxValue
+                ? secondaryCustomYaxisMaxValue
+                : chartJSON.yMaxRight, chartJSON.yMinRight, formatOptions, chartJSON).secondaryYAxisLabelArray)
+                .ticks(responsiveSecondaryYaxisLabel(secondaryCustomYaxisMaxValue
+                ? secondaryCustomYaxisMaxValue
+                : chartJSON.yMaxRight, chartJSON.yMinRight, formatOptions, chartJSON).secondaryCustomTickValue ?? innerHeight / 30)
+                .tickSize(formatOptions.plotArea.gridLinesVisibility
+                ? formatOptions.plotArea.gridLinesHorizontal
+                    ? -innerWidth
+                    : 0
+                : 0)
+                .tickSizeOuter(0);
+        }
+    };
+    const getXAxis = () => {
+        xAxis = d3
+            .axisBottom(xScale)
+            .tickSize(formatOptions.plotArea.gridLinesVisibility
+            ? formatOptions.plotArea.gridLinesVertical
+                ? formatOptions.plotArea.gridLinesVertical
+                    ? -(dataTableHeight > 0
+                        ? innerHeight - dataTableHeight
+                        : innerHeight)
+                    : parseFloat(formatOptions.plotArea.ticksHeight) *
+                        ((dataTableHeight > 0
+                            ? innerHeight - dataTableHeight
+                            : innerHeight) /
+                            100) *
+                        (formatOptions.xAxisLabel.xAxisPosition == "1" ? 1 : -1)
+                : 0
+            : 0)
+            .tickSizeOuter(0)
+            .tickValues(responsiveXaxisLabel(filteredDimension, innerWidth));
+    };
+    const getChartType = (lineData) => {
+        lineData.forEach((lData) => {
+            lData.data.forEach((cData) => {
+                cData.hideZero = lData.properties.hideZeroValues;
+                cData.axis = lData.properties.axis;
+            });
+        });
+        const lineGenerator = d3
+            .line()
+            .x((d) => xScale(d.dimension)
+            ? xScale(d.dimension)
+            : null)
+            .y((d) => d.axis == "Primary"
+            ? yScaleLeft(d.value)
+            : yScaleRight(d.value))
+            .defined((d) => (d.hideZero ? Boolean(d.value) : true))
+            .curve(getCurveType(formatOptions));
+        // Bind dummy data to ensure a single group is created
+        let lines = gTag.selectAll(".parentGroup").data([lineData]);
+        lines = lines
+            .enter()
+            .append("g")
+            .attr("class", "lines parentGroup")
+            .merge(lines);
+        // JOIN: one group per line
+        let lineGroups = lines.selectAll(".line-group").data((d) => d);
+        // ENTER: create group for each new line
+        let lineGroupsEnter = lineGroups
+            .enter()
+            .append("g")
+            .attr("class", "line-group");
+        // Append path to new groups
+        lineGroupsEnter
+            .attr("hoverId", (d) => d.legend.replace(/ /g, "-"))
+            .append("path")
+            .attr("class", "line")
+            .attr("fill", "none");
+        // ENTER + UPDATE
+        lineGroupsEnter
+            .merge(lineGroups)
+            .select("path")
+            .attr("d", (d) => lineGenerator(d.data))
+            .attr("stroke", (d) => d.properties.color !== "#ffffff" ? d.properties.color : "none")
+            .attr("stroke-dasharray", (d) => {
+            switch (d.properties.lineStyle) {
+                case staticLineStyle.dotted:
+                    return "0,3";
+                case staticLineStyle.dashed:
+                    return "20,10,5,5,5,10";
+                default:
+                    return "";
+            }
+        })
+            .attr("stroke-linecap", (d) => d.properties.lineStyle === staticLineStyle.dotted ? "round" : "")
+            .attr("stroke-width", (d) => d.properties.lineStyle !== "None" ? d.properties.lineWidth : "0");
+        // EXIT: remove old groups
+        lineGroups.exit().remove();
+        //Markers
+        lineMarkers(lines, lineData, "None", xScale, yScaleLeft, yScaleRight, null, formatOptions, chartJSON, secondaryCustomYaxisMaxValue, secondaryCustomYaxisMinValue, customYaxisMinValue, customYaxisMaxValue, false);
+    };
+    const setSVGContainer = (margin) => {
+        innerWidth = width - margin.left - margin.right;
+        innerHeight = height - margin.bottom - margin.top;
+    };
+    const horizontalScrollBar = (seriesData, height, svg, margin, innerWidth) => {
+        if (!formatOptions.plotArea.fitChart) {
+            // Scrollbar parameters
+            const scrollMax = seriesData[0].data.length - visibleBars;
+            // Scrollbar track & handle
+            const scrollbarY = height - 20;
+            filteredDimension = chartJSON.dimensionList.slice(scrollPosition, scrollPosition + visibleBars);
+            getXScale();
+            filteredData = JSON.parse(JSON.stringify(seriesData));
+            filteredData.forEach((data, i) => (filteredData[i].data = data.data.filter((d) => filteredDimension.includes(d.dimension))));
+            getXAxis();
+            svg
+                .append("rect")
+                .attr("x", margin.left)
+                .attr("y", scrollbarY)
+                .attr("width", innerWidth)
+                .attr("height", 8)
+                .attr("fill", "#ddd")
+                .attr("rx", 4);
+            const handleWidth = (innerWidth * visibleBars) / chartJSON.dimensionList.length;
+            const handle = svg
+                .append("rect")
+                .attr("x", margin.left)
+                .attr("y", scrollbarY)
+                .attr("width", handleWidth)
+                .attr("height", 8)
+                .attr("fill", "#999")
+                .attr("rx", 4)
+                .style("cursor", "ew-resize")
+                .call(d3.drag().on("drag", (event) => {
+                let x = Math.min(Math.max(event.x, margin.left), margin.left + innerWidth - handleWidth);
+                handle.attr("x", x);
+                scrollPosition = Math.round(((x - margin.left) / (innerWidth - handleWidth)) * scrollMax);
+                filteredDimension = chartJSON.dimensionList.slice(scrollPosition, scrollPosition + visibleBars);
+                getXScale();
+                filteredData = JSON.parse(JSON.stringify(seriesData));
+                filteredData.forEach((data, i) => (filteredData[i].data = data.data.filter((d) => filteredDimension.includes(d.dimension))));
+                getXAxis();
+                drawLineChart();
+            }));
+            svg.on("wheel", (event) => {
+                event.preventDefault();
+                const scrollDelta = Math.abs(event.deltaX) > Math.abs(event.deltaY)
+                    ? event.deltaX
+                    : event.deltaY;
+                scrollPosition += scrollDelta > 0 ? 1 : -1;
+                scrollPosition = Math.max(0, Math.min(scrollPosition, scrollMax));
+                const x = margin.left +
+                    ((innerWidth - handleWidth) * scrollPosition) / scrollMax;
+                handle.attr("x", x);
+                getXScale();
+                filteredData = JSON.parse(JSON.stringify(seriesData));
+                filteredData.forEach((data, i) => (filteredData[i].data = data.data.filter((d) => filteredDimension.includes(d.dimension))));
+                getXAxis();
+                drawLineChart();
+            });
+        }
+        drawLineChart();
+    };
+    const drawLineChart = () => {
+        // filteredData.forEach((data) => getChartType([data]));
+        getChartType(filteredData);
+        initXaxis(gTag, chartJSON, xLabel, formatOptions, xAxisObj[0], dataTableHeight, yScaleLeft, xAxis, dimensionHeightWidthArray, height, barWidth, xAxisObj[0].dataType, innerWidth, innerHeight, filteredDimension);
+        commonAnnotations(seriesData, xScale, yScaleLeft, yScaleRight, // need to pass secondary axis scale if secondary axis is drawn
+        margin, d3Annotation, [], //this.labelExcludeList,
+        [], //this.individualLabelColor,
+        [], //this.attributes.Id ? formatOptions.plotArea.dataLabelsCoordinates : this.parentReference.objService.tempAnnotationArray
+        formatOptions, chartType, height, width, innerWidth, filteredDimension, innerHeight, chartId, svg);
+        let newSeriesLabelArray = prepareDataForSeriesLabel(innerWidth, yScaleLeft, formatOptions, filteredData, yScaleRight, isSecondaryAxisDrawn).labelArray;
+        // adding series labels ( appending legends at the end of line : by default) in plot area
+        drawSeriesLabels(formatOptions, gTag, newSeriesLabelArray);
+    };
+    return (_jsxs("div", { style: { width: "100%", height: "100%" }, children: [_jsx("div", { id: "chartTooltipDiv" }), _jsx("svg", { className: "chartSVG", ref: svgRef, id: chartId, style: { width: "100%", height: "100%" } })] }));
+};
+export default LineChart;

package/dist/components/Charts/ChartsWithAxis/LineFamily/NormalisedStackLineChart.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import type { TLineChartProps } from "../ChartsWithAxisTypes.types";
+declare const NormalisedStackLineChart: React.FC<TLineChartProps>;
+export default NormalisedStackLineChart;