Export image

dimes/dimensional_plot.py

@@ -227,6 +227,8 @@ def __init__(
         x_axis: DimensionalData | TimeSeriesAxis | list[SupportsFloat] | list[datetime],
         title: str | None = None,
         additional_info: str | None = None,
+        width: int | None = None,
+        height: int | None = None,
     ):
         self.figure = Figure()
         self.x_axis: DimensionalData | TimeSeriesAxis
@@ -240,6 +242,8 @@ def __init__(
         self.subplots: list[DimensionalSubplot | None] = [None]
         self.is_finalized = False
         self.figure.layout["title"] = title
+        self.figure.layout["width"] = width
+        self.figure.layout["height"] = height
         if additional_info is not None:
             self.figure.add_trace(
                 Scatter(
@@ -456,6 +460,17 @@ def write_html_plot(self, path: Path) -> None:
         self.finalize_plot()
         self.figure.write_html(path)
 
+    def write_image_plot(self, path: Path, scale: int | float | None = None) -> None:
+        """
+        Write plots to html file at specified path.
+        scale (int, float, None): Adjusts the resolution of the output image.
+        A value cannot be equal to or less than 0 or greater than 16.
+        """
+        if (scale > 16) | (scale <= 0):
+            raise ValueError(f"Scale value {scale} cannot be greater than 16 or less than or equal to 0.")
+        self.finalize_plot()
+        self.figure.write_image(path, scale=scale)
+
 
 def get_subplot_domains(number_of_subplots: int, gap: float = 0.05) -> list[tuple[float, float]]:
     """Calculate and return the 'Y' domain ranges for a given number of subplots with the specified gap size."""

pyproject.toml

@@ -1,36 +1,37 @@
 [tool.poetry]
-name = "dimes"
+authors = ["Big Ladder Software"] 
+description = "A dimensionally aware scientific plotting package." 
+keywords = ["template"] 
+license = "BSD-3" 
+name = "dimes" 
+readme = "README.md" 
+repository = "https://github.com/bigladder/dimes" 
 version = "0.0.0" # Generated from git on CI
-description = "A dimensionally aware scientific plotting package."
-authors = ["Big Ladder Software"]
-license = "BSD-3"
-readme = "README.md"
-keywords = ["template"]
-repository = "https://github.com/bigladder/dimes"
 
 [tool.poetry.dependencies]
-python = "^3.10"
-plotly = "*"
-koozie = "^1.3.0"
+kaleido = "==0.2.1" # Required by plotly to save figures as images
+koozie = "^1.3.0" 
+plotly = "*" 
+python = "^3.10" 
 
 [tool.poetry.dev-dependencies]
-pytest = "^7.1.3"
-pylint = "*"
 black = "*"
 mypy = "*"
+pylint = "*"
+pytest = "^7.1.3"
 
 [build-system]
-requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core>=1.0.0"]
 
 [tool.black]
 line-length = 120
 
 [tool.mypy]
+check_untyped_defs = true
 disallow_incomplete_defs = true
 no_implicit_optional = true
-check_untyped_defs = true
 
 [[tool.mypy.overrides]]
-module = "dimes.*"
 disable_error_code = ["import"]
+module = "dimes.*"