@perses-dev/timeseries-chart-plugin 0.13.0 → 0.14.0-beta.2

package/lib/cjs/TimeSeriesChart.js

@@ -1,50 +0,0 @@
-// Copyright The Perses Authors
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "TimeSeriesChart", {
-    enumerable: true,
-    get: function() {
-        return TimeSeriesChart;
-    }
-});
-const _timeserieschartmodel = require("./time-series-chart-model");
-const _GeneralSettingsEditor = require("./GeneralSettingsEditor");
-const _QuerySettingsEditor = require("./QuerySettingsEditor");
-const _TimeSeriesChartPanel = require("./TimeSeriesChartPanel");
-const _TimeSeriesExportAction = require("./TimeSeriesExportAction");
-const TimeSeriesChart = {
-    PanelComponent: _TimeSeriesChartPanel.TimeSeriesChartPanel,
-    supportedQueryTypes: [
-        'TimeSeriesQuery'
-    ],
-    panelOptionsEditorComponents: [
-        {
-            label: 'General Settings',
-            content: _GeneralSettingsEditor.TimeSeriesChartGeneralSettings
-        },
-        {
-            label: 'Query Settings',
-            content: _QuerySettingsEditor.QuerySettingsEditor
-        }
-    ],
-    createInitialOptions: _timeserieschartmodel.createInitialTimeSeriesChartOptions,
-    actions: [
-        {
-            component: _TimeSeriesExportAction.TimeSeriesExportAction,
-            location: 'header'
-        }
-    ]
-};

package/lib/cjs/TimeSeriesChartBase.js

@@ -1,488 +0,0 @@
-// Copyright The Perses Authors
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "TimeSeriesChartBase", {
-    enumerable: true,
-    get: function() {
-        return TimeSeriesChartBase;
-    }
-});
-const _jsxruntime = require("react/jsx-runtime");
-const _react = require("react");
-const _material = require("@mui/material");
-const _merge = /*#__PURE__*/ _interop_require_default(require("lodash/merge"));
-const _isEqual = /*#__PURE__*/ _interop_require_default(require("lodash/isEqual"));
-const _core = require("echarts/core");
-const _charts = require("echarts/charts");
-const _components = require("echarts/components");
-const _renderers = require("echarts/renderers");
-const _components1 = require("@perses-dev/components");
-const _timezoneformatter = require("./utils/timezone-formatter");
-const _AnnotationTooltip = require("./annotations/AnnotationTooltip");
-function _interop_require_default(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-(0, _core.use)([
-    _charts.LineChart,
-    _charts.BarChart,
-    _components.GridComponent,
-    _components.DatasetComponent,
-    _components.DataZoomComponent,
-    _components.MarkAreaComponent,
-    _components.MarkLineComponent,
-    _components.MarkPointComponent,
-    _components.TitleComponent,
-    _components.ToolboxComponent,
-    _components.TooltipComponent,
-    _renderers.CanvasRenderer
-]);
-const TimeSeriesChartBase = /*#__PURE__*/ (0, _react.forwardRef)(function TimeChart({ height, data, seriesMapping, annotations, timeScale: timeScaleProp, yAxis, format, seriesFormatMap, grid, isStackedBar = false, tooltipConfig = _components1.DEFAULT_TOOLTIP_CONFIG, noDataVariant = 'message', syncGroup, onDataZoom, onDoubleClick, __experimentalEChartsOptionsOverride }, ref) {
-    const { chartsTheme, enablePinning, enableSyncGrouping, lastTooltipPinnedCoords, setLastTooltipPinnedCoords } = (0, _components1.useChartsContext)();
-    const isPinningEnabled = tooltipConfig.enablePinning && enablePinning;
-    const chartRef = (0, _react.useRef)();
-    const [showTooltip, setShowTooltip] = (0, _react.useState)(true);
-    const [tooltipPinnedCoords, setTooltipPinnedCoords] = (0, _react.useState)(null);
-    const [pinnedCrosshair, setPinnedCrosshair] = (0, _react.useState)(null);
-    const [isDragging, setIsDragging] = (0, _react.useState)(false);
-    const [startX, setStartX] = (0, _react.useState)(0);
-    const [hoveredAnnotation, setHoveredAnnotation] = (0, _react.useState)(null);
-    const [pinnedAnnotation, setPinnedAnnotation] = (0, _react.useState)(null);
-    const [pinnedAnnotationPos, setPinnedAnnotationPos] = (0, _react.useState)(null);
-    const { timeZone, formatWithUserTimeZone } = (0, _components1.useTimeZone)();
-    const getTimezoneAwareAxisFormatter = (0, _react.useCallback)((rangeMs)=>(0, _timezoneformatter.createTimezoneAwareAxisFormatter)(rangeMs, timeZone), [
-        timeZone
-    ]);
-    let timeScale;
-    if (timeScaleProp === undefined) {
-        const commonTimeScale = (0, _components1.getCommonTimeScale)(data);
-        if (commonTimeScale === undefined) {
-            // set default to past 5 years
-            const today = new Date();
-            const pastDate = new Date(today);
-            pastDate.setFullYear(today.getFullYear() - 5);
-            const todayMs = today.getTime();
-            const pastDateMs = pastDate.getTime();
-            timeScale = {
-                startMs: pastDateMs,
-                endMs: todayMs,
-                stepMs: 1,
-                rangeMs: todayMs - pastDateMs
-            };
-        } else {
-            timeScale = commonTimeScale;
-        }
-    } else {
-        timeScale = timeScaleProp;
-    }
-    (0, _react.useImperativeHandle)(ref, ()=>{
-        return {
-            highlightSeries ({ name }) {
-                if (!chartRef.current) {
-                    // when chart undef, do not highlight series when hovering over legend
-                    return;
-                }
-                chartRef.current.dispatchAction({
-                    type: 'highlight',
-                    seriesId: name
-                });
-            },
-            clearHighlightedSeries: ()=>{
-                if (!chartRef.current) {
-                    // when chart undef, do not clear highlight series
-                    return;
-                }
-                (0, _components1.clearHighlightedSeries)(chartRef.current);
-            }
-        };
-    }, []);
-    const handleEvents = (0, _react.useMemo)(()=>{
-        return {
-            datazoom: (params)=>{
-                if (onDataZoom === undefined) {
-                    setTimeout(()=>{
-                        // workaround so unpin happens after click event
-                        setTooltipPinnedCoords(null);
-                    }, 10);
-                }
-                if (onDataZoom === undefined || params.batch[0] === undefined) return;
-                const xAxisStartValue = params.batch[0].startValue;
-                const xAxisEndValue = params.batch[0].endValue;
-                if (xAxisStartValue !== undefined && xAxisEndValue !== undefined) {
-                    const zoomEvent = {
-                        start: xAxisStartValue,
-                        end: xAxisEndValue
-                    };
-                    onDataZoom(zoomEvent);
-                }
-            },
-            finished: ()=>{
-                if (chartRef.current !== undefined) {
-                    (0, _components1.enableDataZoom)(chartRef.current);
-                }
-            },
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            mouseover: (params)=>{
-                // Only markPoint (triangles under the X-axis) opens the annotation tooltip.
-                // Hovering markLine or anything else keeps the regular TimeSeries tooltip visible
-                // and clears any stale hovered annotation (mouseout is sometimes missed by ECharts).
-                if (annotations && params.componentType === 'markPoint' && params.data?.annotationIndex !== undefined) {
-                    const matchedAnnotation = annotations[params.data.annotationIndex] || null;
-                    if (matchedAnnotation) {
-                        setHoveredAnnotation(matchedAnnotation);
-                        return;
-                    }
-                }
-                setHoveredAnnotation(null);
-            },
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            mouseout: (params)=>{
-                if (annotations && params.componentType === 'markPoint' && params.data?.annotationIndex !== undefined && annotations) {
-                    // Only clear if the mouseout corresponds to the currently hovered annotation, so that
-                    // a quick move from one markPoint to another isn't cancelled by a late mouseout event.
-                    const leaving = annotations[params.data.annotationIndex] || null;
-                    setHoveredAnnotation((current)=>current === leaving ? null : current);
-                }
-            },
-            globalout: ()=>{
-                if (annotations) {
-                    // Cursor left the chart canvas — guarantee the annotation tooltip is dismissed.
-                    setHoveredAnnotation(null);
-                }
-            }
-        };
-    }, [
-        annotations,
-        onDataZoom
-    ]);
-    // Generate annotation series for ECharts markArea (range), markLine (point), and markPoint (markers under X-axis)
-    const annotationSeries = (0, _react.useMemo)(()=>(0, _AnnotationTooltip.buildAnnotationSeries)(annotations), [
-        annotations
-    ]);
-    const { noDataOption } = chartsTheme;
-    const option = (0, _react.useMemo)(()=>{
-        // The "chart" `noDataVariant` is only used when the `timeSeries` is an
-        // empty array because a `null` value will throw an error.
-        if (data === null || data.length === 0 && noDataVariant === 'message') return noDataOption;
-        // Utilizes ECharts dataset so raw data is separate from series option style properties
-        // https://apache.github.io/echarts-handbook/en/concepts/dataset/
-        const dataset = [];
-        data.map((d, index)=>{
-            const values = d.values.map(([timestamp, value])=>{
-                const val = value === null ? '-' : value; // echarts use '-' to represent null data
-                return [
-                    timestamp,
-                    val
-                ];
-            });
-            dataset.push({
-                id: index,
-                source: [
-                    ...values
-                ],
-                dimensions: [
-                    'time',
-                    'value'
-                ]
-            });
-        });
-        const updatedSeriesMapping = enablePinning && pinnedCrosshair !== null ? [
-            ...seriesMapping,
-            pinnedCrosshair,
-            ...annotationSeries
-        ] : [
-            ...seriesMapping,
-            ...annotationSeries
-        ];
-        const option = {
-            dataset: dataset,
-            series: updatedSeriesMapping,
-            xAxis: {
-                type: 'time',
-                min: timeScale.startMs,
-                max: timeScale.endMs,
-                axisLabel: {
-                    hideOverlap: true,
-                    formatter: getTimezoneAwareAxisFormatter(timeScale.rangeMs ?? 0)
-                },
-                axisPointer: {
-                    snap: false
-                }
-            },
-            // If yAxis is already an array (multiple Y axes), use it directly; otherwise use getFormattedAxis
-            yAxis: Array.isArray(yAxis) ? yAxis : (0, _components1.getFormattedAxis)(yAxis, format),
-            animation: false,
-            tooltip: {
-                show: true,
-                // ECharts tooltip content hidden by default since we use custom tooltip instead.
-                // Stacked bar uses ECharts tooltip so subgroup data shows correctly.
-                showContent: isStackedBar,
-                trigger: isStackedBar ? 'item' : 'axis',
-                appendToBody: isStackedBar
-            },
-            // https://echarts.apache.org/en/option.html#axisPointer
-            axisPointer: {
-                type: 'line',
-                z: 0,
-                triggerEmphasis: false,
-                triggerTooltip: false,
-                snap: false
-            },
-            toolbox: {
-                feature: {
-                    dataZoom: {
-                        icon: null,
-                        yAxisIndex: 'none'
-                    }
-                }
-            },
-            grid
-        };
-        if (__experimentalEChartsOptionsOverride) {
-            return __experimentalEChartsOptionsOverride(option);
-        }
-        return option;
-    }, [
-        data,
-        seriesMapping,
-        annotationSeries,
-        timeScale,
-        yAxis,
-        format,
-        grid,
-        noDataOption,
-        __experimentalEChartsOptionsOverride,
-        noDataVariant,
-        isStackedBar,
-        enablePinning,
-        pinnedCrosshair,
-        getTimezoneAwareAxisFormatter
-    ]);
-    // Update adjacent charts so tooltip is unpinned when current chart is clicked.
-    (0, _react.useEffect)(()=>{
-        // Only allow pinning one tooltip at a time, subsequent tooltip click unpins previous.
-        // Multiple tooltips can only be pinned if Ctrl or Cmd key is pressed while clicking.
-        const multipleTooltipsPinned = tooltipPinnedCoords !== null && lastTooltipPinnedCoords !== null;
-        if (multipleTooltipsPinned) {
-            if (!(0, _isEqual.default)(lastTooltipPinnedCoords, tooltipPinnedCoords)) {
-                setTooltipPinnedCoords(null);
-                if (tooltipPinnedCoords !== null && pinnedCrosshair !== null) {
-                    setPinnedCrosshair(null);
-                }
-            }
-        }
-    // tooltipPinnedCoords CANNOT be in dep array or tooltip pinning breaks in the current chart's onClick
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, [
-        lastTooltipPinnedCoords,
-        seriesMapping
-    ]);
-    return /*#__PURE__*/ (0, _jsxruntime.jsxs)(_material.Box, {
-        style: {
-            height
-        },
-        // onContextMenu={(e) => {
-        //   // TODO: confirm tooltip pinning works correctly on Windows, should e.preventDefault() be added here
-        //   e.preventDefault(); // Prevent the default behaviour when right clicked
-        // }}
-        onClick: (e)=>{
-            // If clicking while hovering an annotation, toggle the annotation tooltip pin
-            // instead of pinning the TimeChartTooltip, so pinned TimeChartTooltip is preserved.
-            if (hoveredAnnotation !== null && e.target instanceof HTMLCanvasElement) {
-                const pinnedPos = {
-                    page: {
-                        x: e.pageX,
-                        y: e.pageY
-                    },
-                    client: {
-                        x: e.clientX,
-                        y: e.clientY
-                    },
-                    plotCanvas: {
-                        x: e.nativeEvent.offsetX,
-                        y: e.nativeEvent.offsetY
-                    },
-                    target: e.target
-                };
-                setPinnedAnnotation((current)=>{
-                    if (current === hoveredAnnotation) {
-                        setPinnedAnnotationPos(null);
-                        return null;
-                    }
-                    setPinnedAnnotationPos(pinnedPos);
-                    return hoveredAnnotation;
-                });
-                return;
-            }
-            // Allows user to opt-in to multi tooltip pinning when Ctrl or Cmd key held down
-            const isControlKeyPressed = e.ctrlKey || e.metaKey;
-            if (isControlKeyPressed) {
-                e.preventDefault();
-            }
-            // Determine where on chart canvas to plot pinned crosshair as markLine.
-            const pointInGrid = (0, _components1.getPointInGrid)(e.nativeEvent.offsetX, e.nativeEvent.offsetY, chartRef.current);
-            if (pointInGrid === null) {
-                return;
-            }
-            // Pin and unpin when clicking on chart canvas but not tooltip text.
-            if (isPinningEnabled && e.target instanceof HTMLCanvasElement) {
-                // Pin tooltip and update shared charts context to remember these coordinates.
-                const pinnedPos = {
-                    page: {
-                        x: e.pageX,
-                        y: e.pageY
-                    },
-                    client: {
-                        x: e.clientX,
-                        y: e.clientY
-                    },
-                    plotCanvas: {
-                        x: e.nativeEvent.offsetX,
-                        y: e.nativeEvent.offsetY
-                    },
-                    target: e.target
-                };
-                setTooltipPinnedCoords((current)=>{
-                    if (current === null) {
-                        return pinnedPos;
-                    } else {
-                        setPinnedCrosshair(null);
-                        return null;
-                    }
-                });
-                setPinnedCrosshair((current)=>{
-                    // Only add pinned crosshair line series when there is not one already in seriesMapping.
-                    if (current === null) {
-                        const cursorX = pointInGrid[0];
-                        // Only need to loop through first dataset source since getCommonTimeScale ensures xAxis timestamps are consistent
-                        const firstTimeSeriesValues = data[0]?.values;
-                        const closestTimestamp = (0, _components1.getClosestTimestamp)(firstTimeSeriesValues, cursorX);
-                        // Crosshair snaps to nearest timestamp since cursor may be slightly to left or right
-                        const pinnedCrosshair = (0, _merge.default)({}, _components1.DEFAULT_PINNED_CROSSHAIR, {
-                            markLine: {
-                                data: [
-                                    {
-                                        xAxis: closestTimestamp
-                                    }
-                                ]
-                            }
-                        });
-                        return pinnedCrosshair;
-                    } else {
-                        // Clear previously set pinned crosshair
-                        return null;
-                    }
-                });
-                if (!isControlKeyPressed) {
-                    setLastTooltipPinnedCoords(pinnedPos);
-                }
-            }
-        },
-        onMouseDown: (e)=>{
-            const { clientX } = e;
-            setIsDragging(true);
-            setStartX(clientX);
-        },
-        onMouseMove: (e)=>{
-            // Allow clicking inside tooltip to copy labels.
-            if (!(e.target instanceof HTMLCanvasElement)) {
-                return;
-            }
-            const { clientX } = e;
-            if (isDragging) {
-                const deltaX = clientX - startX;
-                if (deltaX > 0) {
-                    // Hide tooltip when user drags to zoom.
-                    setShowTooltip(false);
-                }
-            }
-        },
-        onMouseUp: ()=>{
-            setIsDragging(false);
-            setStartX(0);
-            setShowTooltip(true);
-        },
-        onMouseLeave: ()=>{
-            if (tooltipPinnedCoords === null) {
-                setShowTooltip(false);
-            }
-            // Defensive: clear hovered annotation in case ECharts missed a mouseout event.
-            setHoveredAnnotation(null);
-            if (chartRef.current !== undefined) {
-                (0, _components1.clearHighlightedSeries)(chartRef.current);
-            }
-        },
-        onMouseEnter: ()=>{
-            setShowTooltip(true);
-            if (chartRef.current !== undefined) {
-                (0, _components1.enableDataZoom)(chartRef.current);
-            }
-        },
-        onDoubleClick: (e)=>{
-            setTooltipPinnedCoords(null);
-            // either dispatch ECharts restore action to return to orig state or allow consumer to define behavior
-            if (onDoubleClick === undefined) {
-                if (chartRef.current !== undefined) {
-                    (0, _components1.restoreChart)(chartRef.current);
-                }
-            } else {
-                onDoubleClick(e);
-            }
-        },
-        children: [
-            showTooltip === true && (tooltipPinnedCoords !== null || hoveredAnnotation === null) && option.tooltip?.showContent === false && tooltipConfig.hidden !== true && /*#__PURE__*/ (0, _jsxruntime.jsx)(_components1.TimeChartTooltip, {
-                containerId: chartsTheme.tooltipPortalContainerId,
-                chartRef: chartRef,
-                data: data,
-                seriesMapping: seriesMapping,
-                wrapLabels: tooltipConfig.wrapLabels,
-                enablePinning: isPinningEnabled,
-                pinnedPos: tooltipPinnedCoords,
-                format: format,
-                seriesFormatMap: seriesFormatMap,
-                onUnpinClick: ()=>{
-                    // Unpins tooltip when clicking Pin icon in TooltipHeader.
-                    setTooltipPinnedCoords(null);
-                    // Clear previously set pinned crosshair.
-                    setPinnedCrosshair(null);
-                }
-            }),
-            (pinnedAnnotation ?? hoveredAnnotation) && /*#__PURE__*/ (0, _jsxruntime.jsx)(_AnnotationTooltip.AnnotationTooltip, {
-                annotation: pinnedAnnotation ?? hoveredAnnotation,
-                containerId: chartsTheme.tooltipPortalContainerId,
-                formatWithUserTimeZone: formatWithUserTimeZone,
-                pinnedPos: pinnedAnnotation !== null ? pinnedAnnotationPos : null,
-                enablePinning: isPinningEnabled,
-                onUnpinClick: ()=>{
-                    setPinnedAnnotation(null);
-                    setPinnedAnnotationPos(null);
-                }
-            }),
-            /*#__PURE__*/ (0, _jsxruntime.jsx)(_components1.EChart, {
-                sx: {
-                    width: '100%',
-                    height: '100%'
-                },
-                option: option,
-                theme: chartsTheme.echartsTheme,
-                onEvents: handleEvents,
-                _instance: chartRef,
-                syncGroup: enableSyncGrouping ? syncGroup : undefined
-            })
-        ]
-    });
-});