Cleanup and added comments

Canadian-Geospatial-Platform · Oct 6, 2023 · 0627e7f · 0627e7f
1 parent 3a5bc8d
commit 0627e7f
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 31 deletions.
diff --git a/src/chart-types.ts b/src/chart-types.ts
@@ -2,17 +2,26 @@ import { ChartType, ChartData, ChartDataset, ChartOptions, DefaultDataPoint } fr
 
 export type GeoChartType = ChartType;
 
+/**
+ * Extends the ChartData used by Chart.js and represents the whole Data to be displayed in the Chart
+ */
 export interface GeoChartData<
   TType extends GeoChartType = GeoChartType,
   TData = DefaultDataPoint<TType>,
   TLabel = string
   > extends ChartData<TType, TData, TLabel> { };
 
+/**
+ * Represents a Dataset to be shown in the Chart
+ */
 export type GeoChartDataset<
   TType extends GeoChartType = GeoChartType,
   TData = DefaultDataPoint<TType>
   > = ChartDataset<TType, TData>;
 
+/**
+ * Extends the ChartOptions used by Chart.js with more 'GeoChart' options
+ */
 export interface GeoChartOptions extends ChartOptions<GeoChartType> {
   geochart: {
     chart: GeoChartType;
@@ -23,6 +32,9 @@ export interface GeoChartOptions extends ChartOptions<GeoChartType> {
   };
 };
 
+/**
+ * Options for the Slider component
+ */
 export type GeoChartOptionsSlider = {
   display: boolean;
   min: number;
@@ -31,6 +43,9 @@ export type GeoChartOptionsSlider = {
   track: 'normal' | 'inverted' | false;
 };
 
+/**
+ * Options for the Slider Axis component
+ */
 export type GeoChartOptionsAxis = {
   type: string;
 };
diff --git a/src/chart.tsx b/src/chart.tsx
@@ -1,6 +1,5 @@
-// import { useEffect, useState } from 'react';
 import { Box } from '@mui/material';
-import { Chart as ChartJS, ChartData, ChartOptions, DefaultDataPoint } from 'chart.js';
+import { ChartData, ChartOptions, DefaultDataPoint } from 'chart.js';
 import { GeoChartOptions, GeoChartType, GeoChartData} from './chart-types';
 import { ChartDoughnut } from './charts/chart-doughnut';
 import { ChartBarsVertical } from './charts/chart-bars-vertical';
@@ -47,6 +46,10 @@ export function Chart(props: TypeChartChartProps<GeoChartType>): JSX.Element {
     }
   };
 
+  /**
+   * Renders the Chart JSX.Element itself using Line as default
+   * @returns The Chart JSX.Element itself using Line as default
+   */
   const renderChart = (): JSX.Element => {
     // Depending on the type of chart
     switch (options!.geochart.chart) {
@@ -96,6 +99,10 @@ export function Chart(props: TypeChartChartProps<GeoChartType>): JSX.Element {
     }
   };
 
+  /**
+   * Renders the X Chart Slider JSX.Element or an empty div
+   * @returns The X Chart Slider JSX.Element or an empty div
+   */
   const renderXSlider = () : JSX.Element => {
     const { xSlider } = options!.geochart;
     if (xSlider?.display) {
@@ -116,6 +123,10 @@ export function Chart(props: TypeChartChartProps<GeoChartType>): JSX.Element {
     return <div />;
   }
 
+  /**
+   * Renders the Y Chart Slider JSX.Element or an empty div
+   * @returns The Y Chart Slider JSX.Element or an empty div
+   */
   const renderYSlider = (): JSX.Element => {
     const { ySlider } = options!.geochart;
     if (ySlider?.display) {
@@ -136,6 +147,10 @@ export function Chart(props: TypeChartChartProps<GeoChartType>): JSX.Element {
     return <div />;
   };
 
+  /**
+   * Renders the whole Chart container JSX.Element or an empty div
+   * @returns The whole Chart container JSX.Element or an empty div
+   */
   const renderChartContainer = (): JSX.Element => {
     if (options && options.geochart && options.geochart.chart) {
       return (
@@ -147,7 +162,7 @@ export function Chart(props: TypeChartChartProps<GeoChartType>): JSX.Element {
         </div>
       );
     }
-    return <div></div>;
+    return <div />;
   }
 
   return renderChartContainer();

diff --git a/src/charts/chart-bars-vertical.tsx b/src/charts/chart-bars-vertical.tsx
@@ -21,12 +21,5 @@ export function ChartBarsVertical(props: ChartProps<'bar', DefaultDataPoint<'bar
 
   ChartJS.register(CategoryScale, LinearScale, BarElement, Title, Tooltip, Legend);
 
-  // useEffect(() => {
-  //   console.log("ChartBarsVertical useEffect Hey")
-  //   return () => {
-  //     console.log("ChartBarsVertical useEffect Kill")
-  //   };
-  // }, []);
-
   return <Bar style={style} data={data} options={options} redraw={redraw} />;
 }
diff --git a/src/charts/chart-doughnut.tsx b/src/charts/chart-doughnut.tsx
@@ -12,12 +12,5 @@ export function ChartDoughnut(props: ChartProps<'doughnut', DefaultDataPoint<'do
 
   ChartJS.register(ArcElement, Tooltip, Legend);
 
-  // useEffect(() => {
-  //   console.log("ChartDoughnut useEffect Hey")
-  //   return () => {
-  //     console.log("ChartDoughnut useEffect Kill")
-  //   };
-  // }, []);
-
   return <Doughnut style={style} data={data} options={options} redraw={redraw} />;
 }
diff --git a/src/charts/chart-line.tsx b/src/charts/chart-line.tsx
@@ -22,12 +22,5 @@ export function ChartLine(props: ChartProps<'line', DefaultDataPoint<'line'>>):
 
   ChartJS.register(CategoryScale, LinearScale, PointElement, LineElement, Title, Tooltip, Legend);
 
-  // useEffect(() => {
-  //   console.log("ChartLine useEffect Hey")
-  //   return () => {
-  //     console.log("ChartLine useEffect Kill")
-  //   };
-  // }, []);
-
   return <Line style={style} data={data} options={options} redraw={redraw} />;
 }
diff --git a/src/charts/chart-pie.tsx b/src/charts/chart-pie.tsx
@@ -12,12 +12,5 @@ export function ChartPie(props: ChartProps<'pie', DefaultDataPoint<'pie'>>): JSX
 
   ChartJS.register(ArcElement, Tooltip, Legend);
 
-  // useEffect(() => {
-  //   console.log("ChartPie useEffect Hey")
-  //   return () => {
-  //     console.log("ChartPie useEffect Kill")
-  //   };
-  // }, []);
-
   return <Pie style={style} data={data} options={options} redraw={redraw} />;
 }