feat: add Chart class and chart method in SlideBuilder for creating charts in slides

Author: ya7010

src/tppt/pptx/chart/__init__.py

@@ -0,0 +1,275 @@
+from typing import Literal, Self, TypedDict, assert_never
+
+from pptx.chart.chart import Chart as PptxChart
+from pptx.chart.data import ChartData as PptxChartData
+from pptx.enum.chart import XL_CHART_TYPE
+
+from tppt.pptx.converter import PptxConvertible
+from tppt.types._length import Length, LiteralLength
+
+LiteralChartType = Literal[
+    "3D Area",
+    "3D Stacked Area",
+    "3D 100% Stacked Area",
+    "3D Clustered Bar",
+    "3D Stacked Bar",
+    "3D 100% Stacked Bar",
+    "3D Column",
+    "3D Clustered Column",
+    "3D Stacked Column",
+    "3D 100% Stacked Column",
+    "3D Line",
+    "3D Pie",
+    "3D Exploded Pie",
+    "Area",
+    "Stacked Area",
+    "100% Stacked Area",
+    "Clustered Bar",
+    "Bar of Pie",
+    "Stacked Bar",
+    "100% Stacked Bar",
+    "Bubble",
+    "Bubble with 3D effects",
+    "Clustered Column",
+    "Stacked Column",
+    "100% Stacked Column",
+    "Clustered Cone Bar",
+    "Stacked Cone Bar",
+    "100% Stacked Cone Bar",
+    "3D Cone Column",
+    "Clustered Cone Column",
+    "Stacked Cone Column",
+    "100% Stacked Cone Column",
+    "Clustered Cylinder Bar",
+    "Stacked Cylinder Bar",
+    "100% Stacked Cylinder Bar",
+    "3D Cylinder Column",
+    "Clustered Cylinder Column",
+    "Stacked Cylinder Column",
+    "100% Stacked Cylinder Column",
+    "Doughnut",
+    "Exploded Doughnut",
+    "Line",
+    "Line with Markers",
+    "Stacked Line with Markers",
+    "100% Stacked Line with Markers",
+    "Stacked Line",
+    "100% Stacked Line",
+    "Pie",
+    "Exploded Pie",
+    "Pie of Pie",
+    "Clustered Pyramid Bar",
+    "Stacked Pyramid Bar",
+    "100% Stacked Pyramid Bar",
+    "3D Pyramid Column",
+    "Clustered Pyramid Column",
+    "Stacked Pyramid Column",
+    "100% Stacked Pyramid Column",
+    "Radar",
+    "Filled Radar",
+    "Radar with Data Markers",
+    "High-Low-Close",
+    "Open-High-Low-Close",
+    "Volume-High-Low-Close",
+    "Volume-Open-High-Low-Close",
+    "3D Surface",
+    "Surface (Top View)",
+    "Surface (Top View wireframe)",
+    "3D Surface (wireframe)",
+    "Scatter",
+    "Scatter with Lines",
+    "Scatter with Lines and No Data Markers",
+    "Scatter with Smoothed Lines",
+    "Scatter with Smoothed Lines and No Data Markers",
+]
+
+
+def to_pptx_chart_type(chart_type: XL_CHART_TYPE | LiteralChartType) -> XL_CHART_TYPE:
+    match chart_type:
+        case XL_CHART_TYPE():
+            return chart_type
+        case "3D Area":
+            return XL_CHART_TYPE.THREE_D_AREA
+        case "3D Stacked Area":
+            return XL_CHART_TYPE.THREE_D_AREA_STACKED
+        case "3D 100% Stacked Area":
+            return XL_CHART_TYPE.THREE_D_AREA_STACKED_100
+        case "3D Clustered Bar":
+            return XL_CHART_TYPE.THREE_D_BAR_CLUSTERED
+        case "3D Stacked Bar":
+            return XL_CHART_TYPE.THREE_D_BAR_STACKED
+        case "3D 100% Stacked Bar":
+            return XL_CHART_TYPE.THREE_D_BAR_STACKED_100
+        case "3D Column":
+            return XL_CHART_TYPE.THREE_D_COLUMN
+        case "3D Clustered Column":
+            return XL_CHART_TYPE.THREE_D_COLUMN_CLUSTERED
+        case "3D Stacked Column":
+            return XL_CHART_TYPE.THREE_D_COLUMN_STACKED
+        case "3D 100% Stacked Column":
+            return XL_CHART_TYPE.THREE_D_COLUMN_STACKED_100
+        case "3D Line":
+            return XL_CHART_TYPE.THREE_D_LINE
+        case "3D Pie":
+            return XL_CHART_TYPE.THREE_D_PIE
+        case "3D Exploded Pie":
+            return XL_CHART_TYPE.THREE_D_PIE_EXPLODED
+        case "Area":
+            return XL_CHART_TYPE.AREA
+        case "Stacked Area":
+            return XL_CHART_TYPE.AREA_STACKED
+        case "100% Stacked Area":
+            return XL_CHART_TYPE.AREA_STACKED_100
+        case "Clustered Bar":
+            return XL_CHART_TYPE.BAR_CLUSTERED
+        case "Bar of Pie":
+            return XL_CHART_TYPE.BAR_OF_PIE
+        case "Stacked Bar":
+            return XL_CHART_TYPE.BAR_STACKED
+        case "100% Stacked Bar":
+            return XL_CHART_TYPE.BAR_STACKED_100
+        case "Bubble":
+            return XL_CHART_TYPE.BUBBLE
+        case "Bubble with 3D effects":
+            return XL_CHART_TYPE.BUBBLE_THREE_D_EFFECT
+        case "Clustered Column":
+            return XL_CHART_TYPE.COLUMN_CLUSTERED
+        case "Stacked Column":
+            return XL_CHART_TYPE.COLUMN_STACKED
+        case "100% Stacked Column":
+            return XL_CHART_TYPE.COLUMN_STACKED_100
+        case "Clustered Cone Bar":
+            return XL_CHART_TYPE.CONE_BAR_CLUSTERED
+        case "Stacked Cone Bar":
+            return XL_CHART_TYPE.CONE_BAR_STACKED
+        case "100% Stacked Cone Bar":
+            return XL_CHART_TYPE.CONE_BAR_STACKED_100
+        case "3D Cone Column":
+            return XL_CHART_TYPE.CONE_COL
+        case "Clustered Cone Column":
+            return XL_CHART_TYPE.CONE_COL_CLUSTERED
+        case "Stacked Cone Column":
+            return XL_CHART_TYPE.CONE_COL_STACKED
+        case "100% Stacked Cone Column":
+            return XL_CHART_TYPE.CONE_COL_STACKED_100
+        case "Clustered Cylinder Bar":
+            return XL_CHART_TYPE.CYLINDER_BAR_CLUSTERED
+        case "Stacked Cylinder Bar":
+            return XL_CHART_TYPE.CYLINDER_BAR_STACKED
+        case "100% Stacked Cylinder Bar":
+            return XL_CHART_TYPE.CYLINDER_BAR_STACKED_100
+        case "3D Cylinder Column":
+            return XL_CHART_TYPE.CYLINDER_COL
+        case "Clustered Cylinder Column":
+            return XL_CHART_TYPE.CYLINDER_COL_CLUSTERED
+        case "Stacked Cylinder Column":
+            return XL_CHART_TYPE.CYLINDER_COL_STACKED
+        case "100% Stacked Cylinder Column":
+            return XL_CHART_TYPE.CYLINDER_COL_STACKED_100
+        case "Doughnut":
+            return XL_CHART_TYPE.DOUGHNUT
+        case "Exploded Doughnut":
+            return XL_CHART_TYPE.DOUGHNUT_EXPLODED
+        case "Line":
+            return XL_CHART_TYPE.LINE
+        case "Line with Markers":
+            return XL_CHART_TYPE.LINE_MARKERS
+        case "Stacked Line with Markers":
+            return XL_CHART_TYPE.LINE_MARKERS_STACKED
+        case "100% Stacked Line with Markers":
+            return XL_CHART_TYPE.LINE_MARKERS_STACKED_100
+        case "Stacked Line":
+            return XL_CHART_TYPE.LINE_STACKED
+        case "100% Stacked Line":
+            return XL_CHART_TYPE.LINE_STACKED_100
+        case "Pie":
+            return XL_CHART_TYPE.PIE
+        case "Exploded Pie":
+            return XL_CHART_TYPE.PIE_EXPLODED
+        case "Pie of Pie":
+            return XL_CHART_TYPE.PIE_OF_PIE
+        case "Clustered Pyramid Bar":
+            return XL_CHART_TYPE.PYRAMID_BAR_CLUSTERED
+        case "Stacked Pyramid Bar":
+            return XL_CHART_TYPE.PYRAMID_BAR_STACKED
+        case "100% Stacked Pyramid Bar":
+            return XL_CHART_TYPE.PYRAMID_BAR_STACKED_100
+        case "3D Pyramid Column":
+            return XL_CHART_TYPE.PYRAMID_COL
+        case "Clustered Pyramid Column":
+            return XL_CHART_TYPE.PYRAMID_COL_CLUSTERED
+        case "Stacked Pyramid Column":
+            return XL_CHART_TYPE.PYRAMID_COL_STACKED
+        case "100% Stacked Pyramid Column":
+            return XL_CHART_TYPE.PYRAMID_COL_STACKED_100
+        case "Radar":
+            return XL_CHART_TYPE.RADAR
+        case "Filled Radar":
+            return XL_CHART_TYPE.RADAR_FILLED
+        case "Radar with Data Markers":
+            return XL_CHART_TYPE.RADAR_MARKERS
+        case "High-Low-Close":
+            return XL_CHART_TYPE.STOCK_HLC
+        case "Open-High-Low-Close":
+            return XL_CHART_TYPE.STOCK_OHLC
+        case "Volume-High-Low-Close":
+            return XL_CHART_TYPE.STOCK_VHLC
+        case "Volume-Open-High-Low-Close":
+            return XL_CHART_TYPE.STOCK_VOHLC
+        case "3D Surface":
+            return XL_CHART_TYPE.SURFACE
+        case "Surface (Top View)":
+            return XL_CHART_TYPE.SURFACE_TOP_VIEW
+        case "Surface (Top View wireframe)":
+            return XL_CHART_TYPE.SURFACE_TOP_VIEW_WIREFRAME
+        case "3D Surface (wireframe)":
+            return XL_CHART_TYPE.SURFACE_WIREFRAME
+        case "Scatter":
+            return XL_CHART_TYPE.XY_SCATTER
+        case "Scatter with Lines":
+            return XL_CHART_TYPE.XY_SCATTER_LINES
+        case "Scatter with Lines and No Data Markers":
+            return XL_CHART_TYPE.XY_SCATTER_LINES_NO_MARKERS
+        case "Scatter with Smoothed Lines":
+            return XL_CHART_TYPE.XY_SCATTER_SMOOTH
+        case "Scatter with Smoothed Lines and No Data Markers":
+            return XL_CHART_TYPE.XY_SCATTER_SMOOTH_NO_MARKERS
+        case _:
+            assert_never(chart_type)
+
+
+class ChartProps(TypedDict):
+    """Chart properties."""
+
+    chart_type: LiteralChartType | XL_CHART_TYPE
+    x: Length | LiteralLength
+    y: Length | LiteralLength
+    cx: Length | LiteralLength
+    cy: Length | LiteralLength
+    chart_data: PptxChartData
+
+
+class ChartData(ChartProps):
+    """Chart data."""
+
+    type: Literal["chart"]
+
+
+class Chart(PptxConvertible[PptxChart]):
+    """Chart data class."""
+
+    def __init__(
+        self,
+        pptx_obj: PptxChart,
+        /,
+    ) -> None:
+        self._pptx = pptx_obj
+
+    def to_pptx(self) -> PptxChart:
+        """Convert to pptx shape."""
+        return self._pptx
+
+    @classmethod
+    def from_pptx(cls, pptx_obj: PptxChart) -> Self:
+        """Create from pptx shape."""
+        return cls(pptx_obj)

src/tppt/pptx/chart/chart.py

@@ -14,6 +14,7 @@
 
 from pptx.slide import Slide as PptxSlide
 
+from tppt.pptx.chart.chart import Chart, ChartData, ChartProps, to_pptx_chart_type
 from tppt.pptx.shape.picture import (
     Movie,
     MovieData,
@@ -316,6 +317,39 @@ def _register(slide: Slide) -> Table:
 
         return self
 
+    def chart(
+        self,
+        data: Callable[[Chart], Chart] | None = None,
+        /,
+        **kwargs: Unpack[ChartProps],
+    ) -> Self:
+        chart_type = to_pptx_chart_type(kwargs["chart_type"])
+
+        def _register(slide: Slide) -> Chart:
+            data: ChartData = {
+                "type": "chart",
+                **kwargs,
+            }
+
+            chart_obj = Chart(
+                slide.to_pptx().shapes.add_chart(
+                    chart_type=chart_type,
+                    x=to_pptx_length(data["x"]),
+                    y=to_pptx_length(data["y"]),
+                    cx=to_pptx_length(data["cx"]),
+                    cy=to_pptx_length(data["cy"]),
+                    chart_data=data["chart_data"],
+                )
+            )
+            if isinstance(data, Callable):
+                return data(chart_obj)
+            else:
+                return chart_obj
+
+        self._shape_registry.append(_register)
+
+        return self
+
     def _build(self, slide: PptxSlide) -> Slide:
         tppt_slide = Slide(slide)