Module: module_interface

Requires

• module:index.html
• module:dev/dev-defined.js
• module:js/main-loadfiles.js
• module:js/module-datacheck.js
• module:lang/module-lang.js
• module:lang/main-core.js

Members

static,constantmodule:module_interface.autoplayonBoolean

module-interface

Stores the indicator of whether the dashboard is on play mode or not.
Defined in module:module_interface.menuinteractions.

static,constantmodule:module_interface.autoplaytimeInteger

module-interface

Sets the time for the dashboard play mode.
Defined in module:module_interface.menuinteractions.

static,constantmodule:module_interface.autoplaytimerInteger

module-interface

Sets the timer for the dashboard play mode.
Defined in module:module_interface.menuinteractions.

Methods

staticmodule:module_interface.display()

module-interface

Runs through all the chars/maps to:

• add titles module:module_interface.titlesscreate,
• defines the associated buttons module:module_interface.buttonscreate (from module:g.viz_definition buttons_list) and associated interactions module:module_interface.buttoninteraction,
• defines the lateral menu buttons module:module_interface.menucreate and associated interactions module:module_interface.menuinteractions.

Requires:

• module:module_lang.text
• module:module_lang.current
• module:g.viz_keylist
• module:g.viz_definition
• module:g.viz_timeshare
• module:g.viz_timeline
• module:module_interface.menu_pausePlay
• module:menu_autoPlay
• module:g.geometry_keylist
• module:zoomToGeom
• module:g.geometry_data
• module:module_intro.definition
• module:module_intro.step
• module:g.medical_datatype
• module:module_colorscale.display
• module:module_colorscale.interaction
• module:module_colorscale.lockcolor
• module:g.module_colorscale.modecurrent

Intermediaries:

• module:module_interface.titlesscreate
• module:module_interface.buttonscreate
• module:module_interface.buttoninteraction
• module:module_interface.menucreate
• module:module_interface.menuinteractions

Returns:

• module:g.module_interface.autoplayon
• module:g.module_interface.autoplaytime
• module:g.module_interface.autoplaytimer

Triggered by the end of module:main_core~generateDashboard.

staticmodule:module_interface.menu_autoPlay()

module-interface

Defines the dashboard auto play mode.
Requires:

• module:module_interface.autoplaytime
• module:g.viz_definition
• module:g.viz_timeline
• module:g.viz_timeshare
• module:module_interface.menu_pausePlay
• module:g.viz_timeline

Triggered in module:module_interface~menuinteractions.

staticmodule:module_interface.menu_pausePlay()

module-interface

Defines the function to quit the dashboard auto play mode.
Requires:

• module:module_interface.autoplayon
• module:module_interface.autoplaytimer
• module:module_lang.text
• module:module_lang.current
• module:g.viz_timeline
• module:g.viz_timeshare
• module:g.viz_definition

Triggered in various functions of module:module_interface.

TODO

• Rename 'Stop'?

staticmodule:module_interface.menu_reset()

module-interface

Defines the reset all function.
Requires:

• module:g.module_colorscale.modecurrent
• module:g.medical_currentdisease
• module:module_interface.menu_pausePlay
• module:g.geometry_keylist
• module:zoomToGeom
• module:g.geometry_data
• module:g.viz_definition
• module:g.medical_datatype
• module:g.module_colorscale.mapunitcurrent
• module:g.medical_pastdisease
• module:module_colorscale.lockcolor

Returns:

• module:g.medical_pastdisease (? To be checked)

Triggered in module:module:module_interface~menucreate.

innerbuttoninteraction(key1, buttons)

module-interface

Defines the interactions that comes with the buttons created in module:module_interface~buttonscreate.
List of currenly implemented buttons:

• reset which resets the the filters applying on the current chart,
• help which displays the quick help implemented with module:module_intro and module:module_lang,
• parameters which displays the map parameters implemented with module:module_colorscale,
• expand which doubles the height of the map container,
• lockcolor which triggers the colorscale auto adjustment with module:module_colorscale.lockcolor.

Requires:

• module:g.viz_timeline
• module:module_interface.menu_pausePlay
• module:zoomToGeom
• module:g.geometry_data
• module:g.geometry_keylist
• module:g.viz_definition
• module:module_intro.definition
• module:module_intro.step
• module:g.medical_datatype
• module:module_colorscale.display
• module:module_colorscale.interaction
• module:module_colorscale.lockcolor

Triggered in module:module_interface.display.

Name	Type	Description
key1	String	Typically from module:g.viz_keylist
buttons	Array	Typically from module:g.viz_definition buttons_list

innerbuttonscreate(key, buttons)

module-interface

Creates buttons, from the lists in module:g.viz_definition buttons_list.
Triggered in module:module_interface.display.

Name	Type	Description
key	String	Typically from module:g.viz_keylist
buttons	Array	Typically from module:g.viz_definition buttons_list

innermenucreate()

module-interface

Defines the lateral menu layout.
Returns the html code as a string.
Requires:

• module:module_lang.text
• module:module_lang.current

Triggered in module:module_interface.display.

innermenuinteractions()

module-interface

Defines the interactions associated with the lateral menu buttons created in module:module_interface~menucreate: 'Play', 'Help' and 'N-epiwk Quick access'.
Requires:

• module:module_interface.menu_pausePlay
• module:g.viz_definition
• module:g.viz_timeline
• module:g.viz_timeshare
• module:module_colorscale.lockcolor
• module:module_lang.text
• module:module_lang.current
• module:g.module_intro.definition
• module:g.module_colorscale.modecurrent

Returns:

• module:g.module_interface.autoplayon
• module:g.module_interface.autoplaytime
• module:g.module_interface.autoplaytimer

Triggered in module:module_interface.display.

innertitlesscreate(key)

module-interface

Adds titles and space to display current filters to the charts.
Requires:

• module:module_lang.text
• module:module_lang.current

Triggered in module:module_interface.display.

Name	Type	Description
key	String	Typically from module:g.viz_keylist