.. _menu_layout_field_reference:

Menu Layout Field Reference
---------------------------




.. tabularcolumns:: |p{3cm}|p{3.5cm}|p{7.5cm}|

+--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Title                    | Field Name              | Description                                                                                                                                                   |
+==========================+=========================+===============================================================================================================================================================+
| Name \*                  | name                    | The name that is given to the Menu Layout.                                                                                                                    |
+--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Description              | description             | A description of the Menu Layout.                                                                                                                             |
+--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Menu Items               | menu\_items             | The list of menu items and -sub items that belong to the Menu Layout.                                                                                         |
+--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+

Menu Items

.. tabularcolumns:: |p{3cm}|p{3.5cm}|p{7.5cm}|

+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Title                  | Field Name              | Description                                                                                                                                                                |
+========================+=========================+============================================================================================================================================================================+
| Title                  | title                   | The menu item title as it will show on the menu.                                                                                                                           |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Type                   | type                    | The chosen model type from the **Type** drop-down list to associate with the Title.                                                                                        |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Href                   | href                    | If a direct reference to a model type is used for the menu item, the specified path.                                                                                       |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Field Display Policy   | field\_display\_policy  | The chosen **Field Display Policy** that is associated with the Menu Item.                                                                                                 |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Configuration Template | configuration\_template | The chosen **Configuration Template** that is associated with the Menu Item.                                                                                               |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Display As             | display                 | Choose the display format of the model types of the menu item. The format can be a **Form** for a single instance, or a **Tree** or **List** for more than one instance.   |
|                        |                         | Default = List.                                                                                                                                                            |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Menu Items             | menu\_items             | The list of nested menu items that belong to the Menu Layout.                                                                                                              |
+------------------------+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


Configurable Filters

Fixed Filters cannot be removed.

.. tabularcolumns:: |p{3cm}|p{3.5cm}|p{7.5cm}|

+----------------------+--------------------+-------------------------------------------------------------------+
| Title                | Field Name         | Description                                                       |
+======================+====================+===================================================================+
| Configurable Filters | filter_options.[n] | For **List** option only.                                         |
+----------------------+--------------------+-------------------------------------------------------------------+
| Filter By            | filter_by          | Attributes of the **Type** can be chosen from the drop-down list. |
+----------------------+--------------------+-------------------------------------------------------------------+
| Filter Type          | filter_type        | Choose the matching operator for the filter.                      |
+----------------------+--------------------+-------------------------------------------------------------------+
| Filter String        | filter_string      | Choose the value that the matching operator should match by.      |
+----------------------+--------------------+-------------------------------------------------------------------+