------------------------------------------------------------
revno: 1171
committer: Lars Helge Overland <larshe...@gmail.com>
branch nick: dhis2-docbook-docs
timestamp: Thu 2014-08-07 09:41:50 +0200
message:
Docs, scripting and events in custom forms
modified:
src/docbkx/en/dhis2_user_man_datasets_forms.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_datasets_forms.xml'
--- src/docbkx/en/dhis2_user_man_datasets_forms.xml 2014-05-27 10:37:45 +0000
+++ src/docbkx/en/dhis2_user_man_datasets_forms.xml 2014-08-07 07:41:50 +0000
@@ -291,30 +291,69 @@
</section>
<section>
<title>Scripting in custom forms</title>
- <para>With custom data entry forms it is possible to use Javascript to create dynamic behavior
- of the form. There are two methods which can be used to hook into events in the data entry
- module. To have your code invoked when a data entry form has been loaded you can add a
- Javascript tag in your custom form like this:</para>
+ <para>In custom data entry form you can use javascript to create dynamic behavior and
+ customziations. The DHIS 2 data entry module provides a range of events which you can
+ register for and use to perform actions at certain times. The events are registered on the
+ document element. The table below provides an overview of the events and when they are
+ triggered.</para>
+ <table frame="all">
+ <title>Data entry events</title>
+ <tgroup cols="3">
+ <colspec colname="c1" colnum="1" colwidth="1*"/>
+ <colspec colname="c2" colnum="2" colwidth="1.92*"/>
+ <colspec colname="newCol3" colnum="3" colwidth="1.55*"/>
+ <thead>
+ <row>
+ <entry>Key</entry>
+ <entry>Description</entry>
+ <entry>Argument</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>dhis2.de.event.formLoaded</entry>
+ <entry>Triggered after the data entry form is rendered,. but before data values are
+ set in entry fields</entry>
+ <entry>-</entry>
+ </row>
+ <row>
+ <entry>dhis2.de.event.dataValuesLoaded</entry>
+ <entry>Triggered after data values are set in entry fields.</entry>
+ <entry>-</entry>
+ </row>
+ <row>
+ <entry>dhis2.de.event.formReady</entry>
+ <entry>Triggered when the data entry form is completely rendered and loaded with all
+ elements.</entry>
+ <entry>-</entry>
+ </row>
+ <row>
+ <entry>dhis2.de.event.dataValueSaved</entry>
+ <entry>Triggered when a data value is saved successfully.</entry>
+ <entry>The data value object.</entry>
+ </row>
+ <row>
+ <entry>dhis2.de.event.completed</entry>
+ <entry>Triggered when a data set is successfully marked as complete.</entry>
+ <entry>The complete registration object.</entry>
+ </row>
+ <row>
+ <entry>dhis2.de.event.uncompleted</entry>
+ <entry>Triggered when a data set is successfully marked as incomplete.</entry>
+ <entry>-</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>To register for such an event:</para>
<screen><script type="text/javascript">
-onFormLoad( function() {
- // Do your javascript stuff here
+dhis2.de.on( "dhis2.de.event.formReady", function() {
+ console.log( "The form is loaded!" );
} );
-</script></screen>
- <para>To have your code invoked when any data value is successfully saved in the form you can
- add a Javascript tag like the example below. Note that you can access all properties for the
- data value being saved through your callback function; the first parameter is the event
- object while the second argument is the data value object being saved:</para>
- <screen><script type="text/javascript">
-
-onValueSave( function( event, dataValue ) {
- var de = dataValue.dataElementId;
- var co = dataValue.optionComboId;
- var ou = dataValue.organisationUnitId;
- var va = dataValue.value;
-
- // Do stuff like modifying the form based on the data element and value being saved
+dhis2.de.on( "dhis2.de.event.dataValueSaved", function( dv ) {
+ console.log( "Data value was saved with data element: " + dv.de );
} );
</script></screen>
_______________________________________________
Mailing list: https://launchpad.net/~dhis2-devs
Post to : dhis2-devs@lists.launchpad.net
Unsubscribe : https://launchpad.net/~dhis2-devs
More help : https://help.launchpad.net/ListHelp
