module-module_interface.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-module_interface.html">Module: module_interface</h1>
        

<section>
    
<header>
    <h2>
    module_interface
    </h2>
    
</header>  

<article>
    <div class="container-overview">
    
    
            <div class="description"><p>This file permits the creation of interface elements: a lateral menu and quick access buttons for each chart-map. The module defines the appearance as well as the behavior of each menu.
 <br></p></div>
        
        
<dl class="details">
    
        
    <dt class="tag-since">Since:</dt>
    <dd class="tag-since"><ul class="dummy"><li>0.3</dd>
    

</dl>

        
    </div>
    
    
        <h3 class="subsection-title">Requires</h3>
        
        <ul>
            <li>module:index.html</li>
        
            <li>module:dev/dev-defined.js</li>
        
            <li>module:js/main-loadfiles.js</li>
        
            <li>module:js/module-datacheck.js</li>
        
            <li>module:lang/module-lang.js</li>
        
            <li>module:lang/main-core.js</li>
        </ul>
    
    
        <h3 class="subsection-title">Members</h3>
        
        <dl>
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".autoplayon"><span class="type-signature static">static,constant</span>module:module_interface.autoplayon<span class="type-signature type boolean">Boolean</span> </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Stores the indicator of whether the dashboard is on play mode or not.
<br> Defined in module:module_interface.menuinteractions.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".autoplaytime"><span class="type-signature static">static,constant</span>module:module_interface.autoplaytime<span class="type-signature type integer">Integer</span> </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Sets the time for the dashboard play mode.
<br> Defined in module:module_interface.menuinteractions.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".autoplaytimer"><span class="type-signature static">static,constant</span>module:module_interface.autoplaytimer<span class="type-signature type integer">Integer</span> </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Sets the timer for the dashboard play mode.
<br> Defined in module:module_interface.menuinteractions.</p>
    </div>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        </dl>
    
    
        <h3 class="subsection-title">Methods</h3>
        
        <dl>
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".display">
            
            <span class="type-signature static">static</span>module:module_interface.display<span class="signature">()</span>
        </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Runs through all the chars/maps to: 
 <ul>
    <li>add titles module:module_interface.titlesscreate,</li>
    <li>defines the associated buttons module:module_interface.buttonscreate (from <a href="module-g.html#.viz_definition">module:g.viz_definition</a> <code>buttons_list</code>) and associated interactions module:module_interface.buttoninteraction,</li>
    <li>defines the lateral menu buttons module:module_interface.menucreate and associated interactions module:module_interface.menuinteractions.</li>
</ul>
<br>
Requires:</p>
<p><ul>
 <li><a href="module-module_lang.html#.text">module:module_lang.text</a></li>
 <li><a href="module-module_lang.html#.current">module:module_lang.current</a></li>
 <li><a href="module-g.html#.viz_keylist">module:g.viz_keylist</a></li>
 <li><a href="module-g.html#.viz_definition">module:g.viz_definition</a></li>
 <li><a href="module-g.html#.viz_timeshare">module:g.viz_timeshare</a></li>
 <li><a href="module-g.html#.viz_timeline">module:g.viz_timeline</a></li>
 <li><a href="module-module_interface.html#.menu_pausePlay">module:module_interface.menu_pausePlay</a></li>
 <li>module:menu_autoPlay</li>
 <li><a href="module-g.html#.geometry_keylist">module:g.geometry_keylist</a></li>
 <li>module:zoomToGeom</li>
 <li><a href="module-g.html#.geometry_data">module:g.geometry_data</a></li>
 <li><a href="module-module_intro.html#.definition">module:module_intro.definition</a></li>
 <li><a href="module-module_intro.html#.step">module:module_intro.step</a></li>
 <li><a href="module-g.html#.medical_datatype">module:g.medical_datatype</a></li>
 <li><a href="module-module_colorscale.html#.display">module:module_colorscale.display</a></li>
 <li><a href="module-module_colorscale.html#.interaction">module:module_colorscale.interaction</a></li>
 <li><a href="module-module_colorscale.html#.lockcolor">module:module_colorscale.lockcolor</a></li>
 <li>module:g.module_colorscale.modecurrent</li>
</ul>
Intermediaries:</p>
<p><ul>
 <li>module:module_interface.titlesscreate</li>
 <li>module:module_interface.buttonscreate</li>
 <li>module:module_interface.buttoninteraction</li>
 <li>module:module_interface.menucreate</li>
 <li>module:module_interface.menuinteractions</li>
</ul>
Returns:</p>
<p><ul>
 <li>module:g.module_interface.autoplayon</li>
 <li>module:g.module_interface.autoplaytime</li>
 <li>module:g.module_interface.autoplaytimer</li>
</ul>
<br> Triggered by the end of <a href="module-main_core.html#~generateDashboard">module:main_core~generateDashboard</a>.</p>
    </div>
    

<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".menu_autoPlay">
            
            <span class="type-signature static">static</span>module:module_interface.menu_autoPlay<span class="signature">()</span>
        </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Defines the dashboard auto play mode.
<br>
Requires:</p>
<p><ul>
 <li><a href="module-module_interface.html#.autoplaytime">module:module_interface.autoplaytime</a></li>
 <li><a href="module-g.html#.viz_definition">module:g.viz_definition</a></li>
 <li><a href="module-g.html#.viz_timeline">module:g.viz_timeline</a></li>
 <li><a href="module-g.html#.viz_timeshare">module:g.viz_timeshare</a></li>
 <li><a href="module-module_interface.html#.menu_pausePlay">module:module_interface.menu_pausePlay</a></li>
 <li><a href="module-g.html#.viz_timeline">module:g.viz_timeline</a></li>
</ul>
<br> Triggered in <a href="module-module_interface.html#~menuinteractions">module:module_interface~menuinteractions</a>.</p>
    </div>
    

<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".menu_pausePlay">
            
            <span class="type-signature static">static</span>module:module_interface.menu_pausePlay<span class="signature">()</span>
        </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Defines the function to quit the dashboard auto play mode.
<br>
Requires:</p>
<p><ul>
 <li><a href="module-module_interface.html#.autoplayon">module:module_interface.autoplayon</a></li>
 <li><a href="module-module_interface.html#.autoplaytimer">module:module_interface.autoplaytimer</a></li>
 <li><a href="module-module_lang.html#.text">module:module_lang.text</a></li>
 <li><a href="module-module_lang.html#.current">module:module_lang.current</a></li>
 <li><a href="module-g.html#.viz_timeline">module:g.viz_timeline</a></li>
 <li><a href="module-g.html#.viz_timeshare">module:g.viz_timeshare</a></li>
 <li><a href="module-g.html#.viz_definition">module:g.viz_definition</a></li>
</ul>
<br> Triggered in various functions of <a href="module-module_interface.html">module:module_interface</a>.</p>
    </div>
    

<dl class="details">
    
        
    <dt class="tag-todo">TODO</dt>
    <dd class="tag-todo">
        <ul>
            <li>Rename 'Stop'?</li>
        </ul>
    </dd>
    
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".menu_reset">
            
            <span class="type-signature static">static</span>module:module_interface.menu_reset<span class="signature">()</span>
        </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Defines the reset all function.
<br>
Requires:</p>
<p><ul>
 <li>module:g.module_colorscale.modecurrent</li>
 <li><a href="module-g.html#.medical_currentdisease">module:g.medical_currentdisease</a></li>
 <li><a href="module-module_interface.html#.menu_pausePlay">module:module_interface.menu_pausePlay</a></li>
 <li><a href="module-g.html#.geometry_keylist">module:g.geometry_keylist</a></li>
 <li>module:zoomToGeom</li>
 <li><a href="module-g.html#.geometry_data">module:g.geometry_data</a></li>
 <li><a href="module-g.html#.viz_definition">module:g.viz_definition</a></li>
 <li><a href="module-g.html#.medical_datatype">module:g.medical_datatype</a></li>
 <li>module:g.module_colorscale.mapunitcurrent</li>
 <li>module:g.medical_pastdisease</li>
 <li><a href="module-module_colorscale.html#.lockcolor">module:module_colorscale.lockcolor</a></li>
</ul>
Returns:</p>
<p><ul>
 <li>module:g.medical_pastdisease (? To be checked)</li>
</ul>
<br> Triggered in module:module:module_interface~menucreate.</p>
    </div>
    

<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id="~buttoninteraction">
            
            <span class="type-signature ">inner</span>buttoninteraction<span class="signature">(key1, buttons)</span>
        </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Defines the interactions that comes with the buttons created in <a href="module-module_interface.html#~buttonscreate">module:module_interface~buttonscreate</a>.
     <br> List of currenly implemented buttons:
     <ul>
        <li><code>reset</code> which resets the the filters applying on the current chart,</li>
        <li><code>help</code> which displays the quick help implemented with <a href="module-module_intro.html">module:module_intro</a> and <a href="module-module_lang.html">module:module_lang</a>,</li>
        <li><code>parameters</code> which displays the map parameters implemented with <a href="module-module_colorscale.html">module:module_colorscale</a>,</li>
        <li><code>expand</code> which doubles the height of the map container,</li>
        <li><code>lockcolor</code> which triggers the colorscale auto adjustment with <a href="module-module_colorscale.html#.lockcolor">module:module_colorscale.lockcolor</a>.</li>
     </ul>
<br>
Requires:</p>
<p><ul>
 <li><a href="module-g.html#.viz_timeline">module:g.viz_timeline</a></li>
 <li><a href="module-module_interface.html#.menu_pausePlay">module:module_interface.menu_pausePlay</a></li>
 <li>module:zoomToGeom</li>
 <li><a href="module-g.html#.geometry_data">module:g.geometry_data</a></li>
 <li><a href="module-g.html#.geometry_keylist">module:g.geometry_keylist</a></li>
 <li><a href="module-g.html#.viz_definition">module:g.viz_definition</a></li>
 <li><a href="module-module_intro.html#.definition">module:module_intro.definition</a></li>
 <li><a href="module-module_intro.html#.step">module:module_intro.step</a></li>
 <li><a href="module-g.html#.medical_datatype">module:g.medical_datatype</a></li>
 <li><a href="module-module_colorscale.html#.display">module:module_colorscale.display</a></li>
 <li><a href="module-module_colorscale.html#.interaction">module:module_colorscale.interaction</a></li>
 <li><a href="module-module_colorscale.html#.lockcolor">module:module_colorscale.lockcolor</a></li>
</ul>
<br> Triggered in <a href="module-module_interface.html#.display">module:module_interface.display</a>.</p>
    </div>
    

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>key1</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            </td>
            
            
            <td class="description last">
                
                <p>Typically from <a href="module-g.html#.viz_keylist">module:g.viz_keylist</a></p></td>
        </tr>
	
	
        <tr>
            
                <td class="name"><code>buttons</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Array</span>


            </td>
            
            
            <td class="description last">
                
                <p>Typically from <a href="module-g.html#.viz_definition">module:g.viz_definition</a> <code>buttons_list</code></p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id="~buttonscreate">
            
            <span class="type-signature ">inner</span>buttonscreate<span class="signature">(key, buttons)</span>
        </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Creates buttons, from the lists in <a href="module-g.html#.viz_definition">module:g.viz_definition</a> <code>buttons_list</code>.
<br> Triggered in <a href="module-module_interface.html#.display">module:module_interface.display</a>.</p>
    </div>
    

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>key</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            </td>
            
            
            <td class="description last">
                
                <p>Typically from <a href="module-g.html#.viz_keylist">module:g.viz_keylist</a></p></td>
        </tr>
	
	
        <tr>
            
                <td class="name"><code>buttons</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Array</span>


            </td>
            
            
            <td class="description last">
                
                <p>Typically from <a href="module-g.html#.viz_definition">module:g.viz_definition</a> <code>buttons_list</code></p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id="~menucreate">
            
            <span class="type-signature ">inner</span>menucreate<span class="signature">()</span>
        </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Defines the lateral menu layout.
     <br> Returns the html code as a string.
<br>
Requires:</p>
<p><ul>
 <li><a href="module-module_lang.html#.text">module:module_lang.text</a></li>
 <li><a href="module-module_lang.html#.current">module:module_lang.current</a></li>
</ul>
<br> Triggered in <a href="module-module_interface.html#.display">module:module_interface.display</a>.</p>
    </div>
    

<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id="~menuinteractions">
            
            <span class="type-signature ">inner</span>menuinteractions<span class="signature">()</span>
        </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Defines the interactions associated with the lateral menu buttons created in <a href="module-module_interface.html#~menucreate">module:module_interface~menucreate</a>: 'Play', 'Help' and 'N-epiwk Quick access'.
<br>
Requires:</p>
<p><ul>
 <li><a href="module-module_interface.html#.menu_pausePlay">module:module_interface.menu_pausePlay</a></li>
 <li><a href="module-g.html#.viz_definition">module:g.viz_definition</a></li>
 <li><a href="module-g.html#.viz_timeline">module:g.viz_timeline</a></li>
 <li><a href="module-g.html#.viz_timeshare">module:g.viz_timeshare</a></li>
 <li><a href="module-module_colorscale.html#.lockcolor">module:module_colorscale.lockcolor</a></li>
 <li><a href="module-module_lang.html#.text">module:module_lang.text</a></li>
 <li><a href="module-module_lang.html#.current">module:module_lang.current</a></li>
 <li>module:g.module_intro.definition</li>
 <li>module:g.module_colorscale.modecurrent</li>
</ul>
Returns:</p>
<p><ul>
 <li>module:g.module_interface.autoplayon</li>
 <li>module:g.module_interface.autoplaytime</li>
 <li>module:g.module_interface.autoplaytimer</li>
</ul>
<br> Triggered in <a href="module-module_interface.html#.display">module:module_interface.display</a>.</p>
    </div>
    

<dl class="details">
    
        
</dl>

    
</dd>

        
<dt>
    <div class="nameContainer">
        <h4 class="name" id="~titlesscreate">
            
            <span class="type-signature ">inner</span>titlesscreate<span class="signature">(key)</span>
        </h4>
    
        
          <span class="type-signature">
            module-interface
          </span>
        
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Adds titles and space to display current filters to the charts.
<br>
Requires:</p>
<p><ul>
 <li><a href="module-module_lang.html#.text">module:module_lang.text</a></li>
 <li><a href="module-module_lang.html#.current">module:module_lang.current</a></li>
</ul>
<br> Triggered in <a href="module-module_interface.html#.display">module:module_interface.display</a>.</p>
    </div>
    

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>key</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            </td>
            
            
            <td class="description last">
                
                <p>Typically from <a href="module-g.html#.viz_keylist">module:g.viz_keylist</a></p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
<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:54 GMT+0200 (CEST)
        </footer>
    </div>
</div>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/main.js"></script>
</body>
</html>