Create an interactive diagram and toggle layers with custom links
Complex diagrams can be made a lot easier to read and understand when you split them up into logical smaller diagrams on multiple pages, or by using a number of layers.
To learn more about the complex diagram, you can toggle the display of layers and step to another diagram page using the toolbar at the bottom of the diagram viewer, or the layers dialog and page tabs in the diagram editor.
Alternatively, you can make your diagram interactive by adding custom links to the shapes and text within the diagram that act as intuitive toggle switches - you don’t have to use the toolbar to interact with your diagram.
Diagrams that can benefit from adding interactive layers within the diagram itself include network or infrastructure diagrams, floor plans and gitflow diagrams.
Learn more about using layers in diagrams.net
Use custom links to add interactivity
Custom links are small pieces of JSON code containing the shape or layer IDs of the diagram elements you want to make interactive.
open a web URL or custom link,
toggle elements on or off,
highlight diagram elements,
scroll to a specific element in the diagram, or set a
viewbox with a custom link.
For example, the following JSON action in a custom link toggles the display of a layer - it hides it if it is visible, or displays it if it is hidden.
Learn more about custom links
An example interactive gitflow diagram
In the example below, interactive layer
toggle switches will be added to the gitflow diagram to let you click on the following labels and display or hide their branches.
- Release and Release Fix
- Feature team 1 and their development branches
- Feature team 2 and their development branches
The Master, Nightly, and Hotfix branches, and the Development label are always displayed, and therefore placed on the background layer.
Open the interactive gitflow example in the diagrams.net viewer
Set up shapes to use as toggle switches
When you click on a shape that is used as a toggle and it exists on the layer or in the group that you want to hide, you won’t be able to click on it again.
- Make a copy of the shapes you want to use as toggles, and paste them onto the Background layer.
- Position them directly under the original shapes on the other layers so that when you click, diagram elements don’t appear to move position.
Copy the layer ID
- Select View > Layers or press
Cmd+Shift+L to display the Layers dialog if you don’t see it.
- Select a layer, then click on the Edit Data in the Layers dialog (three vertical dots).
- Copy the layer ID - the long string of numbers and letters.
Tip: If you want to toggle shapes instead of a layer, press
Cmd+M to edit the shape’s metadata, then copy its ID (a short number).
Build the custom link
- Go to jgraph.github.io/drawio-tools/tools/link.html.
- Paste the layer ID into the Cells/Layers text field. You can toggle more than one layer or shape in a custom link - add all of their shape/layer IDs separated by a space.
- Click on 4. Click Here to Add! to generate the Custom Link in the larger text field below.
- Click on Copy to Clipboard to copy the Custom Link.
Add the custom link to a shape
- Back in the diagrams.net editor, right-click on a shape in your diagram, then select Edit Link, or select the shape and use the keyboard shortcut
- Enter the custom link in the first text field, then click Apply.
- Make sure you add the same link to the matching shape on the Background layer so you can toggle the layer back on again.
Interact with your diagram
When you view the diagram in the editor, you can interact with your diagram in three ways:
- Click on the checkbox in the the Layers dialog.
- If the layer you toggle is locked, click directly on the shape in the same way as if you are interacting with the diagram in the viewer.
- If the layer is unlocked, the custom link is shown in a tooltip with the label
Action when you select the shape. Click on this link to display or hide your layers and shapes.
Open this interactive gitflow in the diagrams.net viewer