.. _py-flow/Printer:

**********************************************************
flow/Printer
**********************************************************
.. default-domain:: py

.. py:currentmodule:: mod
.. cpp:namespace:: mod


Class ``FlowPrinter``
--------------------------------------------------------------------------------------------------------------------------------

.. py:class:: FlowPrinter

    An object of this class holds information on how derivation graphs with flow are visualised.

    .. py:attribute:: dgPrinter

        (Read-only) Retrieve the :class:`DGPrinter` used when printing solutions.

        :type: DGPrinter
    .. py:attribute:: withFlowLabels

        Control whether or not a flow label is appended to each hyperedge label (see also :meth:`DGPrinter.pushEdgeLabel`).

        :type: bool
    .. py:method:: pushInOutEdgeLabel(f)

        Add another function for in-/out-edge labelling.
        The result of this function is appended to each label using the edge label separator
        of the underlying :class:`DGPrinter`.
        The last argument given to the function is ``True`` for the in-edge, and ``False`` for the out-edge.

        :param f: the function to push for labelling in-/out-edges.
        :type f: Callable[[Graph, DG, bool], str] or str
    .. py:method:: popInOutEdgeLabel()

        Remove the last pushed in/out edge labelling function.
    .. py:attribute:: printUnfiltered

        Control whether or not the unfiltered version of a solution is printed.

        :type: bool
    .. py:attribute:: printFiltered

        Control whether or not the filtered version of a solution is printed.

        :type: bool
    .. py:attribute:: unfilteredFlowColour

        When printing the unfiltered version, use this colour on vertices and edges with non-zero flow.
        Use an empty string to not colour them.

        :type: str