:py:mod:`raesl.plot.generic`
============================

.. py:module:: raesl.plot.generic

.. autoapi-nested-parse::

   RaESL GraphViz diagram plotting module.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   raesl.plot.generic.DiagramStyle
   raesl.plot.generic.Style




.. py:class:: DiagramStyle(digraph: Optional[Dict[str, Any]] = None, orientation: Optional[str] = None, node_shapes: Optional[Dict[str, str]] = None, edge_styles: Optional[Dict[str, str]] = None, show_hierarchy: Optional[bool] = None, list_variables: Optional[bool] = None, show_root_children: Optional[bool] = None, show_neighbor_children: Optional[bool] = None, show_function_dependencies: Optional[bool] = None)


   Bases: :py:obj:`ragraph.generic.Mapping`

   RaESL Graphviz diagram style mapping.

   .. py:attribute:: _defaults

      

   .. py:method:: digraph() -> Dict[str, Any]

      Options for the :obj:`graphviz.Digraph` object.


   .. py:method:: orientation() -> str

      Orientation of the layout of the graph. One of 'LR' (left-to-right) or
      'TD' (top-down).


   .. py:method:: node_shapes() -> Dict[str, str]

      Dictionary of node kinds to Graphviz node shapes.


   .. py:method:: edge_styles() -> Dict[str, str]

      Dictionary of edge kind to Graphviz edge styles.


   .. py:method:: show_hierarchy() -> bool

      Whether to draw the nested hierarchical structure.


   .. py:method:: list_variables() -> bool

      Whether to list the variables of goal- and transformation specifications.


   .. py:method:: show_root_children() -> bool

      Whether to display the children of the root component within a functional
      context diagram.


   .. py:method:: show_neighbor_children() -> bool

      Whether to display the children of the neighbor components within a
      functional context diagram.


   .. py:method:: show_function_dependencies() -> bool

      Whether to display dependencies between functions within a traceability
      diagram.



.. py:class:: Style(diagram: Optional[Union[DiagramStyle, Dict[str, Any]]] = None, ragraph: Optional[Union[ragraph.plot.generic.Style, Dict[str, Any]]] = None)


   Bases: :py:obj:`ragraph.generic.Mapping`

   RaESL plotting style mapping.

   .. py:attribute:: _defaults

      

   .. py:method:: diagram() -> DiagramStyle

      Graphviz diagram style.


   .. py:method:: ragraph() -> ragraph.plot.generic.Style

      RaGraph style options, used for Multi-Domain matrices.