Configuration Structure Reference
Configuration
public struct Configuration : CodableConfiguration options to influence the generation and visual representation of the class diagram
-
init(files:elements: hideShowCommands: skinparamCommands: includeRemoteURL: theme: relationships: stereotypes: relationshipExclude: texts: ) memberwise initializer
Declaration
Swift
public init(files: FileOptions = FileOptions(), elements: ElementOptions = ElementOptions(), hideShowCommands: [String]? = ["hide empty members"], skinparamCommands: [String]? = ["skinparam shadowing false"], includeRemoteURL: String? = nil, theme: Theme? = nil, relationships: RelationshipOptions = RelationshipOptions(), stereotypes: Stereotypes = Stereotypes.default, relationshipExclude _: [String]? = nil, texts: PageTexts? = nil) -
Declaration
Swift
public init(from decoder: Decoder) throws -
default configuration used if no configuration file was found
Declaration
Swift
public static let `default`: Configuration -
options which files shall be considered for class diagram generation
Declaration
Swift
public var files: FileOptions -
options which and how elements shall be considered for class diagram generation
Declaration
Swift
public var elements: ElementOptions -
parameterize the display of entities using the hide/show command.https://plantuml.com/class-diagram#6a8ec84e53ede3ae
Declaration
Swift
public private(set) var hideShowCommands: [String]? { get } -
add skinparam values to change colors and font of the drawing. See https://plantuml.com/skinparam for more details
Declaration
Swift
public private(set) var skinparamCommands: [String]? { get } -
wil be added to PlantUMLScript as
!includedirective to include a file (from Internet/Intranet) in your diagramDeclaration
Swift
public private(set) var includeRemoteURL: String? { get } -
wil be added to PlantUMLScript as
!themedirective to include a theme (built-in, local or from Internet/Intranet) in your diagramDeclaration
Swift
public private(set) var theme: Theme? { get } -
options which relationships to show and how to style them
Declaration
Swift
public var relationships: RelationshipOptions -
sterotypes (spotted character with background color and optional name) to be shown for an entity type
Declaration
Swift
public private(set) var stereotypes: Stereotypes { get } -
Declaration
Swift
public var texts: PageTexts?