Method add_chart

xlsxwriter/workbook.py:252–314

Create a chart object. Args: options: The chart type and subtype options. Returns: Reference to a Chart object.

(self, options: Dict[str, Any])

        return xf_format

    def add_chart(self, options: Dict[str, Any]) -> Optional[
        Union[
            ChartArea,
            ChartBar,
            ChartColumn,
            ChartDoughnut,
            ChartLine,
            ChartPie,
            ChartRadar,
            ChartScatter,
            ChartStock,
        ]
    ]:
        """
        Create a chart object.

        Args:
            options: The chart type and subtype options.

        Returns:
            Reference to a Chart object.

        """

        # Type must be specified so we can create the required chart instance.
        chart_type = options.get("type")
        if chart_type is None:
            warn("Chart type must be defined in add_chart()")
            return None

        if chart_type == "area":
            chart = ChartArea(options)
        elif chart_type == "bar":
            chart = ChartBar(options)
        elif chart_type == "column":
            chart = ChartColumn(options)
        elif chart_type == "doughnut":
            chart = ChartDoughnut()
        elif chart_type == "line":
            chart = ChartLine(options)
        elif chart_type == "pie":
            chart = ChartPie()
        elif chart_type == "radar":
            chart = ChartRadar(options)
        elif chart_type == "scatter":
            chart = ChartScatter(options)
        elif chart_type == "stock":
            chart = ChartStock()
        else:
            warn(f"Unknown chart type '{chart_type}' in add_chart()")
            return None

        # Set the embedded chart name if present.
        if "name" in options:
            chart.chart_name = options["name"]

        chart.embedded = True
        chart.date_1904 = self.date_1904