UML family

Complete API surface of the Beep.Skia.UML assembly: 27 public types with their documented members. Follow the family guide for usage patterns.

Types in this assembly

ActivityNodeType enum
AssociationType enum
MessageType enum
UMLActionNode class
UMLActivationBar class
UMLActivityNode class
UMLActor class
UMLArtifactNode class
UMLAssociation class
UMLClass class
UMLCombinedFragment class
UMLComponentNode class
UMLConditionNode class
UMLControl class
UMLDataSourceNode class
UMLDeploymentNode class
UMLInheritance class
UMLInterface class
UMLLifeline class
UMLMessage class
UMLOutputNode class
UMLPackageNode class
UMLSystemBoundary class
UMLTransformNode class
UMLTriggerNode class
UMLUseCaseNode class
XmiExporter class

UMLActionNode (class)

UML representation of an action automation node. Displays as a rectangle with action-specific visual cues.

Member	Kind	Description
`string ActionType`	Property	Gets or sets the action type (API, Database, File, etc.).
`string ActionDescription`	Property	Gets or sets the action description.
`UMLActionNode()`	Method	Initializes a new instance of the UMLActionNode class.

UMLActivationBar (class)

UML sequence activation bar — a narrow vertical rectangle placed on a lifeline to represent the period during which an object is active.

Member	Kind	Description
`string Label`	Property	Gets or sets the label.
`UMLActivationBar()`	Method	Initializes a new instance of the UMLActivationBar class.
`override Dictionary<string, object> GetProperties(bool includeCommon = true, bool includeNodeProperties = true)`	Method
`override void SetPropperties(IDictionary<string, object> properties, bool updateNodeProperties = true, bool applyToPublicSetters = true)`	Method	Gets or sets the set propperties.

UMLActivityNode (class)

UML Activity Node — a rounded rectangle representing an action in an activity diagram.

Member	Kind	Description
`string ActionName`	Property	Gets or sets the action name.
`ActivityNodeType ActionType`	Property	Gets or sets the action type.
`UMLActivityNode()`	Method	Initializes a new instance of the UMLActivityNode class.
`override Dictionary<string, object> GetProperties(bool includeCommon = true, bool includeNodeProperties = true)`	Method
`override void SetPropperties(IDictionary<string, object> properties, bool updateNodeProperties = true, bool applyToPublicSetters = true)`	Method	Gets or sets the set propperties.

UMLActor (class)

Represents a UML actor in use case diagrams. Displays a stick figure representation with an actor name below.

Member	Kind	Description
`string ActorName`	Property	Gets or sets the name of the actor.
`UMLActor()`	Method	Initializes a new instance of the UMLActor class.

UMLArtifactNode (class)

UML Artifact node — a deployable file/artifact with a folded-corner icon and «artifact» stereotype.

Member	Kind	Description
`string ArtifactName`	Property	Gets or sets the artifact name.
`string FileName`	Property	Gets or sets the file name.
`UMLArtifactNode()`	Method	Initializes a new instance of the UMLArtifactNode class.
`override Dictionary<string, object> GetProperties(bool includeCommon = true, bool includeNodeProperties = true)`	Method
`override void SetPropperties(IDictionary<string, object> properties, bool updateNodeProperties = true, bool applyToPublicSetters = true)`	Method	Gets or sets the set propperties.

UMLAssociation (class)

Represents a UML association relationship between two UML elements. Can display multiplicity and role names.

Member	Kind	Description
`string SourceMultiplicity`	Property	Gets or sets the multiplicity at the source end.
`string TargetMultiplicity`	Property	Gets or sets the multiplicity at the target end.
`string SourceRole`	Property	Gets or sets the role name at the source end.
`string TargetRole`	Property	Gets or sets the role name at the target end.
`AssociationType AssociationType`	Property	Gets or sets the type of association.
`bool ShowDataFlow`	Property	Gets or sets whether to show animated data flow for this association. Useful for associations that represent data flow or communication relationships.
`string DataType`	Property	Gets or sets the data type for the association (used for data flow visualization).
`UMLAssociation() : base(()`	Method	Initializes a new instance of the UMLAssociation class.
`new void Draw(SKCanvas canvas)`	Method	Draws the association line with UML-specific decorations. The canvas to draw on.

UMLClass (class)

Represents a UML class in a class diagram. Displays class name, attributes, and operations in separate compartments.

Member	Kind	Description
`string ClassName`	Property	Gets or sets the name of the class.
`List<string> Attributes`	Property	Gets or sets the list of attributes for this class.
`string AttributesText`	Property	Gets or sets the attributes text.
`List<string> Operations`	Property	Gets or sets the list of operations for this class.
`string OperationsText`	Property	Gets or sets the operations text.
`bool IsAbstract`	Property	Gets or sets the is abstract.
`UMLClass()`	Method	Initializes a new instance of the UMLClass class.

UMLCombinedFragment (class)

UML combined fragment (sequence diagram) — a frame with an operator tab (alt, opt, loop, par, break, critical, neg, assert, ignore, consider) and an optional guard.

Member	Kind	Description
`static readonly string[] Operators =`	Field	Supported interaction operators.
`string Operator`	Property	Gets or sets the operator.
`string GuardCondition`	Property	Gets or sets the guard condition.
`UMLCombinedFragment()`	Method	Initializes a new instance of the UMLCombinedFragment class.
`override Dictionary<string, object> GetProperties(bool includeCommon = true, bool includeNodeProperties = true)`	Method
`override void SetPropperties(IDictionary<string, object> properties, bool updateNodeProperties = true, bool applyToPublicSetters = true)`	Method	Gets or sets the set propperties.

UMLComponentNode (class)

UML Component node — a modular part of a system with provided and required interfaces. Rendered as a rectangle with the component icon (two tabs) and a «component» stereotype.

Member	Kind	Description
`string ComponentName`	Property	Gets or sets the component name.
`string ProvidedInterfaces`	Property	Gets or sets the provided interfaces.
`string RequiredInterfaces`	Property	Gets or sets the required interfaces.
`UMLComponentNode()`	Method	Initializes a new instance of the UMLComponentNode class.
`override Dictionary<string, object> GetProperties(bool includeCommon = true, bool includeNodeProperties = true)`	Method
`override void SetPropperties(IDictionary<string, object> properties, bool updateNodeProperties = true, bool applyToPublicSetters = true)`	Method	Gets or sets the set propperties.

UMLConditionNode (class)

UML representation of a condition automation node. Displays as a diamond shape with condition-specific visual cues.

Member	Kind	Description
`string ConditionExpression`	Property	Gets or sets the condition expression.
`string ConditionType`	Property	Gets or sets the condition type (Boolean, Comparison, Complex).
`UMLConditionNode()`	Method	Initializes a new instance of the UMLConditionNode class.

UMLControl (class)

Base class for all UML diagram elements in the Beep.Skia.UML framework. Provides common functionality for UML-specific controls.

Member	Kind	Description
`string Stereotype`	Property	Gets or sets the stereotype of this UML element (e.g., "<<interface>>", "<<abstract>>").
`SKColor BackgroundColor`	Property	Gets or sets the background color of this UML element.
`SKColor BorderColor`	Property	Gets or sets the border color of this UML element.
`float BorderThickness`	Property	Gets or sets the border thickness.
`SKColor SelectionColor`	Property	Gets or sets the selection color.
`override List<IConnectionPoint> InConnectionPoints`	Property	UML input connection points (persisted).
`override List<IConnectionPoint> OutConnectionPoints`	Property	UML output connection points (same instances, UML treats ports as bidirectional visually).

UMLDataSourceNode (class)

UML representation of a data source automation node. Displays as a cylinder shape with data source-specific visual cues.

Member	Kind	Description
`UMLDataSourceNode()`	Method	Initializes a new instance of the UMLDataSourceNode class.

UMLDeploymentNode (class)

UML Deployment node — a physical or execution environment (device / execution environment). Rendered as a 3D box with the «node» stereotype.

Member	Kind	Description
`string NodeName`	Property	Gets or sets the node name.
`string NodeType`	Property	Gets or sets the node type.
`UMLDeploymentNode()`	Method	Initializes a new instance of the UMLDeploymentNode class.
`override Dictionary<string, object> GetProperties(bool includeCommon = true, bool includeNodeProperties = true)`	Method
`override void SetPropperties(IDictionary<string, object> properties, bool updateNodeProperties = true, bool applyToPublicSetters = true)`	Method	Gets or sets the set propperties.

UMLInheritance (class)

Represents a UML inheritance relationship between classes. Displays a solid line with a triangle arrowhead pointing to the parent class.

Member	Kind	Description
`UMLInheritance() : base(()`	Method	Initializes a new instance of the UMLInheritance class.
`new void Draw(SKCanvas canvas)`	Method	Draws the inheritance relationship with a triangle arrowhead. The canvas to draw on.

UMLInterface (class)

Represents a UML interface in a class diagram. Displays interface name and operations with interface notation.

Member	Kind	Description
`string InterfaceName`	Property	Gets or sets the name of the interface.
`List<string> Operations`	Property	Gets or sets the list of operations for this interface.
`string OperationsText`	Property	Gets or sets the operations text.
`UMLInterface()`	Method	Initializes a new instance of the UMLInterface class.

UMLLifeline (class)

Member	Kind	Description
`string ObjectName`	Property	Gets or sets the object name.
`string ClassName`	Property	Gets or sets the class name.
`float LifelineLength`	Property	Gets or sets the lifeline length.
`UMLLifeline()`	Method	Initializes a new instance of the UMLLifeline class.

UMLMessage (class)

Represents a UML message in sequence diagrams. Displays arrows between lifelines with different styles for different message types.

Member	Kind	Description
`string MessageText`	Property	Gets or sets the message text/label.
`MessageType MessageType`	Property	Gets or sets the type of message.
`string SequenceNumber`	Property	Gets or sets the sequence number (optional).
`bool ShowDataFlow`	Property	Gets or sets whether to show animated data flow for this message. Useful for visualizing data flow in sequence diagrams.
`string ReturnDataType`	Property	Gets or sets the return data type for the message (used for data flow visualization).
`UMLMessage() : base(()`	Method	Initializes a new instance of the UMLMessage class.
`new void Draw(SKCanvas canvas)`	Method	Draws the message arrow with appropriate styling. The canvas to draw on.

UMLOutputNode (class)

UML representation of an output automation node. Displays as a rounded rectangle with output-specific visual cues.

Member	Kind	Description
`UMLOutputNode()`	Method	Initializes a new instance of the UMLOutputNode class.

UMLPackageNode (class)

UML Package Node — a tabbed folder shape representing a namespace or module.

Member	Kind	Description
`string PackageName`	Property	Gets or sets the package name.
`UMLPackageNode()`	Method	Initializes a new instance of the UMLPackageNode class.
`override Dictionary<string, object> GetProperties(bool includeCommon = true, bool includeNodeProperties = true)`	Method
`override void SetPropperties(IDictionary<string, object> properties, bool updateNodeProperties = true, bool applyToPublicSetters = true)`	Method	Gets or sets the set propperties.

UMLSystemBoundary (class)

UML System Boundary — a rectangle that groups related use cases. Rendered with a dashed border and optional title at the top-left.

Member	Kind	Description
`string SystemName`	Property	Gets or sets the system name.
`UMLSystemBoundary()`	Method	Initializes a new instance of the UMLSystemBoundary class.
`override Dictionary<string, object> GetProperties(bool includeCommon = true, bool includeNodeProperties = true)`	Method
`override void SetPropperties(IDictionary<string, object> properties, bool updateNodeProperties = true, bool applyToPublicSetters = true)`	Method	Gets or sets the set propperties.

UMLTransformNode (class)

UML representation of a transform automation node. Displays as a hexagon shape with transform-specific visual cues.

Member	Kind	Description
`UMLTransformNode()`	Method	Initializes a new instance of the UMLTransformNode class.

UMLTriggerNode (class)

UML representation of a trigger automation node. Displays as a rounded rectangle with trigger-specific visual cues.

Member	Kind	Description
`string TriggerType`	Property	Gets or sets the trigger type (Event, Schedule, Manual, etc.).
`string TriggerCondition`	Property	Gets or sets the trigger condition or schedule.
`UMLTriggerNode()`	Method	Initializes a new instance of the UMLTriggerNode class.

UMLUseCaseNode (class)

UML Use Case node — an oval representing a user goal or system function.

Member	Kind	Description
`string UseCaseName`	Property	Gets or sets the use case name.
`UMLUseCaseNode()`	Method	Initializes a new instance of the UMLUseCaseNode class.
`override Dictionary<string, object> GetProperties(bool includeCommon = true, bool includeNodeProperties = true)`	Method
`override void SetPropperties(IDictionary<string, object> properties, bool updateNodeProperties = true, bool applyToPublicSetters = true)`	Method	Gets or sets the set propperties.

Exports a UML class-style diagram to XMI 2.5 (UML 2.5) for interchange with UML tools (Enterprise Architect, Papyrus, StarUML, Visual Paradigm, etc.). Maps classes, interfaces, actors, use cases, and packages, plus associations, inheritance (generalizations), and member text.

Member	Kind	Description
`string Export(IReadOnlyList<SkiaComponent> components, IReadOnlyList<IConnectionLine> lines, string modelName = "Model")`	Method	Exports components and lines to XMI.