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.

Notation System Reference

ShapeDescriptionTypical Use
rectangleStandard box, square cornersMost element types
roundedBox with rounded cornersActive elements, processes
noteBox with folded cornerNote annotations
boundaryDashed-border region, no fillVisual grouping
textNo border or backgroundLabels, headings
FieldTypeDescription
type"element"Always “element” for element types
iconString (SVG)SVG markup for the type icon
colorString (hex)Default fill colour
shapeStringNode shape (see above)
stereotypeStringLabel text for stereotype display
defaultWidthNumberInitial width in pixels
defaultHeightNumberInitial height in pixels
defaultBorderWidthNumberBorder width in pixels
textHAlign"left" / "center" / "right"Horizontal text alignment
textVAlign"top" / "middle" / "bottom"Vertical text alignment
autoSizeCompartmentBooleanAuto-resize based on content
compartmentsArrayCompartment definitions (see below)
subordinateTypesArrayOwned element type definitions (see below)
FieldTypeDescription
type"relationship"Always “relationship”
iconString (SVG)Icon for palette and explorer
lineStyle"solid" / "dashed" / "dotted"Edge line style
sourceMarker"none" / "arrow" / "hollowArrow"Marker at source end
targetMarker"none" / "arrow" / "hollowArrow"Marker at target end
colorString (hex)Default edge colour
s2tVerbStringSource-to-target verb (e.g., “serves”)
t2sVerbStringTarget-to-source verb (e.g., “is served by”)
showMultiplicitiesBooleanDisplay multiplicity labels
showRoleNamesBooleanDisplay role name labels

Compartments define sections within a diagram node.

FieldTypeDescription
contentType"name" / "properties" / "subordinates"What to display
idStringUnique compartment identifier
labelStringHeading text (for subordinate compartments)
showLabelBooleanWhether to display the heading
subordinateTypeIdStringReferences a subordinate type (when contentType = “subordinates”)
styleObjectCSS-like style overrides (fontWeight, etc.)

Define owned element types that render inside compartments.

FieldTypeDescription
idStringUnique identifier referenced by compartments
labelStringDisplay label
classifierString$id of the owned element type
displayTemplateStringTemplate for rendering (e.g., {name} : {Data Type})

Stereotypes display the M2 type name on diagram nodes (e.g., <<Application Component>>). Visibility is toggled per-diagram via the toolbar.

  • M2 notation colour — the default fill colour for all instances of a type
  • M1 diagram override — per-element, per-diagram colour override
  • Revert — removes the override, restoring the M2 default
  • Colours are specified as hex strings (e.g., #81D4FA)