Added some comments for data types

Signed-off-by: Emil Balitzki <[email protected]>

frontend/src/components/MapView/MapDatasetVisualizer.tsx

@@ -96,6 +96,7 @@ const MapDatasetVisualizer: React.FC<MapDatasetVisualizerProps> = ({
    * @returns the color to use
    */
   const getColor = (usageType: string) => {
+    console.log(usageType);
     if (dataset.metaData && dataset.metaData.polygonColoring) {
       const coloring = dataset.metaData.polygonColoring;
       for (const colorRule of coloring.colors) {

frontend/src/types/LocationDataTypes.tsx

@@ -1,17 +1,26 @@
+/**
+ * A response object from the location endpoint.
+ */
 export interface LocationDataResponse {
   individualData: DatasetItem[];
   selectionData: DatasetItem[];
 }
 
-export interface SubdataItem {
-  key: string;
-  value: string;
-}
-
+/**
+ * A single dataset row visible in the data view.
+ */
 export interface DatasetItem {
   displayName: string;
   value: string | null;
   datasetID: string | null;
   coordinate: number[] | null;
   subdata: SubdataItem[];
 }
+
+/**
+ * Sub rows for the data view and the dataset row.
+ */
+export interface SubdataItem {
+  key: string;
+  value: string;
+}

frontend/src/types/MapSelectionTypes.tsx

@@ -1,7 +1,9 @@
 import { LatLng } from "leaflet";
 import { MultiPolygon } from "geojson";
 
-// Define PolygonSelection class
+/**
+ * A map selection of a polygon. Either by manualy drawing it or by search bar.
+ */
 export class PolygonSelection {
   polygon: MultiPolygon;
   displayName: string;
@@ -18,7 +20,9 @@ export class PolygonSelection {
   }
 }
 
-// An interface for a single marker selection
+/**
+ * A map selection of a single location/marker.
+ */
 export class MarkerSelection {
   marker: LatLng;
   displayName: string;

frontend/src/types/MapTypes.tsx

@@ -1,4 +1,6 @@
-// Enum for types of maps
+/**
+ * Enum for types of background maps for the map view.
+ */
 export enum MapTypes {
   Normal = "normal",
   Satellite = "satellite",

frontend/src/types/MarkersTypes.tsx

@@ -1,6 +1,11 @@
-// Enum for types of markers
+/**
+ * Enum for the types of markers for individual datasets.
+ */
 export enum MarkersTypes {
-  Markers = "markers", // Map will display single coordinates with markers on top.
-  Areas = "areas", // Map will display polygon areas.
-  None = "none", // Map will not display anything.
+  // Map will display single coordinates with markers on top.
+  Markers = "markers",
+  // Map will display polygon areas.
+  Areas = "areas",
+  // Map will not display anything.
+  None = "none",
 }