.. _`Figure (deprecated)`:

.. _`org.sysess.sympathy.visualize.figuretabletreegui`:

Figure (deprecated)
~~~~~~~~~~~~~~~~~~~

.. image:: figure.svg
   :width: 48


Create a Figure from some data using a GUI.

.. note::
    This node is being deprecated by
    :ref:`org.sysess.sympathy.visualize.figure`,
    please avoid using it for new flows.

Both of the nodes :ref:`org.sysess.sympathy.visualize.figuretabletreegui` and
:ref:`org.sysess.sympathy.visualize.figurestablestreegui` are used to configure
figures in a graphical user interface. They both output the figure(s) on the
upper port and a configuration table an optional lower port. The configuration
table can be used in the nodes
:ref:`org.sysess.sympathy.visualize.figurefromtablewithtable` and
:ref:`org.sysess.sympathy.visualize.figuresfromtableswithtable`.

The configuration gui for these nodes consists of a toolbar and a tree view.
The tree view has two columns: one for the configuration items and one for
their values.

You can add plots to the figure by clicking on its corresponding button in the
toolbar, or by pressing on a plot button and dragging it to where in the tree
view you want it (possible drop locations will be shown in green). The plot
will be added with some basic properties depending on which plot type you added
(e.g. *X Data* and *Y Data* for line plot). Almost all configuration items
support more than the default properties. To add more, right-click on a
configuration item and choose "Add..." or "Add property" depending on what you
want to add.

Properties that allow free text are interpreted as python code and executed. In
this python evironment the input data table is available under the name ``arg``
(``table`` can also be used for historical reasons). For example one can refer
to data columns in a connected Table by writing something like
``arg['My data column']``. Have a look at the :ref:`datatypeapis` to see all
the available methods and attributes for the data type that you connect to the
node.

Use the node :ref:`Export figures` to write any figures you produce to files.

*Input ports*:
    :input: <a>

        Input

*Output ports*:
    :figure: figure

        Output figure
    :config: table

        Configuration

*Configuration*:
    **GUI** (parameters)
        Configuration window

.. automodule:: node_old_figure

.. class:: FigureFromAnyWithTreeView


Example flows
#############

* :download:`Figures.syx </_examples/Sympathy/Visual/Figure/Figures.syx>`