.. _interface:

Data Import Tool Interface
==========================

The interface consists of five main components (see Figure 1):

* :ref:`main_view` (with tabs for the :ref:`data_frame_view`, :ref:`raw_data_view`, and :ref:`python_code_view`)
* :ref:`command_history_pane`
* :ref:`command_editor_pane`
* :ref:`configuration_pane`
* :ref:`log_view_pane`

.. figure:: /images/user_guide/interface.png
   :align: center
   :figwidth: image

   Figure 1. The main interface

.. _main_view:

Main View
----------

This has three tabs, which are used to view and manipulate the data, see the raw
data being imported, and view the generated Python code representing the
manipulations.

.. _data_frame_view:

DataFrame View
^^^^^^^^^^^^^^

Cells can be edited by double-clicking on them, with each cell's editor
corresponding to its column type. For example, a date/time column uses a time
and calendar editor widget. To set a cell to a null value, right click the
cell and click "Set Null". Many transformations can be accessed by right-
clicking on a column or row. The rest can be accessed through the Transforms
menu.

For more details about the available commands, see :ref:`commands`.

.. figure:: /images/user_guide/data-frame-view.png
   :align: center
   :figwidth: image

   Figure 2. DataFrame View with column context (right-click) menu

.. _raw_data_view:

Raw Data View
^^^^^^^^^^^^^

This view provides a read-only view into the data file being imported.

.. note::
   The lines are numbered starting at ``1`` while the table index starts at
   ``0`` by default. For files larger than ``~1MB`` in size, while the
   DataFrame view will display all of the file contents, the raw data view
   will truncate and display only the first ``~1MB`` of data.

.. figure:: /images/user_guide/raw-data-view.png
   :align: center
   :figwidth: image

   Figure 3. Raw Data View

.. _python_code_view:

Python Code View
^^^^^^^^^^^^^^^^

As you issue commands and manipulate your data, the tool records these actions
in the form of Python / Pandas code that can be exported for reuse later,
potentially on other datasets. This view is read-only.

.. figure:: /images/user_guide/python-code-view.png
   :align: center
   :figwidth: image

   Figure 4. Python Code View

.. _command_history_pane:

Command History
---------------

This pane lists the manipulations you've performed. Use the command's checkbox
to enable or disable the command or click the "X" to remove it. Click the
command to select it for editing in the :ref:`command_editor_pane`.

.. note::
   The ``Date Import Tool`` creates and saves the list of operations performed
   on a file after the resultant ``DataFrame`` is successfully injected into
   the IPython console. Reloading the file will prompt the ``Tool`` to
   automatically load the previous set of operations. The user can disable the
   automatically loaded operations by disabling the commands or removing them.

.. _command_editor_pane:

Command Editor
--------------

The editor is used to modify the currently selected command. For example, after
inserting a new column, the user may want to change the expression used for the
column. After making any edits to the command, you must hit "Refresh Data" to
see the changes.

.. _configuration_pane:

Configuration Pane
------------------

Use this pane to change the resulting DataFrame name. This pane is hidden by
default but it can be toggled on/off through the tool's View Menu.

.. _log_view_pane:

Log View Pane
-------------

The log provides detailed messages regarding various actions the tool is taking
as you try out various commands, such as alerting you that a column's data type
was converted or if the tool detected a header line. This pane is hidden by
default but it can be toggled on/off through the tool's View menu, or using the
keyboard shortcut ``CTRL-L`` (``CMD-L`` on macOS).

.. |icon-info| image:: /images/user_guide/icon-information.png
   :width: 15pt
   :height: 15pt
.. |icon-warn| image:: /images/user_guide/icon-warning.png
   :width: 15pt
   :height: 15pt
.. |icon-debug| image:: /images/user_guide/icon-debug.png
   :width: 15pt
   :height: 15pt
.. |icon-error| image:: /images/user_guide/icon-error.png
   :width: 15pt
   :height: 15pt
.. |icon-crit| image:: /images/user_guide/icon-critical-error.png
   :width: 15pt
   :height: 15pt

+--------------+------------------+
| Icon         | Message Type     |
+==============+==================+
| |icon-info|  | Info             |
+--------------+------------------+
| |icon-warn|  | Warning          |
+--------------+------------------+
| |icon-debug| | Debug            |
+--------------+------------------+
| |icon-error| | Error            |
+--------------+------------------+
| |icon-crit|  | Critical Error   |
+--------------+------------------+