spire-xls 15.5.0__py3-none-win_amd64.whl → 15.7.1__py3-none-win_amd64.whl

spire/xls/interfaces/IChartFormat.py

@@ -0,0 +1,521 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IChartFormat (abc.ABC) :
+    """
+    Provides access to the formatting options for chart elements.
+
+    """
+    @property
+    @abc.abstractmethod
+    def IsVaryColor(self)->bool:
+        """
+        Vary color for each data point.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:C2"]
+            #Set chart format
+            format = chart.Series[0].Format.Options
+            #Set vary color
+            format.IsVaryColor = true
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @IsVaryColor.setter
+    @abc.abstractmethod
+    def IsVaryColor(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Overlap(self)->int:
+        """
+        Space between bars ( -100 : 100 ).
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:C3"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.ColumnStacked
+            #Set chart format
+            format = chart.Series[0].Format.Options
+            #Set overlap
+            format.Overlap = 20
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @Overlap.setter
+    @abc.abstractmethod
+    def Overlap(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def GapWidth(self)->int:
+        """
+        Space between categories (percent of bar width), default = 50.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:C3"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.Column3DStacked
+            #Set chart format
+            format = chart.Series[0].Format.Options
+            #Set Gap width
+            format.GapWidth = 400
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @GapWidth.setter
+    @abc.abstractmethod
+    def GapWidth(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def FirstSliceAngle(self)->int:
+        """
+        Angle of the first pie slice expressed in degrees. ( 0 - 360 ).
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:C2"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.Pie
+            #Set chart format
+            format = chart.Series[0].Format.Options
+            #Set Gap width
+            format.FirstSliceAngle = 60
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @FirstSliceAngle.setter
+    @abc.abstractmethod
+    def FirstSliceAngle(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def DoughnutHoleSize(self)->int:
+        """
+        Size of center hole in a doughnut chart (as a percentage).( 10 - 90 ).
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:C2"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.Doughnut
+            #Set chart format
+            format = chart.Series[0].Format.Options
+            #Set Doughnut hole size
+            format.DoughnutHoleSize = 60
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @DoughnutHoleSize.setter
+    @abc.abstractmethod
+    def DoughnutHoleSize(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def BubbleScale(self)->int:
+        """
+        Percent of largest bubble compared to chart in general. ( 0 - 300 ).
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add(ExcelChartType.Bubble3D)
+            chart.DataRange = worksheet.Range["A1:C2"]
+            chart.Series[0].Bubbles = worksheet.Range["A2:C3"]
+            #Set chart format
+            format = chart.Series[0].Format.Options
+            #Set bubble scale
+            format.BubbleScale = 50
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @BubbleScale.setter
+    @abc.abstractmethod
+    def BubbleScale(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def SizeRepresents(self)->'BubbleSizeType':
+        """
+        Returns or sets what the bubble size represents on a bubble chart.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add(ExcelChartType.Bubble3D)
+            chart.DataRange = worksheet.Range["A1:C2"]
+            chart.Series[0].Bubbles = worksheet.Range["A2:C3"]
+            #Set chart format
+            format = chart.Series[0].Format.Options
+            #Set bubble scale and size represents
+            format.BubbleScale = 50
+            format.SizeRepresents = BubbleSizeType.Width
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @SizeRepresents.setter
+    @abc.abstractmethod
+    def SizeRepresents(self, value:'BubbleSizeType'):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def ShowNegativeBubbles(self)->bool:
+        """
+        True to show negative bubbles.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add(ExcelChartType.Bubble3D)
+            chart.DataRange = worksheet.Range["A1:D2"]
+            chart.Series[0].Bubbles = worksheet.Range["A2:C3"]
+            #Set chart format
+            format = chart.Series[0].Format.Options
+            #Set negative bubble visibility
+            format.ShowNegativeBubbles = true
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @ShowNegativeBubbles.setter
+    @abc.abstractmethod
+    def ShowNegativeBubbles(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def HasRadarAxisLabels(self)->bool:
+        """
+        True if a radar chart has axis labels. Applies only to radar charts.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:C2"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.Radar
+            #Set chart format
+            format = chart.Series[0].Format.Options
+            #Set radar label visibility
+            format.HasRadarAxisLabels = false
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @HasRadarAxisLabels.setter
+    @abc.abstractmethod
+    def HasRadarAxisLabels(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def SplitType(self)->'SplitType':
+        """
+        Returns or sets the way the two sections of either a pie of pie chart or a bar of pie chart are split.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:F2"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.PieOfPie
+            #Set chart format
+            format = chart.Series[0].Format.Options
+            #Set split type
+            format.SplitType = SplitType.Value
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @SplitType.setter
+    @abc.abstractmethod
+    def SplitType(self, value:'SplitType'):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def SplitValue(self)->int:
+        """
+        Returns or sets the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:F2"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.PieOfPie
+            #Set chart format
+            format = chart.Series[0].Format.Options
+            #Set split value
+            format.SplitValue = 20
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @SplitValue.setter
+    @abc.abstractmethod
+    def SplitValue(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def PieSecondSize(self)->int:
+        """
+        Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. ( 5 - 200 ).
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:F2"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.PieOfPie
+            #Set chart format
+            format = chart.Series[0].Format.Options
+            #Set second pie size
+            format.PieSecondSize = 40
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @PieSecondSize.setter
+    @abc.abstractmethod
+    def PieSecondSize(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def FirstDropBar(self)->'IChartDropBar':
+        """
+        Returns object that represents first drop bar.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:C3"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.Line
+            #Set chart drop bar
+            dropBar = chart.Series[0].Format.Options.FirstDropBar
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def SecondDropBar(self)->'IChartDropBar':
+        """
+        Returns object that represents second drop bar.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:C3"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.Line
+            #Set chart first drop bar
+            dropBar = chart.Series[0].Format.Options.FirstDropBar
+            #Set chart second drop bar
+            dropBar = chart.Series[0].Format.Options.SecondDropBar
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def PieSeriesLine(self)->'IChartBorder':
+        """
+        Represents series line properties. ( For pie of pie or pie of bar chart types only. ) Read only.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:F2"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.PieOfPie
+            #Set pie series line border
+            border =  chart.Series[0].Format.Options.PieSeriesLine
+            #Set color
+            border.Color = Color.Red
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+

spire/xls/interfaces/IChartFrameFormat.py

@@ -0,0 +1,85 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IChartFrameFormat (  IChartFillBorder) :
+    """
+    Represent the borders and layout options of the chart elements.
+
+    """
+    @property
+    @abc.abstractmethod
+    def IsBorderCornersRound(self)->bool:
+        """
+        Gets or sets flag if border corners is round.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["B2:C6"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.Cone3DClustered
+            #True if the chart area has rounded corners
+            chartArea = chart.ChartArea
+            chartArea.IsBorderCornersRound = true
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @IsBorderCornersRound.setter
+    @abc.abstractmethod
+    def IsBorderCornersRound(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Border(self)->'IChartBorder':
+        """
+        Represents chart border. Read only.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["B2:C6"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.Cone3DClustered
+            #border of the chart element
+            chart.ChartTitleArea.Text = "Sample Chart"
+            chart.ChartTitleArea.FrameFormat.Border.Color = Color.Red
+            chart.ChartTitleArea.FrameFormat.Border.Pattern = ChartLinePatternType.DashDotDot
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @abc.abstractmethod
+    def Clear(self):
+        """
+        Clear curent plot area.
+
+        """
+        pass
+
+

spire/xls/interfaces/IChartGridLine.py

@@ -0,0 +1,100 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IChartGridLine (abc.ABC) :
+    """Chart grid line interface.
+    
+    This interface represents the grid lines in an Excel chart. Grid lines are horizontal or
+    vertical lines that extend from the tick marks on an axis across the plot area, making it
+    easier to view and evaluate data points. The interface provides functionality for formatting
+    grid lines, including border properties, 3D effects, shadows, line properties, interior
+    formatting, and fill options.
+    """
+    @property
+
+    @abc.abstractmethod
+    def Border(self)->'ChartBorder':
+        """
+        Gets line border. Read only.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Create chart and set range
+            chart = worksheet.Charts.Add()
+            chart.DataRange = worksheet.Range["A1:C2"]
+            #Set value axis minor gridLines to visible
+            chart.PrimaryValueAxis.HasMinorGridLines = true
+            #Get value axis minor gridlines
+            gridLine = chart.PrimaryValueAxis.MinorGridLines
+            Set minor gridlines broder properties
+            gridLine.Border.Color = Color.Red
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Format3D(self)->'Format3D':
+        """
+        Gets the chart3 D properties.
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Shadow(self)->'ChartShadow':
+        """
+        Gets the shadow properties.
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def LineProperties(self)->'ChartBorder':
+        """
+        Returns object, that represents line properties. Read-only.
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Interior(self)->'IChartInterior':
+        """
+        Returns object, that represents area properties. Read-only.
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Fill(self)->'IShapeFill':
+        """
+        Represents XlsFill options. Read-only.
+
+        """
+        pass
+
+