module-g.html

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>MSF-Dashboard Documentation</title>
    
    
    <meta property="og:title" content=""/>
    <meta property="og:type" content=""/>
    <meta property="og:image" content=""/>
    
    <meta property="og:url" content=""/>
    
    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <script src="scripts/jquery.min.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
    <link type="text/css" rel="stylesheet" href="styles/ljve.css">
    
    
    <script>
    var config = {"monospaceLinks":false,"cleverLinks":false,"applicationName":"MSF-Dashboard","disqus":"","googleAnalytics":"","openGraph":{"title":"","type":"","image":"","site_name":"","url":""},"meta":{"title":"MSF-Dashboard Documentation","description":"","keyword":""},"linenums":true,"default":{}};
    </script>
    

</head>
<body>
<div id="wrap" class="clearfix">
    
<div class="navigation">
    <h3 class="applicationName"><a href="index.html">MSF-Dashboard</a></h3>

    <div class="search">
        <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations">
    </div>
    <ul class="list">
    
        <li class="item" data-name="module:g">
            <span class="title">
                <a href="module-g.html">module:g</a>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="module:g.geometry_data"><a href="module-g.html#.geometry_data">geometry_data</a></li>
            
                <li data-name="module:g.geometry_filelist"><a href="module-g.html#.geometry_filelist">geometry_filelist</a></li>
            
                <li data-name="module:g.geometry_keylist"><a href="module-g.html#.geometry_keylist">geometry_keylist</a></li>
            
                <li data-name="module:g.geometry_levellist"><a href="module-g.html#.geometry_levellist">geometry_levellist</a></li>
            
                <li data-name="module:g.geometry_loclists"><a href="module-g.html#.geometry_loclists">geometry_loclists</a></li>
            
                <li data-name="module:g.geometry_subnum"><a href="module-g.html#.geometry_subnum">geometry_subnum</a></li>
            
                <li data-name="module:g.mask_bypass"><a href="module-g.html#.mask_bypass">mask_bypass</a></li>
            
                <li data-name="module:g.mask_data"><a href="module-g.html#.mask_data">mask_data</a></li>
            
                <li data-name="module:g.mask_filelist"><a href="module-g.html#.mask_filelist">mask_filelist</a></li>
            
                <li data-name="module:g.medical_completeness"><a href="module-g.html#.medical_completeness">medical_completeness</a></li>
            
                <li data-name="module:g.medical_currentdisease"><a href="module-g.html#.medical_currentdisease">medical_currentdisease</a></li>
            
                <li data-name="module:g.medical_data"><a href="module-g.html#.medical_data">medical_data</a></li>
            
                <li data-name="module:g.medical_datatype"><a href="module-g.html#.medical_datatype">medical_datatype</a></li>
            
                <li data-name="module:g.medical_diseaseslist"><a href="module-g.html#.medical_diseaseslist">medical_diseaseslist</a></li>
            
                <li data-name="module:g.medical_filecurrent"><a href="module-g.html#.medical_filecurrent">medical_filecurrent</a></li>
            
                <li data-name="module:g.medical_filelist"><a href="module-g.html#.medical_filelist">medical_filelist</a></li>
            
                <li data-name="module:g.medical_filelist_raw"><a href="module-g.html#.medical_filelist_raw">medical_filelist_raw</a></li>
            
                <li data-name="module:g.medical_filetypecurrent"><a href="module-g.html#.medical_filetypecurrent">medical_filetypecurrent</a></li>
            
                <li data-name="module:g.medical_folder"><a href="module-g.html#.medical_folder">medical_folder</a></li>
            
                <li data-name="module:g.medical_headerlist"><a href="module-g.html#.medical_headerlist">medical_headerlist</a></li>
            
                <li data-name="module:g.medical_keylist"><a href="module-g.html#.medical_keylist">medical_keylist</a></li>
            
                <li data-name="module:g.medical_loclists"><a href="module-g.html#.medical_loclists">medical_loclists</a></li>
            
                <li data-name="module:g.medical_read"><a href="module-g.html#.medical_read">medical_read</a></li>
            
                <li data-name="module:g.medical_weeklist"><a href="module-g.html#.medical_weeklist">medical_weeklist</a></li>
            
                <li data-name="module:g.medical_yearlist"><a href="module-g.html#.medical_yearlist">medical_yearlist</a></li>
            
                <li data-name="module:g.module_chartwarper"><a href="module-g.html#.module_chartwarper">module_chartwarper</a></li>
            
                <li data-name="module:g.module_colorscale"><a href="module-g.html#.module_colorscale">module_colorscale</a></li>
            
                <li data-name="module:g.module_datatable"><a href="module-g.html#.module_datatable">module_datatable</a></li>
            
                <li data-name="module:g.module_interface"><a href="module-g.html#.module_interface">module_interface</a></li>
            
                <li data-name="module:g.module_intro"><a href="module-g.html#.module_intro">module_intro</a></li>
            
                <li data-name="module:g.module_lang"><a href="module-g.html#.module_lang">module_lang</a></li>
            
                <li data-name="module:g.module_multiadm"><a href="module-g.html#.module_multiadm">module_multiadm</a></li>
            
                <li data-name="module:g.population_bypass"><a href="module-g.html#.population_bypass">population_bypass</a></li>
            
                <li data-name="module:g.population_data"><a href="module-g.html#.population_data">population_data</a></li>
            
                <li data-name="module:g.population_filelist"><a href="module-g.html#.population_filelist">population_filelist</a></li>
            
                <li data-name="module:g.population_headerlist"><a href="module-g.html#.population_headerlist">population_headerlist</a></li>
            
                <li data-name="module:g.population_keylist"><a href="module-g.html#.population_keylist">population_keylist</a></li>
            
                <li data-name="module:g.population_loclists"><a href="module-g.html#.population_loclists">population_loclists</a></li>
            
                <li data-name="module:g.population_popdata"><a href="module-g.html#.population_popdata">population_popdata</a></li>
            
                <li data-name="module:g.viz_currentvalues"><a href="module-g.html#.viz_currentvalues">viz_currentvalues</a></li>
            
                <li data-name="module:g.viz_definition"><a href="module-g.html#.viz_definition">viz_definition</a></li>
            
                <li data-name="module:g.viz_keylist"><a href="module-g.html#.viz_keylist">viz_keylist</a></li>
            
                <li data-name="module:g.viz_timeline"><a href="module-g.html#.viz_timeline">viz_timeline</a></li>
            
                <li data-name="module:g.viz_timeshare"><a href="module-g.html#.viz_timeshare">viz_timeshare</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="module:main_core">
            <span class="title">
                <a href="module-main_core.html">module:main_core</a>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="module:main_core~color_domain"><a href="module-main_core.html#~color_domain">color_domain</a></li>
            
                <li data-name="module:main_core~color_list"><a href="module-main_core.html#~color_list">color_list</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="module:main_core~chartBuilder"><a href="module-main_core.html#~chartBuilder">chartBuilder</a></li>
            
                <li data-name="module:main_core~chartInstancer"><a href="module-main_core.html#~chartInstancer">chartInstancer</a></li>
            
                <li data-name="module:main_core~colorAccessor"><a href="module-main_core.html#~colorAccessor">colorAccessor</a></li>
            
                <li data-name="module:main_core~dimensionBuilder"><a href="module-main_core.html#~dimensionBuilder">dimensionBuilder</a></li>
            
                <li data-name="module:main_core~domainBuilder"><a href="module-main_core.html#~domainBuilder">domainBuilder</a></li>
            
                <li data-name="module:main_core~generateDashboard"><a href="module-main_core.html#~generateDashboard">generateDashboard</a></li>
            
                <li data-name="module:main_core~groupBuilder"><a href="module-main_core.html#~groupBuilder">groupBuilder</a></li>
            
                <li data-name="module:main_core~numericOutputs"><a href="module-main_core.html#~numericOutputs">numericOutputs</a></li>
            
                <li data-name="module:main_core~onFiltered"><a href="module-main_core.html#~onFiltered">onFiltered</a></li>
            
                <li data-name="module:main_core~sync_charts"><a href="module-main_core.html#~sync_charts">sync_charts</a></li>
            
                <li data-name="module:main_core~sync_maps"><a href="module-main_core.html#~sync_maps">sync_maps</a></li>
            
                <li data-name="module:main_core~valueAccessor"><a href="module-main_core.html#~valueAccessor">valueAccessor</a></li>
            
                <li data-name="module:main_core~zoomToGeom"><a href="module-main_core.html#~zoomToGeom">zoomToGeom</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="module:main_loadfiles">
            <span class="title">
                <a href="module-main_loadfiles.html">module:main_loadfiles</a>
                
            </span>
            <ul class="members itemMembers">
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="module:main_loadfiles~generate_display"><a href="module-main_loadfiles.html#~generate_display">generate_display</a></li>
            
                <li data-name="module:main_loadfiles~queue_geometry"><a href="module-main_loadfiles.html#~queue_geometry">queue_geometry</a></li>
            
                <li data-name="module:main_loadfiles~queue_list"><a href="module-main_loadfiles.html#~queue_list">queue_list</a></li>
            
                <li data-name="module:main_loadfiles~queue_mask"><a href="module-main_loadfiles.html#~queue_mask">queue_mask</a></li>
            
                <li data-name="module:main_loadfiles~queue_medical"><a href="module-main_loadfiles.html#~queue_medical">queue_medical</a></li>
            
                <li data-name="module:main_loadfiles~queue_population"><a href="module-main_loadfiles.html#~queue_population">queue_population</a></li>
            
                <li data-name="module:main_loadfiles~read_commons"><a href="module-main_loadfiles.html#~read_commons">read_commons</a></li>
            
                <li data-name="module:main_loadfiles~read_medical"><a href="module-main_loadfiles.html#~read_medical">read_medical</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="module:module_chartwarper">
            <span class="title">
                <a href="module-module_chartwarper.html">module:module_chartwarper</a>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="module:module_chartwarper.chartcontainers_list"><a href="module-module_chartwarper.html#.chartcontainers_list">chartcontainers_list</a></li>
            
                <li data-name="module:module_chartwarper.tabcontainer_id"><a href="module-module_chartwarper.html#.tabcontainer_id">tabcontainer_id</a></li>
            
                <li data-name="module:module_chartwarper.tabcurrent"><a href="module-module_chartwarper.html#.tabcurrent">tabcurrent</a></li>
            
                <li data-name="module:module_chartwarper.tabcurrentnum"><a href="module-module_chartwarper.html#.tabcurrentnum">tabcurrentnum</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="module:module_chartwarper.display"><a href="module-module_chartwarper.html#.display">display</a></li>
            
                <li data-name="module:module_chartwarper.interaction"><a href="module-module_chartwarper.html#.interaction">interaction</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="module:module_colorscale">
            <span class="title">
                <a href="module-module_colorscale.html">module:module_colorscale</a>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="module:module_colorscale.colors"><a href="module-module_colorscale.html#.colors">colors</a></li>
            
                <li data-name="module:module_colorscale.colorscurrent"><a href="module-module_colorscale.html#.colorscurrent">colorscurrent</a></li>
            
                <li data-name="module:module_colorscale.colorslist"><a href="module-module_colorscale.html#.colorslist">colorslist</a></li>
            
                <li data-name="module:module_colorscale.mapunitcurrent"><a href="module-module_colorscale.html#.mapunitcurrent">mapunitcurrent</a></li>
            
                <li data-name="module:module_colorscale.mapunitlist"><a href="module-module_colorscale.html#.mapunitlist">mapunitlist</a></li>
            
                <li data-name="module:module_colorscale.modecurrent"><a href="module-module_colorscale.html#.modecurrent">modecurrent</a></li>
            
                <li data-name="module:module_colorscale.modelist"><a href="module-module_colorscale.html#.modelist">modelist</a></li>
            
                <li data-name="module:module_colorscale.scaletypecurrent"><a href="module-module_colorscale.html#.scaletypecurrent">scaletypecurrent</a></li>
            
                <li data-name="module:module_colorscale.scaletypelist"><a href="module-module_colorscale.html#.scaletypelist">scaletypelist</a></li>
            
                <li data-name="module:module_colorscale.values"><a href="module-module_colorscale.html#.values">values</a></li>
            
                <li data-name="module:module_colorscale.valuescurrent"><a href="module-module_colorscale.html#.valuescurrent">valuescurrent</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="module:module_colorscale.display"><a href="module-module_colorscale.html#.display">display</a></li>
            
                <li data-name="module:module_colorscale.interaction"><a href="module-module_colorscale.html#.interaction">interaction</a></li>
            
                <li data-name="module:module_colorscale.lockcolor"><a href="module-module_colorscale.html#.lockcolor">lockcolor</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="module:module_datacheck">
            <span class="title">
                <a href="module-module_datacheck.html">module:module_datacheck</a>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="module:module_datacheck.definition_record"><a href="module-module_datacheck.html#.definition_record">definition_record</a></li>
            
                <li data-name="module:module_datacheck.diseasecheck"><a href="module-module_datacheck.html#.diseasecheck">diseasecheck</a></li>
            
                <li data-name="module:module_datacheck.log"><a href="module-module_datacheck.html#.log">log</a></li>
            
                <li data-name="module:module_datacheck.showempty"><a href="module-module_datacheck.html#.showempty">showempty</a></li>
            
                <li data-name="module:module_datacheck.sum"><a href="module-module_datacheck.html#.sum">sum</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="module:module_datacheck~completenessCheck"><a href="module-module_datacheck.html#~completenessCheck">completenessCheck</a></li>
            
                <li data-name="module:module_datacheck~CopyText"><a href="module-module_datacheck.html#~CopyText">CopyText</a></li>
            
                <li data-name="module:module_datacheck~dataprocessing"><a href="module-module_datacheck.html#~dataprocessing">dataprocessing</a></li>
            
                <li data-name="module:module_datacheck~display"><a href="module-module_datacheck.html#~display">display</a></li>
            
                <li data-name="module:module_datacheck~errorlogging"><a href="module-module_datacheck.html#~errorlogging">errorlogging</a></li>
            
                <li data-name="module:module_datacheck~interaction"><a href="module-module_datacheck.html#~interaction">interaction</a></li>
            
                <li data-name="module:module_datacheck~SelectText"><a href="module-module_datacheck.html#~SelectText">SelectText</a></li>
            
                <li data-name="module:module_datacheck~ShowEmpty"><a href="module-module_datacheck.html#~ShowEmpty">ShowEmpty</a></li>
            
                <li data-name="module:module_datacheck~showlog"><a href="module-module_datacheck.html#~showlog">showlog</a></li>
            
                <li data-name="module:module_datacheck~testrecord"><a href="module-module_datacheck.html#~testrecord">testrecord</a></li>
            
                <li data-name="module:module_datacheck~testvalue"><a href="module-module_datacheck.html#~testvalue">testvalue</a></li>
            
                <li data-name="module:module_datacheck~toTitleCase"><a href="module-module_datacheck.html#~toTitleCase">toTitleCase</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="module:module_datatable">
            <span class="title">
                <a href="module-module_datatable.html">module:module_datatable</a>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="module:module_datatable.columns"><a href="module-module_datatable.html#.columns">columns</a></li>
            
                <li data-name="module:module_datatable.datatable"><a href="module-module_datatable.html#.datatable">datatable</a></li>
            
                <li data-name="module:module_datatable.definition"><a href="module-module_datatable.html#.definition">definition</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="module:module_datatable.display"><a href="module-module_datatable.html#.display">display</a></li>
            
                <li data-name="module:module_datatable.interaction"><a href="module-module_datatable.html#.interaction">interaction</a></li>
            
                <li data-name="module:module_datatable.refreshTable"><a href="module-module_datatable.html#.refreshTable">refreshTable</a></li>
            
                <li data-name="module:module_datatable.setup"><a href="module-module_datatable.html#.setup">setup</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="module:module_interface">
            <span class="title">
                <a href="module-module_interface.html">module:module_interface</a>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="module:module_interface.autoplayon"><a href="module-module_interface.html#.autoplayon">autoplayon</a></li>
            
                <li data-name="module:module_interface.autoplaytime"><a href="module-module_interface.html#.autoplaytime">autoplaytime</a></li>
            
                <li data-name="module:module_interface.autoplaytimer"><a href="module-module_interface.html#.autoplaytimer">autoplaytimer</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="module:module_interface.display"><a href="module-module_interface.html#.display">display</a></li>
            
                <li data-name="module:module_interface.menu_autoPlay"><a href="module-module_interface.html#.menu_autoPlay">menu_autoPlay</a></li>
            
                <li data-name="module:module_interface.menu_pausePlay"><a href="module-module_interface.html#.menu_pausePlay">menu_pausePlay</a></li>
            
                <li data-name="module:module_interface.menu_reset"><a href="module-module_interface.html#.menu_reset">menu_reset</a></li>
            
                <li data-name="module:module_interface~buttoninteraction"><a href="module-module_interface.html#~buttoninteraction">buttoninteraction</a></li>
            
                <li data-name="module:module_interface~buttonscreate"><a href="module-module_interface.html#~buttonscreate">buttonscreate</a></li>
            
                <li data-name="module:module_interface~menucreate"><a href="module-module_interface.html#~menucreate">menucreate</a></li>
            
                <li data-name="module:module_interface~menuinteractions"><a href="module-module_interface.html#~menuinteractions">menuinteractions</a></li>
            
                <li data-name="module:module_interface~titlesscreate"><a href="module-module_interface.html#~titlesscreate">titlesscreate</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="module:module_intro">
            <span class="title">
                <a href="module-module_intro.html">module:module_intro</a>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="module:module_intro.definition"><a href="module-module_intro.html#.definition">definition</a></li>
            
                <li data-name="module:module_intro.step"><a href="module-module_intro.html#.step">step</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="module:module_intro.setup"><a href="module-module_intro.html#.setup">setup</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="module:module_lang">
            <span class="title">
                <a href="module-module_lang.html">module:module_lang</a>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="module:module_lang.current"><a href="module-module_lang.html#.current">current</a></li>
            
                <li data-name="module:module_lang.keylist"><a href="module-module_lang.html#.keylist">keylist</a></li>
            
                <li data-name="module:module_lang.list"><a href="module-module_lang.html#.list">list</a></li>
            
                <li data-name="module:module_lang.text"><a href="module-module_lang.html#.text">text</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="module:module_lang.display"><a href="module-module_lang.html#.display">display</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="module:module_multiadm">
            <span class="title">
                <a href="module-module_multiadm.html">module:module_multiadm</a>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="module:module_multiadm.focuscurrent"><a href="module-module_multiadm.html#.focuscurrent">focuscurrent</a></li>
            
                <li data-name="module:module_multiadm.tabcurrent"><a href="module-module_multiadm.html#.tabcurrent">tabcurrent</a></li>
            
                <li data-name="module:module_multiadm.tabcurrentnum"><a href="module-module_multiadm.html#.tabcurrentnum">tabcurrentnum</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="module:module_multiadm.display"><a href="module-module_multiadm.html#.display">display</a></li>
            
                <li data-name="module:module_multiadm.initGoto"><a href="module-module_multiadm.html#.initGoto">initGoto</a></li>
            
                <li data-name="module:module_multiadm.interaction"><a href="module-module_multiadm.html#.interaction">interaction</a></li>
            
                <li data-name="module:module_multiadm.interaction_tab"><a href="module-module_multiadm.html#.interaction_tab">interaction_tab</a></li>
            
                <li data-name="module:module_multiadm.propGoto"><a href="module-module_multiadm.html#.propGoto">propGoto</a></li>
            
                <li data-name="module:module_multiadm.resetGoto"><a href="module-module_multiadm.html#.resetGoto">resetGoto</a></li>
            
                <li data-name="module:module_multiadm.zoomTo"><a href="module-module_multiadm.html#.zoomTo">zoomTo</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
    </ul>
</div>
    <div class="main">
        <h1 class="page-title" data-filename="module-g.html">Module: g</h1>
        

<section>
    
<header>
    <h2>
    g
    </h2>
    
</header>  

<article>
    <div class="container-overview">
    
    
            <div class="description"><p>This module contains the parameters of the dashboard that have to be defined by the developer in order to tailor the tool to the specific needs of the future users. In the following we will look at the parameters needed to:
 <ul>
    <li> get the medical and geometry data,</li>
    <li> check the medical and geometry data,</li> 
    <li> define the charts and maps, feed them with the correct data and define specific interaction,</li> 
 </ul>
All these parameters are defined in <code>dev/dev-defined.js</code> and are stored in the global variable <code>g</code>. 
 <br><br>
 <code>g</code> stores other Objects as well that are not defined by the developer but that are the results of the processing and interactions. <code>g</code> can be accessed through your developer browser interface.<br> <br><br>
As a reminder, two other files are crucial when setting up a new version of the Dashboard which are:
 <ul>
    <li> the 'index.html' file which defines the divs and the positions of the charts and maps, and </li>
    <li> the module:module-lang ('lang/module-lang.js') which contains all the text that have to be displayed and its various translations.</li>
</ul></p></div>
        
        
<dl class="details">
    
        
    <dt class="tag-since">Since:</dt>
    <dd class="tag-since"><ul class="dummy"><li>1.0</dd>
    

    <dt class="tag-todo">TODO</dt>
    <dd class="tag-todo">
        <ul>
            <li>Limit list of parameters in g.</li>
        
            <li>Implement 'module_list' check to run or not the modules.</li>
        </ul>
    </dd>
    
</dl>

        
    </div>
    
    
        <h3 class="subsection-title">Requires</h3>
        
        <ul>
            <li>module:lang/lang.js</li>
        </ul>
    
    
        <h3 class="subsection-title">Members</h3>
        
        <dl>
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".geometry_data"><span class="type-signature static">static,constant</span>module:g.geometry_data<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores geometry data parsed from the files in g.geometry_filelist and by the function <a href="module-main_loadfiles.html#~queue_geometry">module:main_loadfiles~queue_geometry</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".geometry_filelist"><span class="type-signature static">static,constant</span>module:g.geometry_filelist<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            dev-defined
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Lists the geojson files when provided locally and gives their address. For each <code>admN</code><em>X</em> in <a href="module-g.html#.medical_headerlist">module:g.medical_headerlist</a> there must be a corresponding geometry file listed here.<br>
 Each element in the object is coded in the following way:
 <pre><em>admNX</em>: '<em>./data/admnx.geojson</em>',</pre></p>
    </div>
    
    
<dl class="details">
    
        
    <dt class="tag-todo">TODO</dt>
    <dd class="tag-todo">
        <ul>
            <li>Should be rethought via a data parser that can take either files or request files via APIs such as ArcGIS Online or other geoservers.</li>
        </ul>
    </dd>
    
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".geometry_keylist"><span class="type-signature static">static,constant</span>module:g.geometry_keylist<span class="type-signature type array.<string>">Array.&lt;String></span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores keys of each administrative level extracted from the <a href="module-g.html#.geometry_filelist">module:g.geometry_filelist</a>.
     <br>
Processing triggered in <a href="module-main_loadfiles.html#~read_commons">module:main_loadfiles~read_commons</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".geometry_levellist"><span class="type-signature static">static,constant</span>module:g.geometry_levellist<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores a number associate with administrative level (0 is the wider, and the bigger is the lowest/smaller).
          <br>
Processing triggered in <a href="module-main_loadfiles.html#~read_commons">module:main_loadfiles~read_commons</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".geometry_loclists"><span class="type-signature static">static,constant</span>module:g.geometry_loclists<span class="type-signature type object.<array.<string>>">Object.&lt;Array.&lt;String>></span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores the name of the administrative elements extracted from <a href="module-g.html#.geometry_data">module:g.geometry_data</a> by <a href="module-main_loadfiles.html#~queue_geometry">module:main_loadfiles~queue_geometry</a>. Names are formatted in the following way: <code>'AdmN0', 'AdmN1',...</code> in order to manage efficiently pyramids and possible duplicates at lowest administrative levels.<br>
     Each administrative level is stored in a different Object.
          <br>
Processing triggered in <a href="module-main_loadfiles.html#~read_commons">module:main_loadfiles~read_commons</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".geometry_subnum"><span class="type-signature static">static,constant</span>module:g.geometry_subnum<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores the number of lowest administrative level within a given administrative level (eg. number of AdmN3 in AdmN2, AdmN1 and AdmN0). This is used to compute completeness <a href="module-g.html#.medical_completeness">module:g.medical_completeness</a> in <a href="module-module_datacheck.html#~dataprocessing">module:module_datacheck~dataprocessing</a> &gt; <a href="module-module_datacheck.html#~completenessCheck">module:module_datacheck~completenessCheck</a>.
          <br>
Processing triggered in <a href="module-main_loadfiles.html#~read_commons">module:main_loadfiles~read_commons</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".mask_bypass"><span class="type-signature static">static,constant</span>module:g.mask_bypass<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Checks whether <a href="module-g.html#.mask_filelist">module:g.mask_filelist</a> has been defined or not, and thus decide whether necessary to bypass the extra layers parsing step.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".mask_data"><span class="type-signature static">static,constant</span>module:g.mask_data<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores mask data parsed from the files in g.mask_filelist and by the function <a href="module-main_loadfiles.html#~queue_mask">module:main_loadfiles~queue_mask</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".mask_filelist"><span class="type-signature static">static,constant</span>module:g.mask_filelist<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            dev-defined
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Other layers can be parsed here to be displayed on the map (masks, admin divisions, labels...).<br>
 The elements are coded in the following way:
 <pre><em>layer_key</em>: '<em>./data/layer.geojson</em>'</pre></p>
    </div>
    
    
<dl class="details">
    
        
    <dt class="tag-todo">TODO</dt>
    <dd class="tag-todo">
        <ul>
            <li>Should be rethought via a data parser that can take either files or request files via APIs.</li>
        </ul>
    </dd>
    
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_completeness"><span class="type-signature static">static</span>module:g.medical_completeness<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            module-datacheck
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores a percentage of completeness for each combination of administrative level and epiweek. All the <a href="module-g.html#.medical_data">module:g.medical_data</a> is browsed in <a href="module-module_datacheck.html#~dataprocessing">module:module_datacheck~dataprocessing</a>. Percentage calculation is performed by <a href="module-module_datacheck.html#~completenessCheck">module:module_datacheck~completenessCheck</a>, combining records counting and numbers of lowest administrative division per administrative division stored in <a href="module-g.html#.geometry_subnum">module:g.geometry_subnum</a>.
    <br>
     Each combination of administrative level and epiweek is stored in a different Object.
     <br>
Processing triggered in <a href="module-module_datacheck.html#~dataprocessing">module:module_datacheck~dataprocessing</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_currentdisease"><span class="type-signature static">static</span>module:g.medical_currentdisease<span class="type-signature type string">String</span> </h4>
    
        
          <span class="type-signature">
            main-core
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_data"><span class="type-signature static">static,constant</span>module:g.medical_data<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores medical data parsed from <a href="module-g.html#.medical_filecurrent">module:g.medical_filecurrent</a> by <a href="module-main_loadfiles.html#~queue_medical">module:main_loadfiles~queue_medical</a> and processed via <a href="module-main_loadfiles.html#~read_medical">module:main_loadfiles~read_medical</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_datatype"><span class="type-signature static">static,constant</span>module:g.medical_datatype<span class="type-signature type string">String</span> </h4>
    
        
          <span class="type-signature">
            dev-defined
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Defines the type of medical data parsed in the dashboard. <br>
 <br>
 Currently accepted values are:
 <ul>
     <li><code>surveillance</code> (aggregated) or</li>
     <li><code>outbreak</code> (linelist).</li>
 </ul></p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_diseaseslist"><span class="type-signature static">static,constant</span>module:g.medical_diseaseslist<span class="type-signature type array.<string>">Array.&lt;String></span> </h4>
    
        
          <span class="type-signature">
            dev-defined
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Defines an array of Disease to be used as an <code>inlist</code> check in <a href="module-module_datacheck.html#~dataprocessing">module:module_datacheck~dataprocessing</a>. In case the list of disease to follow is not predefined, an empty array must be parsed and the list of diseases will be created in <a href="module-module_datacheck.html#~dataprocessing">module:module_datacheck~dataprocessing</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_filecurrent"><span class="type-signature static">static,constant</span>module:g.medical_filecurrent<span class="type-signature type string">String</span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores the name of the file currently being read. Starts with the first file in the <a href="module-g.html#.medical_filelist">module:g.medical_filelist</a> and then <a href="module-main_loadfiles.html#~generate_display">module:main_loadfiles~generate_display</a> gives the user the option to choose between all the available files.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_filelist"><span class="type-signature static">static,constant</span>module:g.medical_filelist<span class="type-signature type array.<string>">Array.&lt;String></span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Lists files in the datafolder that matches the extension criteria (currently <em>.txt | </em>.TXT | <em>.csv | </em>.CSV) in the <a href="module-g.html#.medical_filelist_raw">module:g.medical_filelist_raw</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_filelist_raw"><span class="type-signature static">static,constant</span>module:g.medical_filelist_raw<span class="type-signature type array.<string>">Array.&lt;String></span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Lists the medical data files in the <a href="module-g.html#.medical_folder">module:g.medical_folder</a> folder path (uses Node server-side capability).</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_filetypecurrent"><span class="type-signature static">static,constant</span>module:g.medical_filetypecurrent<span class="type-signature type string">String</span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores the type of the file about to be read from <a href="module-g.html#.medical_filecurrent">module:g.medical_filecurrent</a> in order to use the correct parsing method in <a href="module-main_loadfiles.html#~queue_medical">module:main_loadfiles~queue_medical</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_folder"><span class="type-signature static">static,constant</span>module:g.medical_folder<span class="type-signature type string">String</span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Gets the medical data folder path (uses Node server-side capability).</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_headerlist"><span class="type-signature static">static,constant</span>module:g.medical_headerlist<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            dev-defined
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Lists the keys used to refer to specific <a href="module-g.html#.medical_data">module:g.medical_data</a> fields. It makes the link between headers in the data files and unambiguous keys used in the code.<br>
 Each element in the object is coded in the following way:
 <pre><em>key_in_dashboard</em>: '<em>header_in_datafile</em>',</pre>
 <br>
 Currently implemented keys are:</p>
<ul>
  <li><strong>General keys</strong>
    <ul>
        <li><code>epiweek</code> for epidemiological week: format YYYY-WW,</li>
        <li><code>admN</code><em>X</em> for names of administrative/health division levels (<em>X</em> being replaced by 0, 1, 2...). Multiple instances allowed.</li>
        <li><code>pop</code> for absolute population figures.</li>
    </ul>
  </li>
  <li><strong>Outbreak keys</strong> (not limited to <code>outbreak</code> <a href="module-g.html#.medical_datatype">module:g.medical_datatype</a> but generally observed in this context)
    <ul>
        <li><code>age</code> for patient age in years,</li>
        <li><code>sex</code> for patient sex (eg. 1 = Male, 2 = Female),</li>
        <li><code>preg</code> for pregnant patient (eg. 1 = Pregnant, 2 = Not Pregnant or N/A),</li>
        <li><code>sev</code> for patient dehydration severity (eg. A = Light, B = Moderate, C = Severe),</li>
        <li><code>dur</code> for patient stay duration in days,</li>
        <li><code>out</code>  for patient stay outcome (eg. 1 = Cured, 2 = Dead, 3 = Interrupted F/U, 4 = Transfered).</li>
    </ul>
  </li>
  <li><strong>Surveillance keys</strong> (not limited to <code>surveillance</code> <a href="module-g.html#.medical_datatype">module:g.medical_datatype</a> but generally observed in this context)
    <ul>
        <li><code>disease</code> for disease name,</li>
        <li><code>fyo</code> for under or over Five Year Old indicator (eg. u = Under, o = Over),
        <li><code>case</code> for number of cases overall,</li>
        <li><code>mcase</code> for number of male cases,</li>
        <li><code>fcase</code> for number of female cases,</li>
        <li><code>death</code> for number of deaths overall,</li>
        <li><code>mdeath</code> for number of male deaths,</li>
        <li><code>fdeath</code> for number of female deaths,</li>
    </ul>
  </li>
</ul>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
        <h5>Example</h5>
        
        <p class="code-caption">Example usage for ERU Dashboard (light surveillance).</p>
    

    <pre class="prettyprint"><code>g.medical_headerlist = {
    epiwk: 'epiweek',
    admN1: 'ZS',
    disease: 'disease',
    case: 'nb_cases'
 }; </code></pre>
    

</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_keylist"><span class="type-signature static">static,constant</span>module:g.medical_keylist<span class="type-signature type array.<string>">Array.&lt;String></span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Lists from <a href="module-g.html#.medical_headerlist">module:g.medical_headerlist</a> the keys used to refer to specific <a href="module-g.html#.medical_data">module:g.medical_data</a> fields. Defined in the Dashboard (might be different from the headers in the data files) in user-defined <a href="module-g.html#.medical_headerlist">module:g.medical_headerlist</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_loclists"><span class="type-signature static">static,constant</span>module:g.medical_loclists<span class="type-signature type object.<array.<string>>">Object.&lt;Array.&lt;String>></span> </h4>
    
        
          <span class="type-signature">
            module-datacheck
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores the name of the administrative elements extracted from <a href="module-g.html#.medical_data">module:g.medical_data</a> by <a href="module-module_datacheck.html#~testvalue">module:module_datacheck~testvalue</a>. Names are formatted in the following way: <code>'AdmN0', 'AdmN1',...</code> in order to manage efficiently pyramids and possible duplicates at lowest administrative levels. They are matched against names in <a href="module-g.html#.geometry_loclists">module:g.geometry_loclists</a> and names not corresponding are discarded.<br>
     Each administrative level is stored in a different Object.
          <br>
Processing triggered in <a href="module-module_datacheck.html#~dataprocessing">module:module_datacheck~dataprocessing</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_read"><span class="type-signature static">static,constant</span>module:g.medical_read<span class="type-signature type object.<string, object>">Object.&lt;String, Object></span> </h4>
    
        
          <span class="type-signature">
            dev-defined
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Lists the keys from <a href="module-g.html#.medical_headerlist">module:g.medical_headerlist</a> that require custom parsing (eg. translate numbers into words).<br>
     Each element in the object is coded in the following way:
     <pre><em>key_in_dashboard</em>: {<em>category1_in_medicaldata</em>: '<em>user-readable_output1</em>', <em>category2_in_medicaldata</em>: '<em>user-readable_output2</em>', ...},</pre>
     <br>
     Currently implemented keys are:
     <ul>
        <li><code>sexpreg</code> which is a combination of <code>sex</code> and <code>preg</code> from the key list,</li>
        <li><code>sev</code>,</li>
        <li><code>dur</code>,</li>
        <li><code>out</code>,</li>
        <li><code>fyo</code>,</li>
    </ul></p>
    </div>
    
    
<dl class="details">
    
        
    <dt class="tag-todo">TODO</dt>
    <dd class="tag-todo">
        <ul>
            <li>Why is it in a function?</li>
        </ul>
    </dd>
    
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_weeklist"><span class="type-signature static">static</span>module:g.medical_weeklist<span class="type-signature type array">Array</span> </h4>
    
        
          <span class="type-signature">
            module-datacheck
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores the list of weeks from <code>epiwk</code> fields of <a href="module-g.html#.medical_data">module:g.medical_data</a>.
     <br>
Processing triggered in <a href="module-module_datacheck.html#~dataprocessing">module:module_datacheck~dataprocessing</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".medical_yearlist"><span class="type-signature static">static</span>module:g.medical_yearlist<span class="type-signature type array">Array</span> </h4>
    
        
          <span class="type-signature">
            module-datacheck
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores the list of years from <code>epiwk</code> fields of <a href="module-g.html#.medical_data">module:g.medical_data</a>.
     <br>
Processing triggered in <a href="module-module_datacheck.html#~dataprocessing">module:module_datacheck~dataprocessing</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".module_chartwarper"><span class="type-signature static">static</span>module:g.module_chartwarper<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            module-chartwarper
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores all the global variables used by the <a href="module-module_chartwarper.html">module:module_chartwarper</a>. To simplify, variables in the 'sub-module' domain will only appear there.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".module_colorscale"><span class="type-signature static">static</span>module:g.module_colorscale<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            module-colorscale
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores all the global variables used by the <a href="module-module_colorscale.html">module:module_colorscale</a>. To simplify, variables in the 'sub-module' domain will only appear there.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".module_datatable"><span class="type-signature static">static</span>module:g.module_datatable<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            module-datatable
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores all the global variables used by the <a href="module-module_datatable.html">module:module_datatable</a>. To simplify, variables in the 'sub-module' domain will only appear there.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".module_interface"><span class="type-signature static">static</span>module:g.module_interface<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores all the global variables used by the <a href="module-module_interface.html">module:module_interface</a>. To simplify, variables in the 'sub-module' domain will only appear there.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".module_intro"><span class="type-signature static">static</span>module:g.module_intro<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            module-intro
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores all the global variables used by the <a href="module-module_intro.html">module:module_intro</a>. To simplify, variables in the 'sub-module' domain will only appear there.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".module_lang"><span class="type-signature static">static</span>module:g.module_lang<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            module-lang
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores all the global variables used by the <a href="module-module_lang.html">module:module_lang</a>. To simplify, variables in the 'sub-module' domain will only appear there.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".module_multiadm"><span class="type-signature static">static</span>module:g.module_multiadm<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            module-multiadm
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores all the global variables used by the <a href="module-module_multiadm.html">module:module_multiadm</a>. To simplify, variables in the 'sub-module' domain will only appear there.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".population_bypass"><span class="type-signature static">static,constant</span>module:g.population_bypass<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Checks whether <a href="module-g.html#.population_filelist">module:g.population_filelist</a> has been defined or not, and thus decide whether necessary to bypass the population data parsing step.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".population_data"><span class="type-signature static">static,constant</span>module:g.population_data<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores population data parsed from the files in g.population_filelist and by the function <a href="module-main_loadfiles.html#~queue_population">module:main_loadfiles~queue_population</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".population_filelist"><span class="type-signature static">static,constant</span>module:g.population_filelist<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            dev-defined
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Gives the population file when provided locally and give its address. If <code>pop</code> is included in <a href="module-g.html#.medical_headerlist">module:g.medical_headerlist</a> there must be a corresponding population file here.<br>
 The element is coded in the following way:
 <pre><em>pop</em>: '<em>./data/pop.csv</em>'</pre></p>
    </div>
    
    
<dl class="details">
    
        
    <dt class="tag-todo">TODO</dt>
    <dd class="tag-todo">
        <ul>
            <li>Should be rethought via a data parser that can take either files or request files via APIs.</li>
        </ul>
    </dd>
    
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".population_headerlist"><span class="type-signature static">static,constant</span>module:g.population_headerlist<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            dev-defined
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Lists the keys used to refer to specific <a href="module-g.html#.population_data">module:g.population_data</a> fields. It makes the link between headers in the data files and unambiguous keys used in the code.<br>
 Each element in the object is coded in the following way:
 <pre><em>key_in_dashboard</em>: '<em>header_in_datafile</em>',</pre>
 <br>
 Currently implemented keys are:
 <ul>
    <li><code>admNx</code> for administrative or medical division name, format: <code>Adm1_name, Adm2_name...</code>,</li>
    <li><code>pop</code> for population.</li>
</ul></p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".population_keylist"><span class="type-signature static">static,constant</span>module:g.population_keylist<span class="type-signature type object.<array.<string>>">Object.&lt;Array.&lt;String>></span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores keys of each administrative level extracted from the <a href="module-g.html#.population_filelist">module:g.population_filelist</a>.
              <br>
Processing triggered in <a href="module-main_loadfiles.html#~read_commons">module:main_loadfiles~read_commons</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".population_loclists"><span class="type-signature static">static,constant</span>module:g.population_loclists<span class="type-signature type object.<array.<string>>">Object.&lt;Array.&lt;String>></span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores the name of the administrative elements extracted from <a href="module-g.html#.population_data">module:g.population_data</a>. Names should already be formatted in the following way: <code>'AdmN0', 'AdmN1',...</code> in the source file in order to manage efficiently pyramids and possible duplicates at lowest administrative levels.<br>
         Each administrative level is stored in a different Object.
              <br>
Processing triggered in <a href="module-main_loadfiles.html#~read_commons">module:main_loadfiles~read_commons</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".population_popdata"><span class="type-signature static">static,constant</span>module:g.population_popdata<span class="type-signature type object.<array.<string>>">Object.&lt;Array.&lt;String>></span> </h4>
    
        
          <span class="type-signature">
            main-loadfiles
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Restores population figures from <a href="module-g.html#.population_data">module:g.population_data</a> in order that each administrative level is stored in a different Object.
              <br>
Processing triggered in <a href="module-main_loadfiles.html#~read_commons">module:main_loadfiles~read_commons</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".viz_currentvalues"><span class="type-signature static">static</span>module:g.viz_currentvalues<span class="type-signature type object">Object</span> </h4>
    
        
          <span class="type-signature">
            main-core
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores values currently displayed on the map. One object per administrative division.
                 <br>Defined in <a href="module-main_core.html#~chartBuilder">module:main_core~chartBuilder</a> &gt; <code>multiadm</code> and populated by <a href="module-main_core.html#~valueAccessor">module:main_core~valueAccessor</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".viz_definition"><span class="type-signature static">static,constant</span>module:g.viz_definition<span class="type-signature type object.<object>">Object.&lt;Object></span> </h4>
    
        
          <span class="type-signature">
            dev-defined
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Lists the charts and maps to be produced by module:main-core as well as defines their main characteristics.<br>
 Each element in the object contains the following sub-elements:</p>
<pre class="prettyprint source"><code> chart_id:  {

    // Defined by the developer:
    domain_type: {String},             // 'custom_ordinal' or 'custom_linear' or 'none', 
    chart_type: {String},              // 'bar' or 'multiadm' or 'row' or 'stackedbar' or 'pie' or 'series' or 'table',
    dimension_type: {String},          // 'auto' or 'custom' or 'shared', 
    dimension_setup: {Array},          // [chart_id or dimkey,'auto' ot 'custom'] (mandatory if 'shared'),
    group_type: {String},              // 'auto' or 'custom' or 'none',
    group_setup: {Array},              // [datakey,datakeyopt] ('datakey' mandatory if 'surveillance', 'datakeyopt' if 'stackedbar'),
    display_axis: {Object},            // {x:'labelx',y:'labely'} (for x/y-type charts),
    display_colors: {Array.&lt;Integer>}, // Refers to colors in g.color_domain,            
    display_intro: {String},           // 'top' or 'bottom' or 'right' or 'left' or 'none',
    display_idcontainer: {String},     // To display buttons on a div different from: chart-'chart_id' 
    buttons_list: {Array.&lt;String>},    // ['reset','help'] - any, all or none of the two for most of charts plus 'expand','lockcolor' and 'parameters' for 'multiadm' charts,
    sync_to: {Array.&lt;String>},         // ['chart_id's] - sync filtering with other charts

    // Processed by the dashboard:
    chart: {Object},                   // module:main\_core~chartInstancer & module:main\_core~chartBuilder
    dimension: {Object},               // module:main\_core~dimensionBuilder
    domain: {Array},                   // module:main\_core~domainBuilder
    group: {Object},                   // module:main\_core~groupBuilder

 }</code></pre><p> <br>
 Each element is detailed in the following.</p>
<ul>
    <li><code>chart_id</code>, 'chart-'<code>chart_id</code> must match a <code>div id</code> in the <em>index.html</em> file (the dashboard layout).</li>
    <li><code>domain_type</code> Definitions in: <a href="module-main_core.html#~domainBuilder">module:main_core~domainBuilder</a>.
    <br>If =/= <code>'none'</code>, a custom domain is built. The <code>chart_id</code> is used to select the domain building method.</li>
    <br>
    <li><code>chart_type</code> Definitions in: <a href="module-main_core.html#~chartInstancer">module:main_core~chartInstancer</a> and  <a href="module-main_core.html#~chartBuilder">module:main_core~chartBuilder</a> (neither of these are properly declared as a method...).</li>
    <br>
    <li><code>dimension_type</code> Can be: 'auto' or 'custom' or 'shared' - Definitions in <a href="module-main_core.html#~dimensionBuilder">module:main_core~dimensionBuilder</a>.
    <ul> 
        <li>If == <code>'auto'</code> - the dimension is assumed not to be shared - that means that <code>'auto'</code> is the dimension building method and <code>chart_id</code> is used to select the field to filter in <a href="module-g.html#.medical_data">module:g.medical_data</a>.</li>

        <li>If == <code>'custom'</code>  - the dimension is assumed not to be shared - that means that <code>'chart_id'</code> is the dimension building method and it is used as well to select the field to filter in <a href="module-g.html#.medical_data">module:g.medical_data</a> (when not overridden by the dimension builder definition).</li>

        <li>If == <code>'shared'</code> - <code>dimension_setup</code> parameter is compulsory.
            <ul>
                <li><code>dimension_setup[0]</code> is the <code>chart_id</code> of the chart with which the dimension is shared or the common identifier for the dimension</li>
                <li><code>dimension_setup[1]</code> can be <code>'auto'</code> or <code>'custom'</code> (just like a non-'shared' dimension...)
                    <ul> 
                        <li>If == <code>'auto'</code> that means that <code>'auto'</code> is the dimension building method and <code>dimension_setup[0]</code> is used to select the field to filter in <a href="module-g.html#.medical_data">module:g.medical_data</a>.</li>

                        <li>If == <code>'custom'</code> that means that <code>dimension_setup[0]</code> is the dimension building method and it is used as well to select the field to filter in <a href="module-g.html#.medical_data">module:g.medical_data</a> (when not overridden by the dimension builder definition).</li>
                </li>
            </ul>
        </li>
    </ul>
    Classical dimensions are stored under <code>[chart_id].dimension</code> in the <a href="module-g.html#.viz_definition">module:g.viz_definition</a> object. Whereas shared dimensions are stored under <code>[dimension_setup[0]].dimension</code>.
    </li>
    <br>
    <li><code>group_type</code> Can be: 'auto' or 'custom' or 'shared' (or 'none' for the data table) - Definitions in <a href="module-main_core.html#~groupBuilder">module:main_core~groupBuilder</a>.
    <br>
    <ul> 
        <li>If == <code>'auto'</code>, that means that <code>'auto'</code> is the group building method.</li>

        <li>If == <code>'custom'</code>, that means that <code>'chart_type'</code> is the group building method.</li>
    </ul>
    Groups building instruction are specific to each <a href="module-g.html#.medical_datatype">module:g.medical_datatype</a>.
    If <a href="module-g.html#.medical_datatype">module:g.medical_datatype</a> == <code>'surveillance'</code> - <code>group_setup</code> parameter is compulsory. It is an Array where:
    <ul>
        <li><code>group_setup[0]</code> is used to select the field to count or sum in <a href="module-g.html#.medical_data">module:g.medical_data</a>. NB: In a <code>'outbreak'</code> setting, records are counted from the patient list without a reference to a field.</li>
        <li><code>group_setup[1]</code> is used to select the field to create categories for stacked charts (<code>chart_type == stackedbar</code>. NB: Stacked chart have not been used yet in a <code>'outbreak'</code> setting.</li>
    </ul>
    </li><br></ul>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
        <h5>Example</h5>
        
        <p class="code-caption">Example usage for ERU Dashboard (light surveillance).</p>
    

    <pre class="prettyprint"><code>g.viz_definition = {
    multiadm: { 
        domain_type: 'none',            
        chart_type: 'multiadm',
        dimension_type: 'custom',  
        group_type: 'custom',
        group_setup: ['case'],
        display_colors: [0,1,2,3,4,5],  
        display_intro: 'bottom',
        buttons_list: ['reset','help','expand','lockcolor','parameters'],
    },
    disease:  { 
        domain_type: 'none',
        chart_type: 'row',
        dimension_type: 'custom',   
        group_type: 'custom',
        group_setup: ['case'],
        display_axis:   {
            x:g.module_lang.text[g.module_lang.current].chart_disease_labelx,
            y:g.module_lang.text[g.module_lang.current].chart_disease_labely
        },
        display_colors: [2],            
        display_intro: 'right',
        buttons_list: ['help'],
    },       
    case_bar:  {  
        domain_type: 'custom_ordinal',   
        chart_type: 'bar',
        dimension_type: 'custom',       
        dimension_setup: ['epiwk','auto','case'],
        group_type: 'auto',
        group_setup: ['case'],
        display_axis:   {
            x:g.module_lang.text[g.module_lang.current].chart_case_labelx,
            y:g.module_lang.text[g.module_lang.current].chart_case_labely
        },
        display_colors: [4,2],            
        display_intro: 'top',           
        display_idcontainer: 'chart-case_bar',
        buttons_list: ['reset','help'],
    },      
    case_lin:  {   
        domain_type: 'custom_linear',   
        chart_type: 'series',
        dimension_type: 'shared',       
        dimension_setup: ['epiwk_lin','custom','case'],
        group_type: 'auto',
        group_setup: ['case'],
        display_axis:   {
            x:g.module_lang.text[g.module_lang.current].chart_case_labelx,
            y:g.module_lang.text[g.module_lang.current].chart_case_labely
        },
        display_colors: [4,2],            
        display_intro: 'top',           
        display_idcontainer: 'chart-case_lin',
        buttons_list: ['help'],
    },
    year:    {   
        domain_type: 'none',            
        chart_type: 'pie',
        dimension_type: 'custom',       
        group_setup: ['case'],
        group_type: 'auto',
        display_intro: 'left',
        display_idcontainer: 'chart-year',
        buttons_list: ['reset','help'],
    },
    table:  {   
        domain_type: 'none',            
        chart_type: 'table',
        dimension_type: 'custom',       
        group_type: 'none',
        display_intro: 'top',
        buttons_list: ['help'],
    }
};</code></pre>
    

</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".viz_keylist"><span class="type-signature static">static</span>module:g.viz_keylist<span class="type-signature type array">Array</span> </h4>
    
        
          <span class="type-signature">
            main-core
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Lists <code>id_chart</code> from <a href="module-g.html#.viz_definition">module:g.viz_definition</a> (defined in de/dev-defined.js).</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".viz_timeline"><span class="type-signature static">static,constant</span>module:g.viz_timeline<span class="type-signature type string">String</span> </h4>
    
        
          <span class="type-signature">
            dev-defined
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Defines the chart used as a reference for time-related interactions.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".viz_timeshare"><span class="type-signature static">static,constant</span>module:g.viz_timeshare<span class="type-signature type array.<string>">Array.&lt;String></span> </h4>
    
        
          <span class="type-signature">
            dev-defined
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Defines the charts that are using time dimensions and that should be synchronized with the reference defined with <a href="module-g.html#.viz_timeline">module:g.viz_timeline</a>.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        </dl>
    
    
</article>

</section>  


        <footer>
            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Tue Jun 14 2016 17:08:53 GMT+0200 (CEST)
        </footer>
    </div>
</div>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/main.js"></script>
</body>
</html>