Skip to content

Relation Sidebar

Clicking on a relation in the graph will open the relation sidebar which provides all details of the relation.

Main

Basic information

alt text
  1. Name: View and change the name of the relation. You can enter a name or select it from the dropdown.
  2. Description: View and change the description of the relation. It is a simple text field.

Edit/View Mode

The relation sidebar supports two modes for viewing and editing relation information:

  • Edit Mode: Allows you to modify the relation's description and additional information using editable text fields
  • View Mode: Displays the relation's description and additional information in a read-only format with clickable term links

Switching Modes

  • Click the pencil icon (✏️) to switch to Edit Mode
  • Click the eye icon (👁️) to switch to View Mode

The mode setting is global and shared with the term sidebar - once you set it to Edit or View mode, it remains active as you navigate between different relations and terms. This allows you to quickly review your model without repeatedly switching modes.

View Mode Benefits

When in View Mode:

  • Clickable Term Links: Any term names mentioned in the description or additional information become clickable links
  • Quick Navigation: Click on a term name to instantly navigate to that term in the graph
  • Term Previews: Hover over term links to see a preview popup with the term's description
  • Better Readability: Content is displayed with proper formatting and word wrapping

Buttons

  • A Close: Click the X button to close the sidebar and deselect the relation
  • B Collapse/Resize: Click the chevron button to collapse the sidebar (relation stays selected). You can also resize the sidebar by dragging its edge.
  • More Actions Menu (⋮): Provides quick access to:
    • Copy to clipboard: Copies the relation's description to your clipboard

Tabs

Add Info

alt text

Here you can add additional information for your relation. You can elaborate on the description, add examples, explanations, etc.

  • Edit Mode: Provides a rich text editor with formatting options (bold, italic, lists, headings, etc.)
  • View Mode: Displays the formatted content with clickable term links for easy navigation between related terms

Details

alt text

In this tab, you can modify the term's category, alter its ID, and add or edit any custom fields you have defined

  • Type: The type of the relation based on the relation name. Click on the settings Icon to change the mapping. See relation type
  • Cardinality source: (Only visible when enabled 'Cardinalities of relations' in Document Settings). The cardinality from target to source (reverse relation). A dropdown field where you can select the cardinality
  • Cardinality target: (Only visible when enabled 'Cardinalities of relations' in Document Settings). The cardinality from source to target (normal relation). A dropdown field where you can select the cardinality
  • Change id: Clicking the icon allows you to modify the relation's identifier
  • Extra fields: This section enables you to manage custom fields for both terms and relations. You can add or remove fields and set their corresponding values. Fields are useful to store extra information, like categories or hyperlinks. They can also be used for filtering the graph.
  • Weight: Only visible if enabled in the Document Settings. Type or select a number representing the relation weight.

Terms

alt text

Displays the source and target term in this relation

Cardinalities

Enable cardinalities via the dropdown: Settings > DOCUMENT > Cardinality for relations

Imagine you have two terms, like "Person" and "Car," and a relation between them, like "owns." Cardinality tells you how many of each term can be involved in that "owns" relation. A cardinality can be set on the source (read this as the reverse relation) and on the target (the normal direction from left to right).

For example, Person -( 1 )--owns--( 0.._ )-> Car means that a Person can own zero, one, or more Cars (0.._), and a Car can be owned by one Person (1).

Cardinality types

  • 1: Exactly one
  • 1..*: One or more/Minimal 1
  • 0..1: Zero or one/Optionally one
  • 0..*: Zero or more/Optionally one or more