.. _screen.grid.functions:

==============
Grid Functions
==============

Screens that show multiple pieces of data use grids. Grids can be single-level or multi-level. Hierarchical grids display additional information related to the main row.

Common Grid Functions
*********************

The availability of grid functions differ for each screen, however, there are some functions that are common to most and are available via specific icons on the screen area:

.. list-table:: 
    :widths: 1 3 10
    :header-rows: 1
    :class: tight-table

    * - Icon
      - Function
      - Description
    * - |add|
      - Add
      - Allows you to create a new item. This function is usually available from the top toolbar.
    * - |edit|
      - Edit
      - You can make changes to an existing item. This function is either available from the top toolbar, or it appears as an icon for specific rows of the grid. If you use this function from the top toolbar, you must first select the relevant item in the grid.
    * - |delete|
      - Delete
      - Deletes the item from the database. This function is either available from the top toolbar, or it appears as an icon for specific rows of the grid. If you use this function from the top toolbar, you must first select the relevant item in the grid.
    * - |columns|
      - Columns
      - Click to select the columns that you want to be visible in the grid.
    * - |columnfreeze|
      - Column Freeze
      - Click to select the columns that you want to keep in view while you scroll horizontally through the grid. 
    * - |reset|
      - Reset
      - Removes all the filters that have been applied in the grid.
    * - |refresh| 
      - Refresh Data
      - Updates all the data in the grid in case there have been changes since the screen was last opened.
    * - |export|
      - Export
      - Exports the visible content of the grid into a Microsoft Excel file.
    * - |filter|
      - Filter
      - Allows you to find and display only the rows in the grid that meet specific criteria. For more information, see :ref:`screen.grid.filter`.
    * - |removefilter|
      - Clear Filter
      - Removes the filter from the specific column.

Navigating in the Grid
**********************

You can easily change the number of records shown per page using the dropdown menu labeled **items per page** at the bottom of the grid.

To navigate between the pages in the grid, you can do the following:

- Click the required page number at the bottom of the grid.
- Use the Forward/Backward buttons to move to the next or previous pages.

.. image:: images/grid.navigation.png

.. |add| image:: images/icon.add.png

.. |edit| image:: images/icon.edit.png

.. |delete| image:: images/icon.delete.png

.. |reset| image:: images/icon.reset.png

.. |refresh| image:: images/icon.refresh.png

.. |columns| image:: images/icon.columns.png

.. |columnfreeze| image:: images/icon.column.freeze.png

.. |export| image:: images/icon.export.png

.. |filter| image:: images/icon.filter.png

.. |removefilter| image:: images/icon.filter.remove.png

.. toctree::
   :hidden:
   :maxdepth: 5

   screen.grid.filter