Description
Figure objects are reusable diagram artifacts that turn live model data into a visual view. A figure stores its root objects, render mode, layout choices, styling, and manual overrides while continuing to read names, relationships, values, and hierarchy from the underlying model. Figures are useful when a diagram needs to be edited once and reused in multiple documents or presentations. Because a figure references model objects rather than copying them, changes to the model are reflected the next time the figure renders or refreshes.Figure objects store presentation choices, not a duplicate of the model. Editing a node’s position or appearance changes the figure; editing the represented object’s name or properties changes the model object itself.
Creating a Figure
- Create a Figure object from the model index, normally inside a package.
- Open the new figure in its Figure view.
- Add one or more root objects from the Roots menu, or drag model objects from the index onto the figure canvas.
- Select a Render Mode appropriate for the objects you added.
- Use Settings to configure layout, labels, relationships, theme, styling, and the legend.
Root Objects
Roots are the starting points used to generate the diagram. A figure can have multiple roots, allowing related areas of the model to appear in one artifact. Roots can be managed in two ways:- Open Roots and use Add Root to search for model objects.
- Drag objects from the model index directly onto the figure canvas.
Adding a root does not move, copy, or re-parent that object. It only adds the object’s ID to the figure’s scope.
Render Modes
The same roots can be displayed in different ways by changing Render Mode.
Changing modes preserves the figure’s roots and reusable styling. Mode-specific layout settings change to match the selected visualization.
Configuring the Figure
Layout
Layout settings vary by render mode and can include:- Horizontal or vertical orientation
- Traversal depth
- Relationship types
- Activity endpoint and layout style
- State transition visibility
- Gantt scale and date range
- Risk criticality thresholds
Labels and Connections
Figures can display full names, short names, or both. Connection labels can be shown or hidden, and connection routing can use direct, orthogonal, or spline lines.Themes and Styles
Use a built-in theme for a consistent appearance, or switch to custom styling. Custom settings include the figure canvas, default node and edge colors, line weight, label color, font size, node width, padding, and corner radius.Style Rules
Style rules apply reusable formatting to matching content. Rules can target object types, selected nodes, connection types, a tree subtree, or a state scene. They continue to apply as matching objects are added to the model. Property-based color rules can visualize supported live values such as risk measures, requirement satisfaction, and task status.Legend
Enable the legend when colors or line styles carry meaning. A legend can:- List custom entries with node or edge swatches
- Show relationship categories derived from the rendered diagram
- Be moved, resized, and styled like other figure content
Editing the Canvas
Select nodes or connections to edit their figure-specific presentation. Depending on the render mode, you can:- Drag one or more nodes to create manual positions
- Resize nodes
- Adjust connection routing and label placement
- Show documentation, type, or selected attributes inside a node
- Expand tree children or relationship groups
- Hide an object from this figure
- Restore previously removed objects from Settings
The automatic layout remains responsible for content without manual overrides. Use manual positions and sizes only where the automatic result needs adjustment.
Reusing Figures
Figure objects can be embedded in Documents and Slides.Documents
- Place the caret at the desired insertion point.
- Open Insert and choose Figure.
- Search for and select the Figure object.
- Select Insert.
Slides
- Open the slide where the figure should appear.
- Open Insert and choose Figure.
- Search for and select the Figure object.
- Select Insert, then position and resize the new element.
Figure Objects Versus Direct Object Figures
The Figure insertion wizard also accepts ordinary model objects:- Selecting a Figure object embeds the reusable figure. Its roots, render mode, layout, and styles belong to that Figure object.
- Selecting another model object creates a direct figure reference. The host Document or Slide stores a local display mode such as Block, Tree, Gantt, or Risk Matrix.
Refreshing Embedded Figures
Rendered figures are cached for performance. If an embedded figure does not yet show a recent model or styling change, select it and choose Refresh. Refreshing clears the cached render and rebuilds the diagram from current model data.View Types
Properties Fields
boolean
No. Figures do not currently support object inheritance.
string
Name of the Figure object.
string
Short name used to identify the Figure object.
string
Description of the figure’s purpose or intended audience.
array
Model object IDs used as the starting scope for diagram generation.
object
The selected render mode and its mode-specific layout options.
object
Theme, labels, connection routing, canvas style, and default node and edge styles.
array
Reusable rules that style matching nodes or connections.
object
Manual node positions, sizes, content choices, styles, and connection routing.
array
Objects intentionally excluded from this figure. Removed objects can be restored from Figure settings.
object
Legend visibility, relationship categories, and custom legend entries.