Skip to content
🤷

Forgive us! These docs are a work in progress. Some pages may be incomplete or describe features that aren't quite finished yet. Farkitect is in early development and we don't recommend using it for real work just yet. Feel free to explore — just be aware that things are still being built.

How to configure notation

Notation defines how an element type appears on diagrams and in the Explorer. Configure it on the M2 element type.

  1. Select the M2 element type in the Explorer
  2. In the Properties panel, find the Notation section
  3. Configure:
FieldOptions
Shaperectangle, rounded, note, boundary, text
ColourHex colour value or colour picker
IconSVG markup (paste from Lucide or other sources)
Default widthInitial width in pixels (e.g., 160)
Default heightInitial height in pixels (e.g., 80)
StereotypeType label text (usually auto-derived from the element type name)

Compartments are sections within the diagram node. Add them in the Compartments section of the notation:

  • Content type: name
  • Style: typically fontWeight: bold
  • Content type: properties
  • Shows M1 property values inside the node
  • Content type: subordinates
  • Subordinate type ID: references the subordinate type definition
  • Label: heading text (e.g., “Attributes”)
  • Show label: whether to display the heading

Enable Auto-size compartment to make the node automatically resize based on its content (owned elements, property values). This is especially useful for entity-style nodes with variable numbers of attributes.

For relationship types, configure:

FieldOptions
Line stylesolid, dashed, dotted
Source markernone, arrow, hollowArrow
Target markernone, arrow, hollowArrow
ColourHex colour value
Source-to-target verbForward direction label
Target-to-source verbReverse direction label
Show multiplicitiesDisplay source/target multiplicity labels
Show role namesDisplay role name labels
  • Use a consistent colour palette across your metamodel so types are visually scannable
  • Keep icons at 24x24 viewBox for consistency with built-in metamodels
  • Test notation by creating M1 instances and viewing them on a diagram — adjust sizes and compartments as needed