.. _conf.schem.schem_data_maps:

=============================
Configure Schematic Data Maps
=============================

Schematic data maps are configurations used to conditionally colourise nodes or components within a schematic diagram. By assigning these data maps to specific schematic elements, you can visually represent the status of these elements in the schematics. For example, you can set a node to turn red if its tag value is below a certain threshold, indicating a potential issue, and green if the value is above the threshold, indicating normal operation.

Set Up Schematic Data Maps
**************************

To set up a schematic data map, follow the steps below:

1. Choose :menuselection:`Configuration --> Schematics --> Schematic Data Maps` from the menu.
2. On the **Schematic Data Map** pane, click |add| **Create Data Map** in the upper right corner of the pane.
3. Enter a name and a description and click **Save**.

   .. image:: images/conf.schem_data_maps.create.png

   .. admonition:: Result 
       
    A new entry gets added to the pane with the name and description of the data map. If you want to edit the name or description of this entry or delete it later, choose |edit| **Edit** or |delete| **Delete** next to the entry, respectively.

4. Click the |arrowdown| drop-down arrow at the right-hand side of the entry to expand its details.
5. To add the first condition, click |add| **Add Entry** and in the **Create Data Map Entry** dialog, enter values as follows:

   .. list-table:: 
      :widths: 1 5
      :header-rows: 1
      :class: tight-table

      * - Field
        - Description
      * - **Name**
        - Specify a name that uniquely identifies the data map entry.
      * - **Value**
        - Enter the hex value of the colour you want to use.
      * - **Description**
        - Specify the condition that triggers the colour change. 

6. Save your entry.
7. Add further data map entries for conditions as required.

   **Example**
     
   The example below shows two data map entries, which set the colour of valve nodes based on the value of their assigned tag. When a node’s tag value is less than 0.01, it will return a colour value of #E86263 (red). If its tag’s value is greater than 0.01, it will return a colour value of #6DC997 (green). 

   .. image:: images/conf.schem_data_maps.conditions.png


   .. admonition:: Result

    Changes to data maps are automatically saved and the colours are applied in the relevant schematics. You can update or delete existing entries using the |edit| **Edit** or |delete| **Delete** buttons next to the relevant entries. Once you have set up the schematic data maps, you can assign them to the schematic elements (see :ref:`conf.schem.schem_data_maps.assign`).

.. _conf.schem.schem_data_maps.assign:

Assign Schematic Data Maps to Schematic Elements
************************************************

Once you have set up schematic data maps, you can assign them to specific schematic elements in the **Schematic Editor** (see :ref:`conf.schem.setup`). Various types of schematic elements allow you to assign a data map in their configuration options. To assign a data map to an element, follow these steps:

1. In the **Schematic Editor**, click on the element you want to configure.
2. In the configuration dialog that appears, locate the **Data Map** field.
3. Select the appropriate data map from the dropdown menu.

See an example of data map assignment for a valve below:

.. image:: images/conf.schem_data_maps.assign.png


.. seealso::

   - :ref:`conf.schem.schematics`   
   - :ref:`schematics`


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

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

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

.. |arrowdown| image:: images/icon.arrow.down.png