Add field settings per user

docker-compose.yml

@@ -1,12 +1,13 @@
 services:
   grafana:
-    image: grafana/grafana:11.4.0
+    image: grafana/grafana:main
     ports:
       - 3000:3000/tcp
     environment:
       - GF_DEFAULT_APP_MODE=development
       - GF_DASHBOARDS_DEFAULT_HOME_DASHBOARD_PATH=/etc/grafana/provisioning/dashboards/panels.json
       - GF_INSTALL_PLUGINS=volkovlabs-variable-panel
+      - GF_FEATURE_TOGGLES_ENABLE=userStorageAPI
     volumes:
       - ./dist:/var/lib/grafana/plugins/volkovlabs-timeseries-panel
       - ./provisioning:/etc/grafana/provisioning

package.json

@@ -3,7 +3,7 @@
   "dependencies": {
     "@emotion/css": "^11.13.0",
     "@grafana/data": "^11.1.4",
-    "@grafana/runtime": "^11.1.4",
+    "@grafana/runtime": "^11.5.0-216340",
     "@grafana/schema": "^11.1.4",
     "@grafana/ui": "^11.1.4",
     "@reduxjs/toolkit": "^2.2.7",

src/TimeSeriesPanel.tsx

@@ -1,11 +1,21 @@
 import { config } from 'app/core/config';
 import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react';
-import { DashboardCursorSync, DataFrame, DataFrameType, PanelProps, toDataFrame, VizOrientation } from '@grafana/data';
-import { getBackendSrv, PanelDataErrorView, TimeRangeUpdatedEvent } from '@grafana/runtime';
+import {
+  DashboardCursorSync,
+  DataFrame,
+  DataFrameType,
+  FieldType,
+  PanelProps,
+  toDataFrame,
+  VizOrientation,
+} from '@grafana/data';
+import { getBackendSrv, PanelDataErrorView, TimeRangeUpdatedEvent, usePluginUserStorage } from '@grafana/runtime';
 import { TooltipDisplayMode } from '@grafana/schema';
 import { Button, EventBusPlugin, KeyboardPlugin, TooltipPlugin2, usePanelContext } from '@grafana/ui';
 import { useDashboardRefresh } from '@volkovlabs/components';
 import { TimeSeries } from 'app/core/components/TimeSeries/TimeSeries';
+import { FrameSettingsEditor } from 'plugins/frameSettings/FrameSettingsEditor';
+import { FieldSettings } from 'app/types/frameSettings';
 import { Options } from './panelcfg.gen';
 import { ExemplarsPlugin, getVisibleLabels } from './plugins/ExemplarsPlugin';
 import { OutsideRangePlugin } from './plugins/OutsideRangePlugin';
@@ -52,7 +62,22 @@ export const TimeSeriesPanel = ({
   } = usePanelContext();
 
   const [isAddingTimescale, setAddingTimescale] = useState(false);
-  const [timescaleTriggerCoords, setTimescaleTriggerCoords] = useState<{ left: number; top: number } | null>(null);
+  const [fieldSettings, setFieldSettings] = useState<FieldSettings[]>([]);
+  const [showFrameSettings, setShowFrameSettings] = useState(false);
+  const [triggerCoords, setTriggerCoords] = useState<{ left: number; top: number } | null>(null);
+
+  const storage = usePluginUserStorage();
+
+  useEffect(() => {
+    storage.getItem('volkovlabs.TimeSeriesPanel.fieldSettings').then((value: string | null) => {
+      setFieldSettings(value ? JSON.parse(value) : []);
+    });
+
+    /**
+     * Load once
+     */
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
 
   const panelRoot = useRef<HTMLDivElement>(null);
 
@@ -62,7 +87,32 @@ export const TimeSeriesPanel = ({
   const dashboardRefresh = useDashboardRefresh();
 
   const isVerticallyOriented = options.orientation === VizOrientation.Vertical;
-  const frames = useMemo(() => prepareGraphableFields(data.series, config.theme2, timeRange), [data.series, timeRange]);
+  const frames = useMemo(
+    () => prepareGraphableFields(data.series, config.theme2, fieldSettings, timeRange),
+    [data.series, fieldSettings, timeRange]
+  );
+
+  const isAllFieldsHidden = useMemo(() => {
+    const currentFields = frames?.flatMap((frame) => frame.fields).filter((field) => field.type !== FieldType.time);
+
+    /**
+     * hidden property has true flag
+     */
+    return currentFields?.every((field) => field.config.custom.hideFrom.viz);
+  }, [frames]);
+
+  /**
+   * revId use for structureRev
+   * Should be changed when data changes or frame changes to render TimeSeries correctly
+   */
+  const revId = useMemo(() => {
+    if (!!frames?.length || data.structureRev) {
+      const structureRev = data.structureRev || 0;
+      return structureRev + Math.random();
+    }
+    return Math.random();
+  }, [data.structureRev, frames]);
+
   const timezones = useMemo(() => getTimezones(options.timezone, timeZone), [options.timezone, timeZone]);
 
   const [timescalesFrame, setTimescalesFrame] = useState<DataFrame | null>(null);
@@ -230,10 +280,30 @@ export const TimeSeriesPanel = ({
   }
 
   return (
-    <div ref={panelRoot}>
+    <div
+      ref={panelRoot}
+      onClick={() => {
+        /**
+         * Show modal for field settings if all fields are hidden
+         */
+        if (isAllFieldsHidden && !showFrameSettings) {
+          if (panelRoot.current) {
+            /**
+             * setTriggerCoords
+             */
+            const { right, bottom } = panelRoot.current?.getBoundingClientRect();
+            setTriggerCoords({ left: right / 2, top: bottom / 2 });
+          }
+          setShowFrameSettings(true);
+        }
+      }}
+    >
       <TimeSeries
         frames={frames}
-        structureRev={data.structureRev}
+        /**
+         * structureRev use to rerender TimeSeries (compare props.)
+         */
+        structureRev={revId}
         timeRange={timeRange}
         timeZone={timezones}
         width={width}
@@ -330,14 +400,22 @@ export const TimeSeriesPanel = ({
                           </div>
                         }
                         footerContent={
-                          <>
+                          <div
+                            style={{
+                              display: 'flex',
+                              flexDirection: 'column',
+                            }}
+                          >
                             <Button
                               icon="channel-add"
                               variant="secondary"
                               size="sm"
+                              style={{
+                                marginBottom: '8px',
+                              }}
                               id="custom-scales"
                               onClick={() => {
-                                setTimescaleTriggerCoords({
+                                setTriggerCoords({
                                   left: u.rect.left + (u.cursor.left ?? 0),
                                   top: u.rect.top + (u.cursor.top ?? 0),
                                 });
@@ -348,7 +426,23 @@ export const TimeSeriesPanel = ({
                             >
                               Custom scales
                             </Button>
-                          </>
+                            <Button
+                              icon="chart-line"
+                              variant="secondary"
+                              size="sm"
+                              id="frame-settings"
+                              onClick={() => {
+                                setTriggerCoords({
+                                  left: u.rect.left + (u.cursor.left ?? 0),
+                                  top: u.rect.top + (u.cursor.top ?? 0),
+                                });
+                                setShowFrameSettings(true);
+                                dismiss();
+                              }}
+                            >
+                              Frame settings
+                            </Button>
+                          </div>
                         }
                       />
                     );
@@ -410,12 +504,28 @@ export const TimeSeriesPanel = ({
                   scales={scales}
                   style={{
                     position: 'absolute',
-                    left: timescaleTriggerCoords?.left,
-                    top: timescaleTriggerCoords?.top,
+                    left: triggerCoords?.left,
+                    top: triggerCoords?.top,
                   }}
                   timescalesFrame={timescalesFrame}
                 />
               )}
+              {showFrameSettings && (
+                <FrameSettingsEditor
+                  style={{
+                    position: 'absolute',
+                    left: triggerCoords?.left,
+                    top: triggerCoords?.top,
+                  }}
+                  onSave={(settings: FieldSettings[]) => {
+                    setFieldSettings(settings);
+                    storage.setItem('volkovlabs.TimeSeriesPanel.fieldSettings', JSON.stringify(settings));
+                  }}
+                  onDismiss={() => setShowFrameSettings(false)}
+                  fieldSettings={fieldSettings}
+                  frames={frames}
+                />
+              )}
             </>
           );
         }}