[FEATURE] Add canvas panel plugin by adrianSepiol · Pull Request #729 · perses/plugins

adrianSepiol · 2026-07-15T17:20:23Z

Description

Introduces the canvas panel plugin — a free-form network diagram editor for building weathermap-style dashboards. Users can place nodes, connect them with edges, and overlay background shapes or images. Node and edge colors can be driven by query-bound thresholds, and edge thickness can scale with metric values.

Screenshots

Here's a walkthrough of the main interactions:

Example weather map created in canvas:

Adding a node:

Screen.Recording.2026-07-20.at.15.26.09.mov

After creating a node, you can specify its label and position, add a link, bind a query to it, and use the query value in the label or derive the color from thresholds.

Adding an edge:

Screen.Recording.2026-07-20.at.15.26.45.mov

Edges are created by dragging from one node to another. They can be bidirectional and, like nodes, can have a query bound to them.

Zoom, pan, and resize:

Screen.Recording.2026-07-20.at.15.32.35.mov

Adding backgrounds:

adding.background.mov

Multiple backgrounds can be added with an image or a solid color at varying opacity levels. If "Global" is selected, the background always fills the entire view regardless of pan/zoom; otherwise it is scoped to a specified area.

Checklist

Pull request has a descriptive title and context useful to a reviewer.
Pull request title follows the [<catalog_entry>] <commit message> naming convention using one of the
following catalog_entry values: FEATURE, ENHANCEMENT, BUGFIX, BREAKINGCHANGE, DOC,IGNORE.
All commits have DCO signoffs.

UI Changes

Changes that impact the UI include screenshots and/or screencasts of the relevant changes.
Code follows the UI guidelines.

jgbernalp · 2026-07-24T08:53:36Z

@@ -0,0 +1,20 @@
+{
+  "kind": "Canvas",


It appears to me that this is a nodes panel rather than a canvas. Unless we are thinking about adding other things different from nodes in the future.

Yes, We would like to develop it further with new things. I think adding background is one of the things that is already here and fits more into "canvas" than "nodes" plugin.

jgbernalp · 2026-07-24T08:59:53Z

First of all, awesome job @adrianSepiol!

Would be there an option to create a graph (nodes and connections) based on a query? for example network topology charts have queries that return a list of nodes and their connections. In that case could this panel create a graph from that information in addition to the manual placement of nodes?

adrianSepiol · 2026-07-30T13:01:32Z

First of all, awesome job @adrianSepiol!

Would be there an option to create a graph (nodes and connections) based on a query? for example network topology charts have queries that return a list of nodes and their connections. In that case could this panel create a graph from that information in addition to the manual placement of nodes?

That is something we also discussed and would like to work on in the future, but the idea is to make this work with this spec for the first iteration and then add new functionalities gradually.

ibakshay

Great job Adrian! My agent found some nits.

ibakshay · 2026-08-18T10:16:38Z

+export function PanelEdgeLayer({ spec, seriesByQueryIndex, k, paletteColors }: PanelEdgeLayerProps): ReactElement {
+  const nodes = spec.nodes ?? [];
+  const edges = spec.edges ?? [];
+  const nodeById = new Map(nodes.map((n) => [n.id, n]));


[NOTE] Rule: js-index-maps — Build Maps for Repeated Lookups

const nodeById = new Map(nodes.map((n) => [n.id, n])) is created on every render without useMemo. Since PanelEdgeLayer re-renders on zoom changes, this map is rebuilt every time even though spec.nodes hasn't changed.

Fix: Wrap in useMemo(() => new Map(nodes.map(...)), [nodes]).

ibakshay · 2026-08-18T10:40:30Z

[SUGGESTION] please add a "info" message in the panel for the end users when the canvas is empty. Otherwise, it looks blank. Otherwise, the panel looks blank.

shahrokni · 2026-08-18T11:51:51Z

+	Color           string        `json:"color,omitempty" yaml:"color,omitempty"`
+}


Is this hex color code?

shahrokni · 2026-08-18T11:56:35Z

+	X2                  *float64      `json:"x2,omitempty" yaml:"x2,omitempty"`
+	Y2                  *float64      `json:"y2,omitempty" yaml:"y2,omitempty"`


Why do they have suffix '2'? Is this the edge's middle point?

ibakshay · 2026-08-18T12:09:07Z

In the edge settings, please add full names for north, south, ... instead of short abbreviations.

shahrokni · 2026-08-18T12:22:54Z

+        <TextField
+          label="X"
+          size="small"
+          type="number"
+          value={Math.round(background.x)}
+          onChange={onIntFieldChange('x')}
+          sx={{ width: 80 }}
+          disabled={background.global}
+        />
+        <TextField
+          label="Y"
+          size="small"
+          type="number"
+          value={Math.round(background.y)}
+          onChange={onIntFieldChange('y')}
+          sx={{ width: 80 }}
+          disabled={background.global}
+        />
+        <TextField
+          label="Width"
+          size="small"
+          type="number"
+          value={Math.round(background.width)}
+          slotProps={{ htmlInput: { min: 1 } }}
+          onChange={onIntFieldChange('width', 1)}
+          sx={{ width: 80 }}
+          disabled={background.global}
+        />
+        <TextField
+          label="Height"
+          size="small"
+          type="number"
+          value={Math.round(background.height)}
+          slotProps={{ htmlInput: { min: 1 } }}
+          onChange={onIntFieldChange('height', 1)}
+          sx={{ width: 80 }}
+          disabled={background.global}
+        />


I have not tested this part yet to understand what it exactly does.
However, my very first impression is that the repetitive part could be shortened using a loop over an array of x, y, height, and width. It seems 90% of these Text fields are identical.

⚠️ I will come back to this part later during the test to understand what it does.

shahrokni · 2026-08-18T12:42:21Z

+  function parseImageFit(value: string): BackgroundSpec['imageFit'] {
+    return IMAGE_FIT_OPTIONS.includes(value as BackgroundSpec['imageFit'])
+      ? (value as BackgroundSpec['imageFit'])
+      : undefined;
+  }


It seems this function guarantees that what is received complies with BackgroundSpec['imageFit'] otherwise it returns undefined.

Checking the rest of the PR I see it has been used in a Select with limited and expected options (Menu Items). So, the question would be why we need this, if it is always dealing with a set of deterministic values? The function would make sense if a free text input was also an option. Am I missing something?

<Select<BackgroundSpec['imageFit']> label="Image fit" value={background.imageFit ?? 'cover'} onChange={(e) => onChange({ ...background, imageFit: parseImageFit(e.target.value ?? '') })} MenuProps={{ PaperProps: { style: { maxHeight: 240 } } }} > <MenuItem value="cover">Cover</MenuItem> <MenuItem value="contain">Contain</MenuItem> <MenuItem value="stretch">Stretch</MenuItem> </Select>

shahrokni · 2026-08-19T09:38:04Z

@adrianSepiol
Thank you for the great contribution. ❤️
Do we need a data source to connect to?

network observability or service-mesh health overviews
How could we validate the plugin against a real network?

shahrokni · 2026-08-19T10:04:44Z

+          <Select<BackgroundSpec['imageFit']>
+            label="Image fit"
+            value={background.imageFit ?? 'cover'}
+            onChange={(e) => onChange({ ...background, imageFit: parseImageFit(e.target.value ?? '') })}


I have already made a comment about the parseImageFit.
https://github.com/perses/plugins/pull/729/changes#r3804121986

shahrokni · 2026-08-19T10:52:37Z

+      onChange({
+        ...edge,
+        target: e.target.value,
+        targetAnchor: edge.targetAnchor ?? 'n',


When targetAnchor is undefined, we always fall back to n.

Are multiple edges expected to be able to share the same anchor? If not, should we look up an available anchor instead?

Also, since the set of anchors is finite, how should we handle a node with more connected edges than available anchors?

shahrokni · 2026-08-19T11:25:49Z

+      const v = e.target.value;
+      onChange({ ...edge, sourceQueryIndex: v === '' ? undefined : Number(v) });
+    },


Should we validate sourceQueryIndex here?
Currently any none-empty value is converted with Number(V), which could potentially result in NaN, a negative value, or non-integer index.

shahrokni · 2026-08-19T11:30:17Z

+  const onTargetQueryIndexChange = useCallback(
+    (e: React.ChangeEvent<HTMLInputElement>): void => {
+      const v = e.target.value;
+      onChange({ ...edge, targetQueryIndex: v === '' ? undefined : Number(v) });
+    },
+    [edge, onChange]
+  );


I think this function could be merged with onSourceQueryIndexChange.
So, my suggestion is to merge the two functions and add a property name to the params. (targetQueryIndex and sourceQueryIndex)

They are pursuing the same goal and duplication could be avoided.

shahrokni · 2026-08-19T11:31:24Z

+  const onTargetLabelTemplateChange = useCallback(
+    (e: React.ChangeEvent<HTMLInputElement>): void => {
+      onChange({ ...edge, targetLabelTemplate: e.target.value || undefined });
+    },
+    [edge, onChange]
+  );


This is a duplication of onSourceLabelTemplateChange. As already mentioned, a single function with a property name as an input could avoid duplication.

shahrokni · 2026-08-19T11:34:32Z

+      <TextField
+        select
+        label="Source anchor"
+        size="small"
+        value={edge.sourceAnchor ?? 'n'}
+        onChange={onSourceAnchorChange}
+        slotProps={{ select: { MenuProps: { PaperProps: { style: { maxHeight: 240 } } } } }}
+      >
+        {ANCHOR_OPTIONS.map((a) => (
+          <MenuItem key={a} value={a}>
+            {a}
+          </MenuItem>
+        ))}
+      </TextField>


@shahrokni Test 👀

shahrokni · 2026-08-19T11:55:29Z

+      case 'selecting': {
+        const ids = applySelection();
+        selectItems(ids);
+        endInteraction();
+        break;
+      }


@shahrokni 👀 Test: Could it draw a selection box over an empty space of the canvas? Then what would happen?

shahrokni · 2026-08-19T11:56:06Z

+  const onSvgDoubleClick = useCallback(
+    (event: MouseEvent<SVGSVGElement>): void => {
+      if (event.ctrlKey || event.metaKey) {
+        const boundingBox = nodeBoundingBox(displayNodes);
+        if (boundingBox) {
+          fitView(boundingBox, width, height);
+        }
+      } else {
+        resetPan();
+      }
+    },
+    [displayNodes, fitView, resetPan, width, height]
+  );


@shahrokni Test 👀

shahrokni · 2026-08-19T12:02:09Z

+  const onKeyDown = useCallback(
+    (event: KeyboardEvent<SVGSVGElement>): void => {
+      if (event.key !== 'Delete' && event.key !== 'Backspace') {
+        return;
+      }
+      if (selectedIds.size > 0) {
+        deleteSelected();
+      }
+    },
+    [selectedIds, deleteSelected]
+  );


Not with this PR, but as a follow up,
Probably we should consider a simple Undo, Redo support,
Imagine that you have selected many nodes in a huge canvas, and just unintentionally, you press Delete.
Would be painful to reorganize everything again.

shahrokni · 2026-08-19T12:05:52Z

+            <EditorNode
+              key={node.id}
+              node={node}
+              isHovered={hoveredId === node.id}


@shahrokni Test 👀 Overlapping nodes

shahrokni · 2026-08-19T12:27:11Z

+// Copyright The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");


@shahrokni Test 👀 Node self connection?

shahrokni · 2026-08-19T12:43:19Z

+    const canvasWidth = containerRef.current?.clientWidth ?? 0;
+    const cx = transform.invertX(canvasWidth / 2);
+    const cy = transform.invertY(CANVAS_HEIGHT / 2);
+    addNode(cx, cy);


Should we avoid adding a node when the container is unavailable or has zero width?
Falling back to 0 here could result in calculating an unintended canvas position.
Simply, if no canvas or no width, why should we add a node?

shahrokni · 2026-08-19T13:04:44Z

+        <TextField
+          label="X"
+          size="small"
+          type="number"
+          value={Math.round(node.x)}
+          onChange={onIntFieldChange('x')}
+          sx={{ width: 80 }}
+        />
+        <TextField
+          label="Y"
+          size="small"
+          type="number"
+          value={Math.round(node.y)}
+          onChange={onIntFieldChange('y')}
+          sx={{ width: 80 }}
+        />
+        <TextField
+          label="Width"
+          size="small"
+          type="number"
+          value={Math.round(node.width)}
+          slotProps={{ htmlInput: { min: 8 } }}
+          onChange={onIntFieldChange('width', 8)}
+          sx={{ width: 80 }}
+        />
+        <TextField
+          label="Height"
+          size="small"
+          type="number"
+          value={Math.round(node.height)}
+          slotProps={{ htmlInput: { min: 8 } }}
+          onChange={onIntFieldChange('height', 8)}
+          sx={{ width: 80 }}
+        />


We have some duplication here. The Text Fields could be dynamically generated by a loop over and object-keys or array of X ,Y, Width, Height

shahrokni · 2026-08-19T13:20:22Z

+          sx={{ width: 80 }}
+        />
+      </Stack>
+


@shahrokni Test 👀

shahrokni · 2026-08-19T14:09:35Z

+// Copyright The Perses Authors
+// Licensed under the Apache License, Version 2.0 (the "License");


@shahrokni Test 👀 Pre-ordered SVG layers. Could it be problamatic?

shahrokni · 2026-08-19T14:12:19Z

+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//


@shahrokni Test 👀 Importance of Ctrl+ Click for select for larger canvases.

shahrokni · 2026-08-20T08:06:43Z

@@ -0,0 +1,63 @@
+// Copyright The Perses Authors


@shahrokni Test 👀 Collision if it is a long list of legends?

shahrokni · 2026-08-20T10:22:07Z

+    onChange(
+      produce(spec, (draft) => {
+        const idx = (draft.backgrounds ?? []).findIndex((bg) => bg.id === updated.id);
+        if (idx !== -1 && draft.backgrounds) {
+          draft.backgrounds[idx] = updated;
+        }
+      })
+    );


https://github.com/perses/plugins/pull/729/changes#r3820654954

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com> [ENHANCEMENT] update panel schema re-exports to use @perses-dev/plugin-system panelEditorSchema and buildPanelEditorSchema have moved from @perses-dev/spec to @perses-dev/plugin-system. Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

…mponent Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

…eeEndpoint properties Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

…points Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

adrianSepiol force-pushed the feature/canvas-panel-plugin branch 8 times, most recently from 39b9803 to d73e5e2 Compare July 17, 2026 07:54

adrianSepiol marked this pull request as ready for review July 20, 2026 13:42

adrianSepiol requested review from a team, AntoineThebaud and Nexucis as code owners July 20, 2026 13:42

adrianSepiol requested review from shahrokni and removed request for a team July 20, 2026 13:42

jgbernalp reviewed Jul 24, 2026

View reviewed changes

ibakshay reviewed Aug 18, 2026

View reviewed changes

shahrokni reviewed Aug 18, 2026

View reviewed changes

shahrokni reviewed Aug 19, 2026

View reviewed changes

shahrokni reviewed Aug 20, 2026

View reviewed changes

adrianSepiol force-pushed the feature/canvas-panel-plugin branch 2 times, most recently from 994b9f4 to 5fee794 Compare August 21, 2026 08:41

shahrokni reviewed Aug 21, 2026

View reviewed changes

adrianSepiol force-pushed the feature/canvas-panel-plugin branch from 4b84d3b to 7c250fb Compare August 21, 2026 11:29

adrianSepiol added 9 commits September 3, 2026 11:00

[IGNORE] Refactor node rendering to use EditorNodeItem component

7ad66d0

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

[IGNORE] format code with oxfmt and fix package-lock.json after merge.

96b3ef2

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

[IGNORE] Refactor edge rendering to use EditorEdgeItem

8ebcc05

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

[IGNORE] fix dependencies

3dbc577

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

[IGNORE] apply code best practices

f7da51b

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

[IGNORE] Refactor Edge and Node property panels to use SelectField co…

317424f

…mponent Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

refactor: update node and edge data structures to use position and fr…

2641e21

…eeEndpoint properties Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

refactor: fix lint errors

f6084d9

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

adrianSepiol force-pushed the feature/canvas-panel-plugin branch from 29c29f2 to 2fe63b0 Compare September 3, 2026 12:56

refactor: fix lint warnings

f34b60c

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

adrianSepiol force-pushed the feature/canvas-panel-plugin branch from 2fe63b0 to f34b60c Compare September 3, 2026 13:06

adrianSepiol added 5 commits September 3, 2026 15:29

feat: refactor anchor options to use constants for improved readability

f79fb4a

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

feat: enhance zoom functionality with panning state management

a5c5765

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

feat: introduce ThicknessMode type and update EdgeSpec to use it

8184392

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

refactor: unify point representation in edge and connection components

f36f58b

Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

feat: refactor selection rectangle handling to use anchor and corner …

9ef60bd

…points Signed-off-by: Adrian Sepiół <a.sepiol@sap.com>

adrianSepiol force-pushed the feature/canvas-panel-plugin branch from 013a2c7 to 9ef60bd Compare September 3, 2026 14:18

		Color string `json:"color,omitempty" yaml:"color,omitempty"`
		}

		X2 *float64 `json:"x2,omitempty" yaml:"x2,omitempty"`
		Y2 *float64 `json:"y2,omitempty" yaml:"y2,omitempty"`

		// Copyright The Perses Authors
		// Licensed under the Apache License, Version 2.0 (the "License");

Uh oh!

Conversation

adrianSepiol commented Jul 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Screenshots

Checklist

UI Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jgbernalp commented Jul 24, 2026

Uh oh!

adrianSepiol commented Jul 30, 2026

Uh oh!

ibakshay left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ibakshay commented Aug 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ibakshay commented Aug 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shahrokni commented Aug 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adrianSepiol commented Jul 15, 2026 •

edited

Loading

ibakshay left a comment •

edited

Loading

shahrokni commented Aug 19, 2026 •

edited

Loading