Annotate a View

The Annotate tool lets you draw directly on the canvas. You can add text comments and questions to a view, and highlight graph elements with colored arrows, circles, node callouts, and process diagrams.

02 12 00 AnnotateIntro

Annotations are saved with the view and can be shared with a colleague as a live view or static .png image.

By default, Annotate opens as an expanded floating toolbar.

02 12 01 AnnotateFloatingPanel
You can click the minus (-) icon at the top right to collapse the floating toolbar when it is not in use.
02 12 02 AnnotatePanelCollapsed

Set Up an Annotation Workspace

It can be more convenient to dock the Annotate toolbar to the left, right, or bottom edge of the canvas. When docked to the right or left edge, Annotate becomes a panel you can easily display and dismiss. The docking position is retained until you change it, for example, by re-floating the panel.

Optionally, you can save your preferred docked position in a named workspace that can include other specific panel positions.

To position Annotate in a workspace:

  1. In the Display toolbar section, click Annotate.

  2. In the Annotate pane, click the dock icon at the top right, and choose a Dock To position (e.g Right Panel)

    02 12 03 AnnotateDockMenu

    When docked to the right or left, an Annotate icon is added to the right rail of the browser window.

    02 12 04 AnnotateDockedRight
  3. Click the Workspace icon above the legend, and select Save Workspace As…​.

  4. Enter a workspace name, and click OK.

    Now, if you happen to re-float Annotate, selecting the named workspace re-docks it (along with any other workspace choices).

Add Annotations to a View

The Annotate pane toggles between two modes, controlled by the pencil icon at the top:

  • In navigating mode, you can navigate and select graph elements on the canvas.

  • In editing mode, you can draw annotations on the canvas.

Annotation toolkit icons are displayed at the top of the pane, along with their keyboard shortcuts and usage tips.

02 12 05 AnnotateToolkit

Annotation tools include:

  • Select (V), to select one or more annotations, and set the Display scale for the selection. In the Add section that appears, you can click to add a default Mermaid flowchart or to Clear All annotations.

  • Shape (R), to create and style rectangle, rounded, pill, ellipse, or diamond shapes that can include text.

  • Ellipse (O), to draw and style ellipses to encircle elements on the canvas.

  • Board (B), to draw and style a text box where you can place and group other annotations, for example to explain a process relating to the graph on the canvas.

  • Arrow (A), to draw and style a Straight, Elbow, or Curved arrow.

  • Text (A), to add and style text (with no surrounding shape outline).

  • Node Callout (C), to select a node and attach a callout text box to it.

  • Cluster Outline (G), to draw a circle around a part of the graph.

    The cluster outline cannot be moved once it is placed.
  • Title, to enter and style a title text box, which will be centered at the top of the canvas under the split view menu.

  • Undo and Redo icons, to undo or redo creation, editing, and styling actions.

In editing mode, keyboard shortcuts are available to select an annotation tool.

Styling options include:

  • Color of text, outlines and fills

  • Outline Style (Solid, Dashed, or Dotted)

  • Fill Opacity

  • Text type (Sans serif, Serif, or Monospace) and text size.

  • Text alignment within a shape or board

  • Save this style, to save the current style in the Annotate pane. Select and annotation and click a saved style to apply it. A saved style persists until you delete it.

To add an annotation:

  1. In the Display toolbar section, click the Annotate tool.

    The Annotate pane opens in editing mode.

  2. Click the pencil icon to enter navigating mode,and highlight the part of the graph you want to annotate. For example, pan and/or zoom, lay out the graph, and/or select nodes or edges using any selection method.

  3. Now click the pencil icon to toggle to editing mode.

  4. Click to select an annotation option.

  5. Optionally, select styling options and save the style (otherwise, the current style settings are applied).

  6. Click and drag to place the annotation on the canvas.

    02 12 06 AddShape
  7. For a text, shape, board, node callout, or title annotation, enter text and then click outside the annotation when you are done.

    02 12 07 AddText
  8. Optionally, duplicate, arrange, or delete annotations as needed:

    • Click Duplicate to duplicate one or more selected annotations.

    • For overlapping annotations, select one or more and click Bring to front or Send to back.

    • Arrange selected annotations using alignment and spacing options.

      02 12 08 AnnotateDuplicateAlign
      A Title is in a fixed position, centered under the canvas project/view menu.
    • Click Delete annotation (or press delete or return) to delete one or more selected annotations.

  9. Deselect all annotations to optionally:

    • Click the Display Scale controls to increase or decrease overall scaling, changing line thickness and all type sizes by a percentage.

    • Click Clear All to remove all annotations.

      02 12 09 AnnotateDisplayScale
      Click Undo or Redo icons to undo/redo changes in text, styling and positioning, and to undo/redo a deletion.
  10. In the View dropdown menu, click Save or Save As to save annotations with the view.

Style Annotations

Styling is applied whenever you create an annotation. You can change the styling for one or more selected annotations at any time, for example to set a consistent color, type style or size, fill and line style, and/or overall display scale.

To style selected annotations:

  1. In the Annotation panel, click the Select (V) icon

  2. On the canvas, click to select an annotation.

  3. Either shift-click to select additional annotations, or shift-click and drag a box over the other annotations.

  4. In the Annotation panel, change styling options:

    • Color: Click a colored dot. The color is changed, and is used for any new annotations.

    • Text Size: Use the - or + controls to increase or decrease text size.

    • Type Style: Select Sans serif, Serif, or Monospace.

    • Text Alignment: Click an alignment option to position text within a shape.

    • Click a saved style rectangle to apply it to all selected annotations.

      02 12 10 AnnotateStyleEdit
      To increase or decrease overall display scaling for all annotations, deselect annotations and click the Display Scale controls.

Edit Annotations on the Canvas

To edit annotations on the canvas, you can:

  • Move a selected annotation. Click and drag (except Title and Cluster annotations, which cannot be moved).

  • Edit text: Double click a selected text, shape, node callout, or title annotation.

  • Re-size a selected shape or ellipse: Click and drag the white dot on the shape.

  • Arrange selected annotations: In the Annotate pane, click one or more of the alignment options.

Show or Hide Annotations

It can be convenient to see or export the view on the canvas without its annotations.

To toggle between showing and hiding all annotations:

  • In the Annotate pane, click to deselect Show annotations.

    02 12 11 AnnotateShowHide

Export an Annotated View

Annotations are included in the saved view. The view on the canvas, whether saved or not, can also be exported as a .png screenshot or SVG file.

Any view can also be exported from the canvas Export menu as a .graphxr file.

To export an annotated view:

  1. In the Annotate pane and Export section, select or deselect the Include Legend checkbox.

  2. Optionally, click Zoom to annotations in the View section to align annotations and the title on the canvas.

    02 12 12 AnnotateExportPNG
  3. Click either:

    • PNG, to download a .png screenshot to your system.

    • Copy, to copy the annotated .png view to the clipboard.

    • SVG, to download an SVG file to your system.