dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #26418
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 874: Removed outdated section
------------------------------------------------------------
revno: 874
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Sun 2013-12-01 21:50:23 +0100
message:
Removed outdated section
modified:
src/docbkx/en/dhis2_user_man_web_api.xml
--
lp:~dhis2-documenters/dhis2/dhis2-docbook-docs
https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs
Your team DHIS 2 developers is subscribed to branch lp:~dhis2-documenters/dhis2/dhis2-docbook-docs.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs/+edit-subscription
=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml 2013-12-01 20:49:40 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml 2013-12-01 20:50:23 +0000
@@ -1917,190 +1917,6 @@
<para>To see a complete working example please visit <ulink url="http://apps.dhis2.org/portal/carousel.html"/>.</para>
</section>
<section>
- <title>Embedding report tables with the table plug-in</title>
- <para>In this example we will see how we can embed dynamic data tables in a Web page with data provided from a DHIS back-end server using the table plug-in. The table plug-in resides inside the same file as the chart plug-in so please refer to the section about the chart plug-in above on how to include the required JavaScript and CSS files and how to do authentication. The available table options are listed in the table below.</para>
- <table>
- <title>Table plug-in configuration</title>
- <tgroup cols="5">
- <thead>
- <row>
- <entry>
- <emphasis role="italic">Param</emphasis>
- </entry>
- <entry>
- <emphasis role="italic">Type</emphasis>
- </entry>
- <entry>
- <emphasis role="italic">Required</emphasis>
- </entry>
- <entry>
- <emphasis role="italic">Options (default first)</emphasis>
- </entry>
- <entry>
- <emphasis role="italic">Description</emphasis>
- </entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>indicators</entry>
- <entry>[string]</entry>
- <entry>Yes*</entry>
- <entry/>
- <entry>Identifiers of indicators to include in table</entry>
- </row>
- <row>
- <entry>dataelements</entry>
- <entry>[string]</entry>
- <entry>Yes*</entry>
- <entry/>
- <entry>Identifiers of data elements to include in table</entry>
- </row>
- <row>
- <entry>datasets</entry>
- <entry>[string]</entry>
- <entry>Yes*</entry>
- <entry/>
- <entry>Identifiers of data sets to include in table</entry>
- </row>
- <row>
- <entry>periods</entry>
- <entry>[string]</entry>
- <entry>No</entry>
- <entry>last12Months | lastMonth | lastQuarter | last4Quarters | lastSixMonth | last2SixMonths | thisYear | last5Years</entry>
- <entry>Names of relative periods to include in table</entry>
- </row>
- <row>
- <entry>orgunits</entry>
- <entry>[string]</entry>
- <entry>Yes</entry>
- <entry/>
- <entry>Identifiers of organisation units to include in table</entry>
- </row>
- <row>
- <entry>orgUnitIsParent</entry>
- <entry>boolean</entry>
- <entry>No</entry>
- <entry>false | true</entry>
- <entry>Whether the table should display the children of the selected org units</entry>
- </row>
- <row>
- <entry>crosstab</entry>
- <entry>string[]</entry>
- <entry>No</entry>
- <entry>data | periods | orgunit</entry>
- <entry>Which data dimension should be crosstabulated and used as columns </entry>
- </row>
- <row>
- <entry>hiddenCols</entry>
- <entry>int[]</entry>
- <entry>No</entry>
- <entry/>
- <entry>Zero-based index of the columns in the table which should be hidden</entry>
- </row>
- <row>
- <entry>useExtGrid</entry>
- <entry>boolean</entry>
- <entry>No</entry>
- <entry>false | true</entry>
- <entry>Whether the table should be rendered as plain HTML or as an Ext JS Grid</entry>
- </row>
- <row>
- <entry>el</entry>
- <entry>string</entry>
- <entry>Yes</entry>
- <entry/>
- <entry>Identifier of HTML element to render the table in</entry>
- </row>
- <row>
- <entry>url</entry>
- <entry>string</entry>
- <entry>Yes</entry>
- <entry/>
- <entry>Base URL of the DHIS server</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>In the following are examples on how the table plug-in can be used.</para>
- <screen>DHIS.getTable({
- indicators: ['Uvn6LCg7dVU'],
- periods: ['last12Months'],
- orgunits: ['ImspTQPwCqd'],
- crosstab: ['periods'],
- orgUnitIsParent: true,
- useExtGrid: false,
- callbackName: 'table1',
- hiddenCols: [0],
- el: 'table1',
- url: base
-});
-
-DHIS.getTable({
- dataelements: ['s46m5MS0hxu', 'YtbsuPPo010', 'xc8gmAKfO95', 'UOlfIjgN8X6'],
- periods: ['last4Quarters'],
- orgunits: ['ImspTQPwCqd'],
- crosstab: ['data'],
- useExtGrid: false,
- callbackName: 'table2',
- el: 'table2',
- url: base
-});</screen>
- <para>Finally we insert in the Web page the div elements which are referred to in the table configuration and used to render the tables.</para>
- <screen><div id="table1"></div>
-<div id="table2"></div></screen>
- <para>To view a complete working example please visit <ulink url="http://apps.dhis2.org/portal/table.html"/>.</para>
- <para>You can also choose to provide a link to the report table instead of rendering it directly on the web page. The configuration of the link function is very similar to the table function and shares the <emphasis role="italic">indicators</emphasis>, <emphasis role="italic">dataelements</emphasis>, <emphasis role="italic">datasets</emphasis>, <emphasis role="italic">periods</emphasis>, <emphasis role="italic">orgunits</emphasis>, <emphasis role="italic">orgUnitIsParent</emphasis>, <emphasis role="italic">crosstab</emphasis> and <emphasis role="italic">url</emphasis> properties. There is only one additional parameter which is listed in the table below.</para>
- <table>
- <title>Link plug-in (additional) configuration</title>
- <tgroup cols="5">
- <thead>
- <row>
- <entry>
- <emphasis role="italic">Param</emphasis>
- </entry>
- <entry>
- <emphasis role="italic">Type</emphasis>
- </entry>
- <entry>
- <emphasis role="italic">Required</emphasis>
- </entry>
- <entry>
- <emphasis role="italic">Options (default first)</emphasis>
- </entry>
- <entry>
- <emphasis role="italic">Description</emphasis>
- </entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>format</entry>
- <entry>string</entry>
- <entry>No</entry>
- <entry>html | xls | csv | pdf | json | xml</entry>
- <entry>The representation format of the table, can be HTML, Excel, CSV, PDF, JSON and XML</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>Below is an example on how to use the link function. The link URL is retrieved from the <emphasis role="italic">getUrl</emphasis> function and later set as target for a link the HTML document.</para>
- <screen>var url1 = DHIS.getUrl({
- indicators: ['Uvn6LCg7dVU'],
- periods: ['last12Months'],
- orgunits: ['ImspTQPwCqd'],
- crosstab: ['periods'],
- orgUnitIsParent: true,
- format: 'xls',
- url: base
-});
-
-Ext.get('link1').set({href: url1});</screen>
- <para>The link HTML element can be defined in the body section of the document like below.</para>
- <screen><a id="link1">Download as Excel</a></screen>
- <para>To view a complete working example please visit <ulink url="http://apps.dhis2.org/portal/table.html"/>.</para>
- </section>
- <section>
<title>Working with SQL views</title>
<para>SQL views are useful for presenting certain data views externally, which may be more
easily constructed with SQL than by combining the multiple objects of the Web API. As an
