PlantUML Layouts¶

PlantUML layout helpers live in c4.contrib.plantuml and render as C4-PlantUML Lay_* macros.

c4.contrib.plantuml.Layout ¶

Represents a relative layout constraint between two elements.

__init__(
    from_element: Element, to_element: Element
) -> None

Parameters:

Name	Type	Description	Default
`from_element`	`Element`	The element to be positioned.	required
`to_element`	`Element`	The element to position relative to.	required

Raises:

Type	Description
`ValueError`	If `layout_type` is not provided and the subclass does not define a class-level `layout_type`.

Bases: Layout

Positions from_element below to_element using shorthand 'Lay_D' layout.

Bases: Layout

Positions from_element explicitly below to_element using 'Lay_Down' layout.

Bases: Layout

Positions from_element above to_element using shorthand 'Lay_U' layout.

Bases: Layout

Positions from_element explicitly above to_element using 'Lay_Up' layout.

Bases: Layout

Positions from_element to the right of to_element using shorthand 'Lay_R' layout.

Bases: Layout

Positions from_element explicitly to the right of to_element using 'Lay_Right' layout.

Bases: Layout

Positions from_element to the left of to_element using shorthand 'Lay_L' layout.

Bases: Layout

Positions from_element explicitly to the left of to_element using 'Lay_Left' layout.