PlantUML Extension Schemas¶
These TypedDict schemas describe values accepted by the Python
plantuml={...} constructor kwarg and the equivalent
extensions={"plantuml": {...}} envelope.
c4.contrib.plantuml.extensions.RelationshipExtensions ¶
Bases: TypedDict
PlantUML-specific extension data for relationships.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sprite
|
Optional sprite to represent the relationship. |
required | |
tags
|
Optional tags for styling or grouping. |
required | |
link
|
URL link associated with the relationship. |
required | |
index
|
Index associated with the relationship. |
required |
c4.contrib.plantuml.extensions.ElementExtensions ¶
Bases: TypedDict
PlantUML-specific extension data for diagram elements.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sprite
|
Optional sprite to represent the element. |
required | |
tags
|
Optional tags for styling or grouping. |
required | |
link
|
URL link associated with the element. |
required | |
type
|
Optional custom type or stereotype label. |
required | |
base_shape
|
Optional shape override for rendering. |
required |
c4.contrib.plantuml.extensions.PersonExtensions ¶
Bases: TypedDict
PlantUML-specific extension data for people.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sprite
|
Optional sprite to represent the person. |
required | |
tags
|
Optional tags for styling or grouping. |
required | |
link
|
URL link associated with the person. |
required | |
type
|
Optional custom type or stereotype label. |
required |
c4.contrib.plantuml.extensions.SystemExtensions ¶
Bases: TypedDict
PlantUML-specific extension data for software systems.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sprite
|
Optional sprite to represent the system. |
required | |
tags
|
Optional tags for styling or grouping. |
required | |
link
|
URL link associated with the system. |
required | |
type
|
Optional custom type or stereotype label. |
required | |
base_shape
|
Optional shape override for rendering. |
required |
c4.contrib.plantuml.extensions.SystemStorageExtensions ¶
Bases: TypedDict
PlantUML-specific extension data for database-like or queue-like systems.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sprite
|
Optional sprite to represent the system. |
required | |
tags
|
Optional tags for styling or grouping. |
required | |
link
|
URL link associated with the system. |
required | |
type
|
Optional custom type or stereotype label. |
required |
c4.contrib.plantuml.extensions.BoundaryExtensions ¶
Bases: TypedDict
PlantUML-specific extension data for boundary elements.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tags
|
Optional tags for styling or grouping. |
required | |
link
|
URL link associated with the boundary. |
required | |
type
|
Optional custom type or stereotype label. |
required |
c4.contrib.plantuml.extensions.NodeExtensions ¶
Bases: TypedDict
PlantUML-specific extension data for deployment nodes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sprite
|
Optional sprite to represent the node. |
required | |
tags
|
Optional tags for styling or grouping. |
required | |
link
|
URL link associated with the node. |
required | |
type
|
Optional custom type or stereotype label. |
required |
c4.contrib.plantuml.extensions.ContainerExtensions ¶
Bases: TypedDict
PlantUML-specific extension data for containers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sprite
|
Optional sprite to represent the container. |
required | |
tags
|
Optional tags for styling or grouping. |
required | |
link
|
URL link associated with the container. |
required | |
base_shape
|
Optional shape override for rendering. |
required |
c4.contrib.plantuml.extensions.ContainerStorageExtensions ¶
Bases: TypedDict
PlantUML-specific extension data for database-like or queue-like containers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sprite
|
Optional sprite to represent the container. |
required | |
tags
|
Optional tags for styling or grouping. |
required | |
link
|
URL link associated with the container. |
required |
c4.contrib.plantuml.extensions.ComponentExtensions ¶
Bases: TypedDict
PlantUML-specific extension data for components.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sprite
|
Optional sprite to represent the component. |
required | |
tags
|
Optional tags for styling or grouping. |
required | |
link
|
URL link associated with the component. |
required | |
base_shape
|
Optional shape override for rendering. |
required |
c4.contrib.plantuml.extensions.ComponentStorageExtensions ¶
Bases: TypedDict
PlantUML-specific extension data for database-like or queue-like components.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sprite
|
Optional sprite to represent the component. |
required | |
tags
|
Optional tags for styling or grouping. |
required | |
link
|
URL link associated with the component. |
required |