iTop/.doc/UI/source/generated/Component/DataTable/DataTable.rst

.. Copyright (C) 2010-2021 Combodo SARL
.. http://opensource.org/licenses/AGPL-3.0

DataTable
=========

Class DataTable

----

.. include:: /manual/Component/DataTable/DataTableAdditionalDescription.rst

----

Twig Tag
--------

:Tag: **UIDataTable**

:Syntax:
 
::

    {% UIDataTable Type {Parameters} %}
        Content Goes Here
    {% EndUIDataTable %}

:Type:

+--------------------+------------------------------+
| ForResult          | @param \WebPage $oPage       |
+--------------------+------------------------------+
| ForObject          | @param \WebPage $oPage       |
+--------------------+------------------------------+
| ForRendering       | Make a basis Panel component |
+--------------------+------------------------------+
| ForRenderingObject | @param string $sListId       |
+--------------------+------------------------------+
| ForStaticData      | No comment                   |
+--------------------+------------------------------+
| ForForm            | @param string $sRef          |
+--------------------+------------------------------+

:DataTable *ForResult* parameters:

+--------------+-------------+-----------+----------+--+
| oPage        | WebPage     | mandatory |          |  |
+--------------+-------------+-----------+----------+--+
| sListId      | string      | mandatory |          |  |
+--------------+-------------+-----------+----------+--+
| oSet         | DBObjectSet | mandatory |          |  |
+--------------+-------------+-----------+----------+--+
| aExtraParams |             | optional  | array () |  |
+--------------+-------------+-----------+----------+--+

:DataTable *ForObject* parameters:

+--------------+-------------+-----------+----------+--+
| oPage        | WebPage     | mandatory |          |  |
+--------------+-------------+-----------+----------+--+
| sListId      | string      | mandatory |          |  |
+--------------+-------------+-----------+----------+--+
| oSet         | DBObjectSet | mandatory |          |  |
+--------------+-------------+-----------+----------+--+
| aExtraParams |             | optional  | array () |  |
+--------------+-------------+-----------+----------+--+

:DataTable *ForRendering* parameters:

+--------------+-------------+-----------+----------+--+
| sListId      | string      | mandatory |          |  |
+--------------+-------------+-----------+----------+--+
| oSet         | DBObjectSet | mandatory |          |  |
+--------------+-------------+-----------+----------+--+
| aExtraParams |             | optional  | array () |  |
+--------------+-------------+-----------+----------+--+

:DataTable *ForRenderingObject* parameters:

+--------------+-------------+-----------+----------+--+
| sListId      | string      | mandatory |          |  |
+--------------+-------------+-----------+----------+--+
| oSet         | DBObjectSet | mandatory |          |  |
+--------------+-------------+-----------+----------+--+
| aExtraParams |             | optional  | array () |  |
+--------------+-------------+-----------+----------+--+

:DataTable *ForStaticData* parameters:

+--------------+--------+-----------+----------+--+
| sTitle       | string | mandatory |          |  |
+--------------+--------+-----------+----------+--+
| aColumns     | array  | mandatory |          |  |
+--------------+--------+-----------+----------+--+
| aData        | array  | mandatory |          |  |
+--------------+--------+-----------+----------+--+
| sId          | string | optional  | NULL     |  |
+--------------+--------+-----------+----------+--+
| aExtraParams | array  | optional  | array () |  |
+--------------+--------+-----------+----------+--+
| sFilter      | string | optional  | ''       |  |
+--------------+--------+-----------+----------+--+
| aOptions     | array  | optional  | array () |  |
+--------------+--------+-----------+----------+--+

:DataTable *ForForm* parameters:

+----------+--------+-----------+----------+--+
| sRef     | string | mandatory |          |  |
+----------+--------+-----------+----------+--+
| aColumns | array  | mandatory |          |  |
+----------+--------+-----------+----------+--+
| aData    | array  | optional  | array () |  |
+----------+--------+-----------+----------+--+
| sFilter  | string | optional  | ''       |  |
+----------+--------+-----------+----------+--+

:DataTable common parameters:

+-------------------+----------+--------------------------------------------------------+
| AddCSSClass       | string   |                                                        |
+-------------------+----------+--------------------------------------------------------+
| AddCSSClasses     | array    | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+--------------------------------------------------------+
| AddCssFileRelPath | string   |                                                        |
+-------------------+----------+--------------------------------------------------------+
| AddDeferredBlock  | iUIBlock |                                                        |
+-------------------+----------+--------------------------------------------------------+
| AddHtml           | string   |                                                        |
+-------------------+----------+--------------------------------------------------------+
| AddJsFileRelPath  | string   |                                                        |
+-------------------+----------+--------------------------------------------------------+
| AddSubBlock       | iUIBlock |                                                        |
+-------------------+----------+--------------------------------------------------------+
| AjaxData          | array    |                                                        |
+-------------------+----------+--------------------------------------------------------+
| AjaxUrl           | string   |                                                        |
+-------------------+----------+--------------------------------------------------------+
| CSSClasses        | array    | like <code>['ibo-is-hidden', 'ibo-alert--body']</code> |
+-------------------+----------+--------------------------------------------------------+
| DataAttributes    | array    |                                                        |
+-------------------+----------+--------------------------------------------------------+
| DeferredBlocks    | array    |                                                        |
+-------------------+----------+--------------------------------------------------------+
| DisplayColumns    |          |                                                        |
+-------------------+----------+--------------------------------------------------------+
| IsHidden          | bool     |                                                        |
+-------------------+----------+--------------------------------------------------------+
| JSRefresh         | string   |                                                        |
+-------------------+----------+--------------------------------------------------------+
| Options           |          |                                                        |
+-------------------+----------+--------------------------------------------------------+
| ResultColumns     |          |                                                        |
+-------------------+----------+--------------------------------------------------------+
| SubBlocks         | array    |                                                        |
+-------------------+----------+--------------------------------------------------------+

----

.. include:: /manual/Component/DataTable/DataTableFooter.rst