Skip to content
Farkitect
🤷

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 create an element type

Create the element type

Section titled “Create the element type”
  1. In the Explorer, expand your M2 metamodel package
  2. Right-click on an element type layer package (e.g., “Business Layer”)
  3. Select New Element Type
  4. Rename it (e.g., “Application”) and press Enter

Configure notation

Section titled “Configure notation”

With the new element type selected, set its visual appearance in the Properties panel:

  • Shape — rectangle, rounded, note, boundary, or text
  • Colour — the default fill colour (hex value or colour picker)
  • Icon — paste SVG markup (e.g., from Lucide icons)
  • Default width/height — initial size when placed on a diagram

Add to the palette

Section titled “Add to the palette”

Element types automatically appear in the Palette once created inside an elementTypes package. No additional configuration is needed — the Palette picks up all element types from imported M2 metamodels.

Add properties

Section titled “Add properties”

See How to define properties and enumerations.

Tips

Section titled “Tips”
  • Give each element type a distinct colour and icon so types are visually distinguishable on diagrams
  • Use layer packages to organise related types (e.g., “People & Teams”, “Technology”, “Financial”)
  • Set isAbstract: true if the type should only be used as a superclass and not instantiated directly