MSF-Dashboard

Module: module_chartwarper

module_chartwarper

This file gives the necessary instructions to setup a 'chartwarper' (puts charts containers under tabs).
'index.html' must be adapted accordingly.

Since:
  • 1.5
TODO
  • Put 'tabcontainer_id' and 'chartcontainers_list' in dev-defined.js.
  • Checks if 'tabcontainer_id' or 'chartcontainers_list' is empty.

Requires

  • module:index.html
  • module:dev/dev-defined.js

Members

staticmodule:module_chartwarper.chartcontainers_listArray

module-chartwarper

Stores the names of the charts/containers to warp behind tabs.
Defined in module:module_datatable.setup.

staticmodule:module_chartwarper.tabcontainer_idString

module-chartwarper

Stores the id of the tabs container.
Defined in module:module_datatable.setup.

staticmodule:module_chartwarper.tabcurrentString

module-chartwarper

Stores the current tab name.
Defined in module:module_chartwarper.interaction.

staticmodule:module_chartwarper.tabcurrentnumInteger

module-chartwarper

Stores the current tab number.
Defined in module:module_chartwarper.interaction.

Methods

staticmodule:module_chartwarper.display(tabcontainer_id, chartcontainers_list){function}

module-chartwarper

Defines the tabs layout.
Requires:


Triggered by the end of module:main_core~generateDashboard.

Name Type Description
tabcontainer_id String

Typically: g.module_chartwarper.tabcontainer_id
chartcontainers_list Array

Typically: g.module_chartwarper.chartcontainers_list
Returns:
Type Description
function

staticmodule:module_chartwarper.interaction(chartcontainers_list){function}

module-chartwarper

Defines the tab interactions (show/hide containers).
Returns:


Triggered by the end of module:main_core~generateDashboard.

Name Type Description
chartcontainers_list
Returns:
Type Description
function