feat(_extend_hourly_plot): add to_vtkjs method to hourly plot

ladybug_vtk/_extend_hourly_plot.py

@@ -0,0 +1,80 @@
+from pathlib import Path
+from ladybug.hourlyplot import HourlyPlot
+from ladybug_geometry.geometry3d import Vector3D
+from ladybug.color import Color
+from .from_ladybug3d import from_line3d, from_polyline3d, from_mesh3d
+from .to_vtk import to_text
+from .model_dataset import ModelDataSet
+from .model import Model
+
+
+def hourly_plot_to_vtkjs(self, output_folder: str, file_name: str = 'hourly plot') -> Path:
+    """
+    Export the HourlyPlot to a vtkjs file.
+
+    Args:
+        output_folder: Path to the target folder to write the vtkjs file.
+        file_name: Output file name. Defaults to hourly plot.
+
+    Returns:
+        A pathlib Path object to the vtkjs file.
+    """
+
+    datasets = []
+
+    lines = []
+    # hour lines
+    hour_lines3d_polydata = [from_line3d(
+        line) for line in self.custom_hour_lines3d(hour_labels=[0, 6, 12, 18, 24])]
+    lines.extend(hour_lines3d_polydata)
+
+    # month lines
+    month_lines3d_polydata = [from_line3d(line) for line in self.month_lines3d]
+    lines.extend(month_lines3d_polydata)
+
+    # border polyline
+    border_polydata = from_polyline3d(self.chart_border3d)
+    lines.append(border_polydata)
+    datasets.append(ModelDataSet('lines', lines, color=Color()))
+
+    # lalbels
+    labels = []
+    left_vector = Vector3D(-1, 0, 0)*5
+    down_vector = Vector3D(0, -1, 0)*3
+
+    # month labels
+    month_labels_polydata = [
+        to_text(label, self.month_label_points3d[count].
+                move(left_vector).move(down_vector), scale=4)
+        for count, label in enumerate(self.month_labels)]
+    labels.extend(month_labels_polydata)
+
+    # hour labels
+    hour_left_vector = Vector3D(-1, 0, 0)*15
+    hour_labels_polydata = [
+        to_text(label, self.hour_label_points3d[count].
+                move(hour_left_vector).move(down_vector), scale=4)
+        for count, label in enumerate(self.hour_labels)]
+    labels.extend(hour_labels_polydata)
+
+    # title text
+    title_polydata = to_text(self.title_text, self.lower_title_location.o.move(
+        left_vector).move(down_vector), scale=4)
+    labels.append(title_polydata)
+    datasets.append(ModelDataSet('labels', labels, color=Color()))
+
+    # data
+    mesh_polydata = from_mesh3d(self.colored_mesh3d)
+    mesh_dataset = ModelDataSet('data', [mesh_polydata])
+    name = self.data_collection.header.data_type.name
+    mesh_dataset.add_data_fields([self.data_collection], name)
+    mesh_dataset.color_by = name
+    datasets.append(mesh_dataset)
+
+    # write all datasets to a vtkjs file
+    hourly_plot = Model(datasets=datasets)
+
+    return Path(hourly_plot.to_vtkjs(output_folder, file_name))
+
+
+HourlyPlot.to_vtkjs = hourly_plot_to_vtkjs