Help & Documentation

Learn how to use StructureGram

Diagram Annotations

Annotations let you add presentation notes directly onto an ownership diagram. They are useful for callouts, review comments, emphasis, draft restructure notes, or visual grouping that should not become part of the underlying entity and relationship data.

Annotations belong to the diagram view. They do not create entities, relationships, assets, ownership interests, or filter group assignments.

When to Use Annotations

Use annotations when you want to explain or highlight something on the canvas without changing the structure itself.

Good uses include:

  • Drawing attention to a proposed change.
  • Adding a short note for a meeting or review.
  • Marking an area of the structure that needs checking.
  • Highlighting a group of related entities.
  • Adding a line or arrow to explain a diagram that is being exported.

Do not use annotations as a substitute for real data. If the information describes an actual ownership, control, trustee, beneficiary, loan, lease, or asset relationship, create or update the relationship instead.

Turning Annotations On

Annotations are hidden until you turn them on for the diagram view.

  1. Open an ownership diagram.
  2. Open Diagram Settings from the toolbar.
  3. Go to the Display tab.
  4. Turn on Annotations.

When annotations are on, the diagram toolbar shows an annotation split button. The main button uses the currently selected annotation type. The dropdown lets you choose a different annotation type or delete all annotations.

Turning the display setting off hides the annotation controls and hides existing annotations from the canvas. It does not delete them.

Annotation Types

Line

Use a line when you want to point from one area of the diagram to another, draw a callout, or add an arrow.

To create a line:

  1. Turn on Annotations in Diagram Settings.
  2. Open the annotation dropdown in the toolbar.
  3. Choose Line.
  4. Drag on a blank part of the canvas from the start point to the end point.

Very small accidental drags are ignored. After a line is created, annotation mode turns off automatically.

You can style a line by right-clicking it. The line menu lets you change:

  • Label text.
  • Colour.
  • Thickness.
  • Line style, such as solid, dashed, or dotted.
  • Path style, such as sharp, rounded, or curved.
  • Source and target arrows.
  • Label font size.

Line annotations also work with link tools. Hover over a line to show basic handles. When Link Tools are on, you can also adjust bend points on annotation lines.

Rectangle

Use a rectangle to frame or highlight a group of entities, an area of concern, or a part of the structure being discussed.

To create a rectangle:

  1. Choose Rectangle from the annotation dropdown.
  2. Drag on a blank part of the canvas to draw the rectangle.
  3. Hold Shift while dragging if you want a square.

Very small shapes are ignored. After the rectangle is created, annotation mode turns off automatically.

Right-click a rectangle to change:

  • Stroke colour.
  • Stroke width.
  • Stroke style.
  • Fill colour.
  • Fill opacity.
  • Layer order, using Send to back or Bring to front.
  • Delete.

Ellipse

Use an ellipse to circle an entity, group, risk area, or item requiring attention.

To create an ellipse:

  1. Choose Ellipse from the annotation dropdown.
  2. Drag on a blank part of the canvas to draw the ellipse.
  3. Hold Shift while dragging if you want a circle.

The right-click options are the same as rectangle annotations: stroke, fill, opacity, layer order, and delete.

Text

Use text for comments, headings, review notes, or short explanations.

To create text:

  1. Choose Text from the annotation dropdown.
  2. Click on a blank part of the canvas.
  3. Type your note.

Text annotations open ready for editing when they are created. You can edit text again by clicking the text annotation and then clicking it again, or by double-clicking it.

Right-click a text annotation to change:

  • Font colour.
  • Font size.
  • Alignment.
  • Background colour.
  • Background opacity.
  • Layer order.
  • Delete.

Moving, Resizing, and Editing

Annotations can be moved and adjusted on the canvas.

  • Drag annotation lines or their handles to reposition them.
  • Use link tools on annotation lines when you need bend points.
  • Hover over rectangles and ellipses to show resize and rotate controls.
  • Click or double-click text to edit the wording.
  • Right-click any annotation for style and delete options.
  • Press Escape to cancel drawing before the annotation is created.
  • Use Delete or Backspace to remove a selected annotation when you are not typing in a text field.

Changes are saved automatically. Position changes are batched briefly while you drag, then saved in the background.

Deleting Annotations

You can delete one annotation or all annotations on a diagram.

To delete one annotation:

  1. Right-click the annotation.
  2. Choose Delete annotation.

You can also use the delete handle shown on hover, or press Delete or Backspace when the annotation is selected.

To delete all annotations:

  1. Open the annotation dropdown in the toolbar.
  2. Choose Delete all.
  3. Confirm the deletion.

Deleting annotations is permanent and cannot be undone.

How Annotations Affect Auto-Layout

Annotations are placed at fixed positions on the canvas. They are not attached to entities in the same way relationship links are.

Because of that, existing annotations can block implicit auto-layout updates. This is deliberate. If StructureGram automatically moved entities after you had placed annotations, the notes, shapes, and arrows could end up pointing at the wrong part of the diagram.

When annotations exist:

  • The toolbar may show Auto-layout blocked.
  • Some setting changes that would normally relayout the diagram may preserve the current geometry instead.
  • If you explicitly refresh or restore auto-layout, StructureGram warns that annotations will stay in place and may no longer align.
  • The layout action can still be run, but you should check and reposition annotations afterwards.

Turning the annotation display toggle off hides annotations, but it does not delete them. If you want the diagram to return to normal implicit auto-layout behavior, delete the annotations that are blocking layout updates.

Scenarios

Annotations are scoped to the diagram view you are editing.

On a base diagram, annotations belong to the base diagram. In a scenario, annotations belong to the scenario step. This lets you add scenario-specific notes without changing the base diagram's annotations.

Use this for scenario review notes such as:

  • "Step 1: transfer shares."
  • "Check tax impact here."
  • "Proposed new holding structure."
  • "Relationship removed in this scenario."

Exporting Diagrams With Annotations

Annotations are part of the visual diagram. When visible, they are included in diagram exports.

Placeholder annotation text is suppressed during export so unfinished labels do not appear in the final image. Before exporting, review the diagram at the intended zoom level and check that annotations still point to the correct entities and links.

Practical Tips

  • Add annotations after the diagram layout is mostly settled.
  • Use shapes for emphasis and text for explanation.
  • Keep notes short so exported diagrams stay readable.
  • Use arrows only where direction matters.
  • Use Send to back for large highlight shapes so they do not cover entity cards.
  • If you refresh the base layout, check every annotation afterwards.

FAQ

Why did the toolbar say auto-layout is blocked?

The diagram has annotations. StructureGram avoids moving entities automatically because fixed-position annotations may no longer line up after a relayout.

Can I still run auto-layout?

Yes. Use the layout action intentionally. StructureGram warns you that existing annotations will remain in place and may need to be moved afterwards.

Are annotations saved?

Yes. Annotations are saved to the diagram as you create, edit, move, and delete them.

Do annotations change the underlying data?

No. They are visual notes only. They do not create entities, relationships, ownership interests, or assets.

Why did my annotation disappear when I turned annotations off?

The annotation was hidden, not deleted. Turn Annotations back on in Diagram Settings to show it again.

Why is my new entity not appearing on the diagram?

That is controlled by the diagram's entity filter, not annotations. Open the Entity Filter badge and add the entity to the diagram if it should be included.