edgegraph.output.plantuml.PLANTUML_RENDER_OPTIONS

edgegraph.output.plantuml.PLANTUML_RENDER_OPTIONS#

edgegraph.output.plantuml.PLANTUML_RENDER_OPTIONS = {'skinparams': {'dpi': '300'}, <class 'edgegraph.structure.directededge.DirectedEdge'>: {'v1side': '', 'v2side': '>'}, <class 'edgegraph.structure.undirectededge.UnDirectedEdge'>: {'v1side': '', 'v2side': ''}, <class 'edgegraph.structure.vertex.Vertex'>: {'show_attrs': ['.+'], 'stereotype_skinparams': {'BackgroundColor': 'White', 'FontColor': 'Black', 'StereotypeFontColor': 'Black'}, 'title_format': '$id', 'type': 'object'}}#

Default options for PlantUML rendering.

Keys as follows:

  • "skinparams": dict, controls diagram-wide skinparams.

    • "dpi": str, controls DPI skinparam (dots per inch)

  • Vertex: (yes, the actual Vertex class): controls rendering for the Vertex class and any subclasses thereof

    • "type": str (default "object"), PlantUML class used

    • "stereotype_skinparams": dict, controls skinparams applied to relevant objects in the diagram

      • Any stereotype-specific skinparam can go here, and it’ll be applied automatically. For example:

      • "BackgroundColor": "White" causes the skinparam BackgroundColor<<Vertex>> White to be applied diagram-wide.

    • "show_attrs": list of str, representing regular expressions. if any match an instance attribute’s name, that attribute (name and value) are included on the diagram.

    • "title_format": str, format string used to create the object title. if set to "$id", will result in hex(id(obj)). all instance attributes are available to this format string.

  • DirectedEdge: (yes, the actual class): controls rendering for DirectedEdges and any subclasses thereof.

    • "v1side": str, controls the ending of the arrow at the v1 end of the link. default "".

    • "v2side": str, controls the ending of the arrow at the v2 end of the link. default ">".

  • UnDirectedEdge: (yes, the actual class): controls rendering for UnDirectedEdges and any subclasses thereof.

    • "v1side": str, controls the ending of the arrow at the v1 end of the link. default "".

    • "v2side": str, controls the ending of the arrow at the v2 end of the link. default "".