.. _config-field-options-label:

==============================
 Field options for widgets
==============================

Here's a complete list of all *Field options* that are specifically used by
*Widgets* :


filter
-------

* *String value*.  The filter to apply when querying on the field.  Defaults
  may differ depending on the widget used.  Here's the possible values :

  * %#%
  * #%
  * %#
  * #

* **Optional** for *Widgets* : 

  * :ref:`widget-mapfishrecenter-label`


selectType
-----------

* *String value*.  How to display the field in the *FeaturePanel_Selector*
  widget.  Possible values are :

  * key *(showing key only)*
  * value *(showing value only)*
  * keyValue *(showing key followed by value)*

* **Mandatory** for *Widgets* : 

  * :ref:`widget-featurepanel-selector-label`


type
-----

* *String value*.  Type of the field.  Possible values are :

  * string
  * float
  * integer

* **Mandatory** for *Widgets* : 

  * :ref:`widget-resultextgrid-label`.  If the widget has the 
    **useResponseFields** option set to **true**, then this field option isn't
    required (and would in fact be ignored if set).


width
------
 
* *Integer value*.  Width in pixel of field when drawn.
* **Mandatory** for *Widgets* : 

  * :ref:`widget-resultextgrid-label`.  If the widget has the 
    **useResponseFields** option set to **true**, then this field option isn't
    required (and would in fact be ignored if set).

* **Optional** for *Widgets* : 

  * :ref:`widget-applyfilter-label`


========================================
 Important notes about field options
========================================

.. note:: 

   Each field option must appear only once.