Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix JSDoc doxygen workflow and update JSDoc #149

Closed
wants to merge 1 commit into from
Closed

Fix JSDoc doxygen workflow and update JSDoc #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 .github/worflows/doxygen-pdf.yml → .github/workflows/doxygen-pdf.yml
View file
Open in desktop
File renamed without changes.
7,285 changes: 5,287 additions & 1,998 deletions docs/HIVTxNetwork.html
View file
Open in desktop

Large diffs are not rendered by default.

5,566 changes: 0 additions & 5,566 deletions docs/classes.list.html
View file
Open in desktop

This file was deleted.

7,758 changes: 7,758 additions & 0 deletions docs/clusternetwork.js.html
View file
Open in desktop

Large diffs are not rendered by default.

1,984 changes: 1,984 additions & 0 deletions docs/clustersOfInterest.js.html
View file
Open in desktop

Large diffs are not rendered by default.

109 changes: 109 additions & 0 deletions docs/colorPicker.js.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: colorPicker.js</title>

<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.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/jsdoc-default.css">
</head>

<body>

<div id="main">

<h1 class="page-title">Source: colorPicker.js</h1>






<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* Creates a color picker input element with a label.

* @param {string} id - The ID for the color picker input element.
* @param {Function} colorizer - A colorizer function that maps values to colors.

* @returns {string} The HTML markup for the color picker input element with the label.
*/

function colorPickerInput(id, colorizer) {
// set onchange event after template is rendered and returned from this function.
let colorPicker = `&lt;div class="col-lg-2 hivtrace-color-picker">
&lt;input type="color" name="${id}" value="${colorizer.category(id)}">
&lt;label for="${id}">${id}&lt;/label>
&lt;/div>`;

return colorPicker;
}

/**
* Creates a color picker input element with a label for continuous values.

* @param {string} id - The ID for the color picker input element.
* @param {string} color - The initial color value for the color picker.

* @returns {string} The HTML markup for the color picker input element with the label.
*/

function colorPickerInputContinuous(id, color) {
// set onchange event after template is rendered and returned from this function.
let colorPicker = `&lt;div class="col-lg-2 hivtrace-color-picker">
&lt;input type="color" name="${id.toLowerCase()}" value="${color}">
&lt;label for="${id.toLowerCase()}">${id}&lt;/label>
&lt;/div>`;

return colorPicker;
}

/**
* Creates a color stop input element with a label.

* @param {string} id - The ID for the color stop input element.
* @param {number} number - The initial value for the color stop.

* @returns {string} The HTML markup for the color stop input element with the label.
*/

function colorStops(id, number) {
// set onchange event after template is rendered and returned from this function.
let colorStops = `&lt;div class="col-lg-2 hivtrace-color-stops">
&lt;label for="color-stop">${id}&lt;/label>
&lt;input type="number" name="color-stop" value="${number}" min="0" max="20"">
&lt;/div>`;

return colorStops;
}

export { colorPickerInput, colorPickerInputContinuous, colorStops };
</code></pre>
</article>
</section>




</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="HIVTxNetwork.html">HIVTxNetwork</a></li><li><a href="hivtrace_generate_svg_polygon.html">hivtrace_generate_svg_polygon</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CDCCOICanAutoExpand">CDCCOICanAutoExpand</a></li><li><a href="global.html#CDCCOIConciseTrackingOptions">CDCCOIConciseTrackingOptions</a></li><li><a href="global.html#CDCCOICreatedBySystem">CDCCOICreatedBySystem</a></li><li><a href="global.html#CDCCOICreatedManually">CDCCOICreatedManually</a></li><li><a href="global.html#CDCCOIKind">CDCCOIKind</a></li><li><a href="global.html#CDCCOIKindAutomaticCreation">CDCCOIKindAutomaticCreation</a></li><li><a href="global.html#CDCCOINodeKind">CDCCOINodeKind</a></li><li><a href="global.html#CDCCOINodeKindDefault">CDCCOINodeKindDefault</a></li><li><a href="global.html#CDCCOITrackingOptions">CDCCOITrackingOptions</a></li><li><a href="global.html#CDCCOITrackingOptionsDateFilter">CDCCOITrackingOptionsDateFilter</a></li><li><a href="global.html#CDCCOITrackingOptionsDefault">CDCCOITrackingOptionsDefault</a></li><li><a href="global.html#CDCCOITrackingOptionsDistanceFilter">CDCCOITrackingOptionsDistanceFilter</a></li><li><a href="global.html#CDCCOITrackingOptionsNone">CDCCOITrackingOptionsNone</a></li><li><a href="global.html#CDCJurisdictionCodes">CDCJurisdictionCodes</a></li><li><a href="global.html#CDCJurisdictionLowMorbidity">CDCJurisdictionLowMorbidity</a></li><li><a href="global.html#CDCNPMember">CDCNPMember</a></li><li><a href="global.html#Categorical">Categorical</a></li><li><a href="global.html#DateFormats">DateFormats</a></li><li><a href="global.html#DateUpperBoundYear">DateUpperBoundYear</a></li><li><a href="global.html#DateViewFormat">DateViewFormat</a></li><li><a href="global.html#DateViewFormatClusterCreate">DateViewFormatClusterCreate</a></li><li><a href="global.html#DateViewFormatShort">DateViewFormatShort</a></li><li><a href="global.html#DateViewFormatSlider">DateViewFormatSlider</a></li><li><a href="global.html#EdgeColorBase">EdgeColorBase</a></li><li><a href="global.html#MaximumValuesInCategories">MaximumValuesInCategories</a></li><li><a href="global.html#PresetColorSchemes">PresetColorSchemes</a></li><li><a href="global.html#PresetShapeSchemes">PresetShapeSchemes</a></li><li><a href="global.html#SequentialColor">SequentialColor</a></li><li><a href="global.html#ShapeOrdering">ShapeOrdering</a></li><li><a href="global.html#SubclusterSeparator">SubclusterSeparator</a></li><li><a href="global.html#_action_drop_down">_action_drop_down</a></li><li><a href="global.html#add_a_sortable_table">add_a_sortable_table</a></li><li><a href="global.html#b64toBlob">b64toBlob</a></li><li><a href="global.html#cluster_time_scale">cluster_time_scale</a></li><li><a href="global.html#collapseLargeCategories">collapseLargeCategories</a></li><li><a href="global.html#colorPickerInput">colorPickerInput</a></li><li><a href="global.html#colorPickerInputContinuous">colorPickerInputContinuous</a></li><li><a href="global.html#colorStops">colorStops</a></li><li><a href="global.html#copyToClipboard">copyToClipboard</a></li><li><a href="global.html#d3">d3</a></li><li><a href="global.html#datamonkey_describe_vector">datamonkey_describe_vector</a></li><li><a href="global.html#datamonkey_export_csv_button">datamonkey_export_csv_button</a></li><li><a href="global.html#datamonkey_export_handler">datamonkey_export_handler</a></li><li><a href="global.html#datamonkey_export_json_button">datamonkey_export_json_button</a></li><li><a href="global.html#datamonkey_save_image">datamonkey_save_image</a></li><li><a href="global.html#draw_priority_set_table">draw_priority_set_table</a></li><li><a href="global.html#edge_typer">edge_typer</a></li><li><a href="global.html#ensure_node_attributes_exist">ensure_node_attributes_exist</a></li><li><a href="global.html#exportColorScheme">exportColorScheme</a></li><li><a href="global.html#filter_parse">filter_parse</a></li><li><a href="global.html#filter_table">filter_table</a></li><li><a href="global.html#filter_table_by_column_handler">filter_table_by_column_handler</a></li><li><a href="global.html#format_a_cell">format_a_cell</a></li><li><a href="global.html#formats">formats</a></li><li><a href="global.html#getUniqueValues">getUniqueValues</a></li><li><a href="global.html#get_editor">get_editor</a></li><li><a href="global.html#get_ui_element_selector_by_role">get_ui_element_selector_by_role</a></li><li><a href="global.html#handle_cluster_click">handle_cluster_click</a></li><li><a href="global.html#handle_inline_confirm">handle_inline_confirm</a></li><li><a href="global.html#hiv_trace_export_table_to_text">hiv_trace_export_table_to_text</a></li><li><a href="global.html#hivtraceClusterGraphSummary">hivtraceClusterGraphSummary</a></li><li><a href="global.html#hivtrace_cluster_depthwise_traversal">hivtrace_cluster_depthwise_traversal</a></li><li><a href="global.html#hivtrace_coi_timeseries">hivtrace_coi_timeseries</a></li><li><a href="global.html#hivtrace_compute_node_degrees">hivtrace_compute_node_degrees</a></li><li><a href="global.html#hivtrace_date_or_na_if_missing">hivtrace_date_or_na_if_missing</a></li><li><a href="global.html#hivtrace_generate_svg_symbol">hivtrace_generate_svg_symbol</a></li><li><a href="global.html#hivtrace_histogram">hivtrace_histogram</a></li><li><a href="global.html#hivtrace_histogram_distances">hivtrace_histogram_distances</a></li><li><a href="global.html#hivtrace_plot_cluster_dynamics">hivtrace_plot_cluster_dynamics</a></li><li><a href="global.html#hivtrace_render_histogram">hivtrace_render_histogram</a></li><li><a href="global.html#hivtrace_render_histogram_continuous">hivtrace_render_histogram_continuous</a></li><li><a href="global.html#hivtrace_render_scatterplot">hivtrace_render_scatterplot</a></li><li><a href="global.html#init">init</a></li><li><a href="global.html#missing">missing</a></li><li><a href="global.html#n_months_ago">n_months_ago</a></li><li><a href="global.html#network">network</a></li><li><a href="global.html#normalize_node_attributes">normalize_node_attributes</a></li><li><a href="global.html#open_editor">open_editor</a></li><li><a href="global.html#priority_groups_add_set">priority_groups_add_set</a></li><li><a href="global.html#priority_groups_check_name">priority_groups_check_name</a></li><li><a href="global.html#priority_set_inject_node_attibutes">priority_set_inject_node_attibutes</a></li><li><a href="global.html#priority_set_view">priority_set_view</a></li><li><a href="global.html#random_id">random_id</a></li><li><a href="global.html#secure_hiv_trace_subcluster_columns">secure_hiv_trace_subcluster_columns</a></li><li><a href="global.html#sort_table_by_column">sort_table_by_column</a></li><li><a href="global.html#sort_table_toggle_icon">sort_table_toggle_icon</a></li><li><a href="global.html#table_get_cell_value">table_get_cell_value</a></li><li><a href="global.html#unpack_compact_json">unpack_compact_json</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.3</a> on Wed Oct 09 2024 12:14:37 GMT-0700 (Pacific Daylight Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Loading
Loading