add documentation

Author: benderl

src/views/Chart.vue

@@ -1183,6 +1183,11 @@ export default {
 			this.chartDate = newDate;
 			this.chartRange = newRange;
 		},
+		/**
+		 * Returns the card subtype based on the given element key.
+		 * @param {string} elementKey - The key of the element.
+		 * @returns {string} - The card subtype.
+		 */
 		getCardSubtype(elementKey) {
 			switch (elementKey) {
 				case "bat":
@@ -1199,6 +1204,12 @@ export default {
 					return "secondary";
 			}
 		},
+		/**
+		 * Returns the icon for a given element key.
+		 * @param {string} elementKey - The key of the element.
+		 * @returns {Array<string>|undefined} - The icon as an array of strings representing the icon class.
+		 * If the element key is not recognized, undefined is returned.
+		 */
 		getCardIcon(elementKey) {
 			switch (elementKey) {
 				case "bat":
@@ -1217,6 +1228,14 @@ export default {
 					return undefined;
 			}
 		},
+		/**
+		 * Hides a dataset in the chart.
+		 *
+		 * @param {Object} baseObject - The base object containing the dataset.
+		 * @param {string} objectKey - The key of the dataset to hide.
+		 * @param {string} elementKey - The key of the element.
+		 * @returns {boolean} - True if the dataset should be hidden, false otherwise.
+		 */
 		hideDataset(baseObject, objectKey, elementKey) {
 			// if dataset "all" is present, hide component datasets
 			if (["bat", "pv", "cp"].includes(baseObject)) {
@@ -1240,6 +1259,14 @@ export default {
 			}
 			return false;
 		},
+		/**
+		 * Returns the label for the totals.
+		 *
+		 * @param {string} groupKey - The key of the group.
+		 * @param {string} componentKey - The key of the component.
+		 * @param {string} measurementKey - The key of the measurement.
+		 * @returns {string} The label for the totals.
+		 */
 		getTotalsLabel(
 			groupKey,
 			componentKey = undefined,
@@ -1515,6 +1542,12 @@ export default {
 				details.length ? " (" + details.join(", ") + ")" : ""
 			}`;
 		},
+		/**
+		 * Returns the index of the dataset with the specified dataset key.
+		 *
+		 * @param {string} datasetKey - The key of the dataset to find.
+		 * @returns {number|undefined} - The index of the dataset if found, otherwise undefined.
+		 */
 		getDatasetIndex(datasetKey) {
 			let index = this.chartDatasets.datasets.findIndex((dataset) => {
 				return dataset.jsonKey == datasetKey;
@@ -1524,6 +1557,15 @@ export default {
 			}
 			return;
 		},
+		/**
+		 * Adds a dataset to the chart.
+		 *
+		 * @param {string} baseObject - The base object for the dataset.
+		 * @param {string} objectKey - The object key for the dataset.
+		 * @param {string} elementKey - The element key for the dataset.
+		 * @param {string} datasetKey - The dataset key.
+		 * @returns {number|undefined} - The index of the added dataset or undefined if no dataset was added.
+		 */
 		addDataset(baseObject, objectKey, elementKey, datasetKey) {
 			// do not add dataset if objectKey is not present in totals[baseObject]
 			if (
@@ -1583,6 +1625,13 @@ export default {
 			}
 			return;
 		},
+		/**
+		 * Initializes a dataset based on the provided parameters.
+		 *
+		 * @param {string} baseObject - The base object of the dataset.
+		 * @param {string} objectKey - The object key of the dataset.
+		 * @param {string} elementKey - The element key of the dataset.
+		 */
 		initDataset(baseObject, objectKey, elementKey) {
 			var elementKeysToAdd = [];
 			if (this.chartRange == "day") {
@@ -1631,6 +1680,10 @@ export default {
 				console.debug("skipping dataset:", datasetKey);
 			}
 		},
+		/**
+		 * Sets up the X scale for the chart.
+		 * Updates the chart options with the specified X scale properties.
+		 */
 		setupScaleX() {
 			this.chartOptions.scales.x.time.unit = this.chartScaleX.unit;
 			this.chartOptions.scales.x.time.tooltipFormat =
@@ -1639,6 +1692,10 @@ export default {
 			this.chartOptions.scales.x.ticks.maxTicksLimit =
 				this.chartScaleX.maxTicksLimit;
 		},
+		/**
+		 * Requests chart data based on the selected chart range.
+		 * If the chart form is invalid, a warning is logged and the function returns.
+		 */
 		requestChart() {
 			let myForm = document.forms["chartForm"];
 			if (!myForm.reportValidity()) {
@@ -1665,15 +1722,25 @@ export default {
 				});
 			}
 		},
+		/**
+		 * Clears the chart data by removing all topics that match the wildcard pattern.
+		 * Then, it commits the "removeTopic" mutation for each topic in the list.
+		 */
 		clearChartData() {
 			this.getWildcardIndexList(this.baseTopic + "+").forEach((topic) => {
 				this.$store.commit("removeTopic", `${this.baseTopic}${topic}`);
 			});
 		},
+		/**
+		 * Updates the chart by clearing the chart data and then requesting new chart data.
+		 */
 		updateChart() {
 			this.clearChartData();
 			this.requestChart();
 		},
+		/**
+		 * Initializes the chart by setting the current date and chart date based on the chart range and initial date.
+		 */
 		init() {
 			const today = new Date();
 			this.currentDate = String(today.getFullYear());