composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-26 03:58:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

Doc update

Browse Source
This commit is contained in:
Eric Espie
2021-09-28 17:35:33 +02:00
parent c02f3202d9
commit 6e9c6eeb23
86 changed files with 6314 additions and 18756 deletions
Download Patch File Download Diff File Expand all files Collapse all files

794
.doc/UI/build/html/generated/Component/DataTable/DataTable.html
View File

@@ -1,19 +1,21 @@
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>DataTable &mdash; iTop UI 3.0.0 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<title>DataTable &mdash; iTop UI 3.0.0 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/ui-doc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
@@ -26,7 +28,8 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../index.html" class="icon icon-home"> iTop UI<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
<a href="../../../index.html" class="icon icon-home"> iTop UI
<img src="../../../_static/itop-logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -36,13 +39,13 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Twig Base:</span></p>
<p class="caption" role="heading"><span class="caption-text">Twig Base:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBase/TwigBase.html">Twig Base Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseTuto/TwigBaseTuto.html">Twig Base Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../TwigBaseReference/TwigBaseReference.html">Twig Base Reference</a></li>
</ul>
<p class="caption"><span class="caption-text">Tags reference:</span></p>
<p class="caption" role="heading"><span class="caption-text">Tags reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../Component.html">UI Components</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../Alert/Alert.html">Alert</a></li>
@@ -107,547 +110,492 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="datatable">
<span id="id1"></span><h1>DataTable<a class="headerlink" href="#datatable" title="Permalink to this headline"></a></h1>
<section id="datatable">
<span id="id1"></span><h1>DataTable<a class="headerlink" href="#datatable" title="Permalink to this headline"></a></h1>
<p>Class DataTable</p>
<hr class="docutils" />
<div class="section" id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<section id="output">
<h2>Output<a class="headerlink" href="#output" title="Permalink to this headline"></a></h2>
<p>Dynamic DataTable</p>
<img alt="../../../_images/Datatable.png" src="../../../_images/Datatable.png" />
<p>Static DataTable</p>
<img alt="../../../_images/DatatableStatic.png" src="../../../_images/DatatableStatic.png" />
</div>
</section>
<hr class="docutils" />
<div class="section" id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Tag:</th><td class="field-body"><strong>UIDataTable</strong></td>
</tr>
<tr class="field-even field"><th class="field-name">Syntax:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<section id="twig-tag">
<h2>Twig Tag<a class="headerlink" href="#twig-tag" title="Permalink to this headline"></a></h2>
<dl class="field-list simple">
<dt class="field-odd">Tag</dt>
<dd class="field-odd"><p><strong>UIDataTable</strong></p>
</dd>
<dt class="field-even">Syntax</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">T</span><span class="nv">ype</span> <span class="o">{</span><span class="p">P</span><span class="nv">arameters</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="66%" />
<col width="34%" />
<col style="width: 66%" />
<col style="width: 34%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#datatableforresult"><span class="std std-ref">ForResult</span></a></td>
<td>&#64;param WebPage $oPage</td>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#datatableforresult"><span class="std std-ref">ForResult</span></a></p></td>
<td><p>&#64;param WebPage $oPage</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#datatableforobject"><span class="std std-ref">ForObject</span></a></td>
<td>&#64;param WebPage $oPage</td>
<tr class="row-even"><td><p><a class="reference internal" href="#datatableforobject"><span class="std std-ref">ForObject</span></a></p></td>
<td><p>&#64;param WebPage $oPage</p></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#datatableforrendering"><span class="std std-ref">ForRendering</span></a></td>
<td>Make a basis Panel component</td>
<tr class="row-odd"><td><p><a class="reference internal" href="#datatableforrendering"><span class="std std-ref">ForRendering</span></a></p></td>
<td><p>Make a basis Panel component</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#datatableforrenderingobject"><span class="std std-ref">ForRenderingObject</span></a></td>
<td>&#64;param string $sListId</td>
<tr class="row-even"><td><p><a class="reference internal" href="#datatableforrenderingobject"><span class="std std-ref">ForRenderingObject</span></a></p></td>
<td><p>&#64;param string $sListId</p></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#datatableforstaticdata"><span class="std std-ref">ForStaticData</span></a></td>
<td>&#64;param string $sTitle</td>
<tr class="row-odd"><td><p><a class="reference internal" href="#datatableforstaticdata"><span class="std std-ref">ForStaticData</span></a></p></td>
<td><p>&#64;param string $sTitle</p></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#datatableforform"><span class="std std-ref">ForForm</span></a></td>
<td>&#64;param string $sRef</td>
</tr>
</tbody>
</table>
<div class="section" id="datatable-forresult">
<span id="datatableforresult"></span><h3>DataTable ForResult<a class="headerlink" href="#datatable-forresult" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p><a class="reference internal" href="#datatableforform"><span class="std std-ref">ForForm</span></a></p></td>
<td><p>&#64;param string $sRef</p></td>
</tr>
</tbody>
</table>
<section id="datatable-forresult">
<span id="datatableforresult"></span><h3>DataTable ForResult<a class="headerlink" href="#datatable-forresult" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orResult</span> <span class="o">{</span><span class="nv">oPage</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">sListId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">oSet</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:</span><span class="nv">value</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="28%" />
<col width="26%" />
<col width="22%" />
<col width="20%" />
<col width="4%" />
<col style="width: 28%" />
<col style="width: 26%" />
<col style="width: 22%" />
<col style="width: 20%" />
<col style="width: 4%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>oPage</td>
<td>WebPage</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>oPage</p></td>
<td><p>WebPage</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sListId</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>sListId</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>oSet</td>
<td>DBObjectSet</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>oSet</p></td>
<td><p>DBObjectSet</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>aExtraParams</td>
<td>&#160;</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="datatable-forobject">
<span id="datatableforobject"></span><h3>DataTable ForObject<a class="headerlink" href="#datatable-forobject" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p>aExtraParams</p></td>
<td></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="datatable-forobject">
<span id="datatableforobject"></span><h3>DataTable ForObject<a class="headerlink" href="#datatable-forobject" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orObject</span> <span class="o">{</span><span class="nv">oPage</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">sListId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">oSet</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:</span><span class="nv">value</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="28%" />
<col width="26%" />
<col width="22%" />
<col width="20%" />
<col width="4%" />
<col style="width: 28%" />
<col style="width: 26%" />
<col style="width: 22%" />
<col style="width: 20%" />
<col style="width: 4%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>oPage</td>
<td>WebPage</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>oPage</p></td>
<td><p>WebPage</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sListId</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>sListId</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>oSet</td>
<td>DBObjectSet</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>oSet</p></td>
<td><p>DBObjectSet</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>aExtraParams</td>
<td>&#160;</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="datatable-forrendering">
<span id="datatableforrendering"></span><h3>DataTable ForRendering<a class="headerlink" href="#datatable-forrendering" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-even"><td><p>aExtraParams</p></td>
<td></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="datatable-forrendering">
<span id="datatableforrendering"></span><h3>DataTable ForRendering<a class="headerlink" href="#datatable-forrendering" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orRendering</span> <span class="o">{</span><span class="nv">sListId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">oSet</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:</span><span class="nv">value</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="28%" />
<col width="26%" />
<col width="22%" />
<col width="20%" />
<col width="4%" />
<col style="width: 28%" />
<col style="width: 26%" />
<col style="width: 22%" />
<col style="width: 20%" />
<col style="width: 4%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sListId</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sListId</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>oSet</td>
<td>DBObjectSet</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>oSet</p></td>
<td><p>DBObjectSet</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>aExtraParams</td>
<td>&#160;</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="datatable-forrenderingobject">
<span id="datatableforrenderingobject"></span><h3>DataTable ForRenderingObject<a class="headerlink" href="#datatable-forrenderingobject" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p>aExtraParams</p></td>
<td></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="datatable-forrenderingobject">
<span id="datatableforrenderingobject"></span><h3>DataTable ForRenderingObject<a class="headerlink" href="#datatable-forrenderingobject" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orRenderingObject</span> <span class="o">{</span><span class="nv">sListId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">oSet</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:</span><span class="nv">value</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="28%" />
<col width="26%" />
<col width="22%" />
<col width="20%" />
<col width="4%" />
<col style="width: 28%" />
<col style="width: 26%" />
<col style="width: 22%" />
<col style="width: 20%" />
<col style="width: 4%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sListId</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sListId</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>oSet</td>
<td>DBObjectSet</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>oSet</p></td>
<td><p>DBObjectSet</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>aExtraParams</td>
<td>&#160;</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="datatable-forstaticdata">
<span id="datatableforstaticdata"></span><h3>DataTable ForStaticData<a class="headerlink" href="#datatable-forstaticdata" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p>aExtraParams</p></td>
<td></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="datatable-forstaticdata">
<span id="datatableforstaticdata"></span><h3>DataTable ForStaticData<a class="headerlink" href="#datatable-forstaticdata" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orStaticData</span> <span class="o">{</span><span class="nv">sTitle</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">aColumns</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">aData</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">sId</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">aExtraParams</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">sFilter</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">aOptions</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">}}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col width="31%" />
<col width="18%" />
<col width="24%" />
<col width="22%" />
<col width="4%" />
<col style="width: 31%" />
<col style="width: 18%" />
<col style="width: 24%" />
<col style="width: 22%" />
<col style="width: 4%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sTitle</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>sTitle</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>aColumns</td>
<td>array</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>aColumns</p></td>
<td><p>array</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>aData</td>
<td>array</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>aData</p></td>
<td><p>array</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>sId</td>
<td>string</td>
<td>optional</td>
<td>NULL</td>
<td>&#160;</td>
<tr class="row-even"><td><p>sId</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>NULL</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>aExtraParams</td>
<td>array</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>aExtraParams</p></td>
<td><p>array</p></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
<tr class="row-even"><td>sFilter</td>
<td>string</td>
<td>optional</td>
<td>‘’</td>
<td>&#160;</td>
<tr class="row-even"><td><p>sFilter</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>‘’</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>aOptions</td>
<td>array</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="datatable-forform">
<span id="datatableforform"></span><h3>DataTable ForForm<a class="headerlink" href="#datatable-forform" title="Permalink to this headline"></a></h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">syntax:</th><td class="field-body"></td>
<tr class="row-odd"><td><p>aOptions</p></td>
<td><p>array</p></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
</tbody>
</table>
</section>
<section id="datatable-forform">
<span id="datatableforform"></span><h3>DataTable ForForm<a class="headerlink" href="#datatable-forform" title="Permalink to this headline"></a></h3>
<dl class="field-list simple">
<dt class="field-odd">syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-twig notranslate"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">UIDataTable</span> <span class="p">F</span><span class="nv">orForm</span> <span class="o">{</span><span class="nv">sRef</span><span class="s1">:&#39;value&#39;</span><span class="o">,</span> <span class="nv">aColumns</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">aData</span><span class="o">:{</span><span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">,</span> <span class="nv">name</span><span class="o">:</span><span class="nv">value</span><span class="o">},</span> <span class="nv">sFilter</span><span class="s1">:&#39;value&#39;</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Content Goes Here</span>
<span class="cp">{%</span> <span class="k">EndUIDataTable</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">parameters:</th><td class="field-body"></td>
<dl class="field-list simple">
<dt class="field-odd">parameters</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 24%" />
<col style="width: 20%" />
<col style="width: 27%" />
<col style="width: 24%" />
<col style="width: 5%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>sRef</p></td>
<td><p>string</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td><p>aColumns</p></td>
<td><p>array</p></td>
<td><p>mandatory</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td><p>aData</p></td>
<td><p>array</p></td>
<td><p>optional</p></td>
<td><p>array ()</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>sFilter</p></td>
<td><p>string</p></td>
<td><p>optional</p></td>
<td><p>‘’</p></td>
<td></td>
</tr>
</tbody>
</table>
<table border="1" class="docutils">
</section>
<section id="datatable-common-parameters">
<h3>DataTable common parameters<a class="headerlink" href="#datatable-common-parameters" title="Permalink to this headline"></a></h3>
<table class="docutils align-default">
<colgroup>
<col width="24%" />
<col width="20%" />
<col width="27%" />
<col width="24%" />
<col width="5%" />
<col style="width: 29%" />
<col style="width: 10%" />
<col style="width: 61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>sRef</td>
<td>string</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tbody>
<tr class="row-odd"><td><p>AddCSSClass</p></td>
<td><p>string</p></td>
<td><p>CSS class to add to the generated html block</p></td>
</tr>
<tr class="row-even"><td>aColumns</td>
<td>array</td>
<td>mandatory</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddCSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[‘ibo-is-hidden’, ‘ibo-alert–body’]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>aData</td>
<td>array</td>
<td>optional</td>
<td>array ()</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddCssFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>sFilter</td>
<td>string</td>
<td>optional</td>
<td>‘’</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddDeferredBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="datatable-common-parameters">
<h3>DataTable common parameters<a class="headerlink" href="#datatable-common-parameters" title="Permalink to this headline"></a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="29%" />
<col width="10%" />
<col width="61%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>AddCSSClass</td>
<td>string</td>
<td>CSS class to add to the generated html block</td>
<tr class="row-odd"><td><p>AddHtml</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddCSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[‘ibo-is-hidden’, ‘ibo-alert–body’]&lt;/code&gt;</td>
<tr class="row-even"><td><p>AddJsFileRelPath</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddCssFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddMultipleCssFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddDeferredBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AddMultipleJsFilesRelPaths</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddHtml</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AddSubBlock</p></td>
<td><p>iUIBlock</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddJsFileRelPath</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-even"><td><p>AjaxData</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AddMultipleCssFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>AjaxUrl</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-even"><td>AddMultipleJsFilesRelPaths</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>CSSClasses</p></td>
<td><p>array</p></td>
<td><p>like &lt;code&gt;[‘ibo-is-hidden’, ‘ibo-alert–body’]&lt;/code&gt;</p></td>
</tr>
<tr class="row-odd"><td>AddSubBlock</td>
<td>iUIBlock</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DataAttributes</p></td>
<td><p>array</p></td>
<td><p>Array of data attributes in the format [‘name’ =&gt; ‘value’]</p></td>
</tr>
<tr class="row-even"><td>AjaxData</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>DeferredBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>AjaxUrl</td>
<td>string</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>DisplayColumns</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>CSSClasses</td>
<td>array</td>
<td>like &lt;code&gt;[‘ibo-is-hidden’, ‘ibo-alert–body’]&lt;/code&gt;</td>
<tr class="row-even"><td><p>InitDisplayData</p></td>
<td><p>array</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>DataAttributes</td>
<td>array</td>
<td>Array of data attributes in the format [‘name’ =&gt; ‘value’]</td>
<tr class="row-odd"><td><p>IsHidden</p></td>
<td><p>bool</p></td>
<td><p>Indicates if the block is hidden by default</p></td>
</tr>
<tr class="row-even"><td>DeferredBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>JSRefresh</p></td>
<td><p>string</p></td>
<td></td>
</tr>
<tr class="row-odd"><td>DisplayColumns</td>
<td>&#160;</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>Options</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-even"><td>InitDisplayData</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-even"><td><p>ResultColumns</p></td>
<td></td>
<td></td>
</tr>
<tr class="row-odd"><td>IsHidden</td>
<td>bool</td>
<td>Indicates if the block is hidden by default</td>
</tr>
<tr class="row-even"><td>JSRefresh</td>
<td>string</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>Options</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>ResultColumns</td>
<td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-odd"><td>SubBlocks</td>
<td>array</td>
<td>&#160;</td>
<tr class="row-odd"><td><p>SubBlocks</p></td>
<td><p>array</p></td>
<td></td>
</tr>
</tbody>
</table>
<hr class="docutils" />
<p>The columns (<em>aColumns</em>) have the following format:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">[</span>
<span class="x"> &#39;nameField1&#39; =&gt; [&#39;label&#39; =&gt; labelField1, &#39;description&#39; =&gt; descriptionField1],</span>
<span class="x"> ...</span>
<span class="x">]</span>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
<span class="s1">&#39;nameField1&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="s1">&#39;label&#39;</span> <span class="o">=&gt;</span> <span class="nx">labelField1</span><span class="p">,</span> <span class="s1">&#39;description&#39;</span> <span class="o">=&gt;</span> <span class="nx">descriptionField1</span><span class="p">],</span>
<span class="o">...</span>
<span class="p">]</span>
</pre></div>
</div>
<p>The data (<em>aData</em>) format has to be:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">[</span>
<span class="x"> [&#39;nameField1&#39; =&gt; valueField1, &#39;nameField2&#39; =&gt; valueField2, ...],</span>
<span class="x"> ...</span>
<span class="x">]</span>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="p">[</span>
<span class="p">[</span><span class="s1">&#39;nameField1&#39;</span> <span class="o">=&gt;</span> <span class="nx">valueField1</span><span class="p">,</span> <span class="s1">&#39;nameField2&#39;</span> <span class="o">=&gt;</span> <span class="nx">valueField2</span><span class="p">,</span> <span class="o">...</span><span class="p">],</span>
<span class="o">...</span>
<span class="p">]</span>
</pre></div>
</div>
</div>
</div>
</section>
</section>
<hr class="docutils" />
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>No examples provided yet</p>
</div>
</div>
</section>
</section>
</div>