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

spire/xls/interfaces/IChartInterior.py

@@ -0,0 +1,259 @@
+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 IChartInterior (abc.ABC) :
+    """Chart interior interface.
+    
+    This interface represents the interior formatting of chart elements in Excel.
+    It provides functionality for customizing the appearance of chart areas and plot areas,
+    including setting foreground and background colors, patterns, and format options.
+    The interior formatting controls the fill characteristics of chart elements.
+    """
+    @property
+
+    @abc.abstractmethod
+    def ForegroundColor(self)->'Color':
+        """
+        Foreground color (RGB).
+        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
+            #Set the foreground color of the chart
+            chart.ChartArea.Interior.ForegroundColor = Color.Blue
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @ForegroundColor.setter
+    @abc.abstractmethod
+    def ForegroundColor(self, value:'Color'):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def BackgroundColor(self)->'Color':
+        """
+        Background color (RGB).
+        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
+            #Set the backgroundColor color of the chart
+            chart.ChartArea.Interior.BackgroundColor = Color.Pink
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @BackgroundColor.setter
+    @abc.abstractmethod
+    def BackgroundColor(self, value:'Color'):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Pattern(self)->'ExcelPatternType':
+        """
+        Area pattern.
+        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
+            #Set the pattern of the chart
+            chart.ChartArea.Interior.Pattern = ExcelPatternType.Angle
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @Pattern.setter
+    @abc.abstractmethod
+    def Pattern(self, value:'ExcelPatternType'):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def ForegroundKnownColor(self)->'ExcelColors':
+        """
+        Index of foreground color.
+        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
+            #Set the index of foreground color
+            chart.ChartArea.Interior.ForegroundKnownColor = ExcelColors.Red
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @ForegroundKnownColor.setter
+    @abc.abstractmethod
+    def ForegroundKnownColor(self, value:'ExcelColors'):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def BackgroundKnownColor(self)->'ExcelColors':
+        """
+        Background color index.
+        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
+            #Set the index of background color
+            chart.ChartArea.Interior.BackgroundKnownColor = ExcelColors.Red
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @BackgroundKnownColor.setter
+    @abc.abstractmethod
+    def BackgroundKnownColor(self, value:'ExcelColors'):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def UseDefaultFormat(self)->bool:
+        """
+        If true - use automatic format; otherwise custom.
+        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 to use default format for interior
+            chart.ChartArea.Interior.UseDefaultFormat = true
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @UseDefaultFormat.setter
+    @abc.abstractmethod
+    def UseDefaultFormat(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def SwapColorsOnNegative(self)->bool:
+        """
+        Foreground and background are swapped when the data value is negative.
+        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 foreground and background colors are swapped when the data value is negative
+            chart.Series[0].Format.Interior.SwapColorsOnNegative = true
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @SwapColorsOnNegative.setter
+    @abc.abstractmethod
+    def SwapColorsOnNegative(self, value:bool):
+        """
+
+        """
+        pass
+
+

spire/xls/interfaces/IChartLegend.py

@@ -0,0 +1,453 @@
+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 IChartLegend (abc.ABC) :
+    """Chart legend interface.
+    
+    This interface represents the legend of a chart in Excel. A chart legend identifies
+    the data series displayed in the chart and shows the color or pattern assigned to each series.
+    The interface provides functionality for positioning, formatting, and managing legend entries,
+    including setting the position, orientation, size, and text formatting of the legend.
+    """
+    @property
+
+    @abc.abstractmethod
+    def TextArea(self)->'IChartTextArea':
+        """
+        Return text area of legend.
+        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
+            #Set text area for the legend
+            chart.Legend.TextArea.Color = Color.Gray
+            chart.Legend.TextArea.Size = 10
+            chart.Legend.TextArea.FontName = "Bernard MT Condensed"
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def X(self)->int:
+        """
+        X-position of upper-left corner. 1/4000 of chart plot.
+        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
+            #X co-ordinate of upper-left corner of the legend
+            chart.Legend.X = -80
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @X.setter
+    @abc.abstractmethod
+    def X(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Y(self)->int:
+        """
+        Y-position of upper-left corner. 1/4000 of chart plot.
+        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
+            #Y co-ordinate of upper-left corner of the legend
+            chart.Legend.Y = 30
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @Y.setter
+    @abc.abstractmethod
+    def Y(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Position(self)->'LegendPositionType':
+        """
+        Type: 0 = bottom 1 = corner 2 = top 3 = right 4 = left 7 = not docked or inside the plot area.
+        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
+            #Set the position of legend on the chart
+            chart.Legend.Position = LegendPositionType.Top
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @Position.setter
+    @abc.abstractmethod
+    def Position(self, value:'LegendPositionType'):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsVerticalLegend(self)->bool:
+        """
+        True if vertical legend (a single column of entries); False if horizontal legend (multiple columns of entries). Manual-sized legends always have this bit set to False.
+        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 legend is vertical
+            if(chart.Legend.IsVerticalLegend){ #Your code here }
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @IsVerticalLegend.setter
+    @abc.abstractmethod
+    def IsVerticalLegend(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def LegendEntries(self)->'IChartLegendEntries':
+        """
+        Represents legend entries collection. 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
+            #Get the count of legend entries
+            legendEntriesCount = chart.Legend.LegendEntries.Count
+            if(legendEntriesCount != 0){ #Your code here }
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IncludeInLayout(self)->bool:
+        """
+        Show legend without overlapping. Default is True.
+        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 to show legend without overlapping the chart
+            chartLegend = chart.Legend
+            chartLegend.IncludeInLayout = true
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @IncludeInLayout.setter
+    @abc.abstractmethod
+    def IncludeInLayout(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def InnerLayoutTarget(self)->bool:
+        """
+        """
+        pass
+
+
+    @InnerLayoutTarget.setter
+    @abc.abstractmethod
+    def InnerLayoutTarget(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsWMode(self)->bool:
+        """
+        false value Specifies that the Width shall be interpreted as the Right of the chart element.
+
+        """
+        pass
+
+
+    @IsWMode.setter
+    @abc.abstractmethod
+    def IsWMode(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsHMode(self)->bool:
+        """
+        false value Specifies that the Height shall be interpreted as the Bottom of the chart element.
+
+        """
+        pass
+
+
+    @IsHMode.setter
+    @abc.abstractmethod
+    def IsHMode(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsXMode(self)->bool:
+        """
+        true value Specifies that the X shall be interpreted as the Left of the chart element.
+
+        """
+        pass
+
+
+    @IsXMode.setter
+    @abc.abstractmethod
+    def IsXMode(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsYMode(self)->bool:
+        """
+        true value Specifies that the Y shall be interpreted as the Top of the chart element.
+
+        """
+        pass
+
+
+    @IsYMode.setter
+    @abc.abstractmethod
+    def IsYMode(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Width(self)->int:
+        """
+        X-size. 1/4000 of chart plot. IsWMode Shall set to True
+
+        """
+        pass
+
+
+    @Width.setter
+    @abc.abstractmethod
+    def Width(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Height(self)->int:
+        """
+        Y-size. 1/4000 of chart plot. IsHMode Shall set to True
+
+        """
+        pass
+
+
+    @Height.setter
+    @abc.abstractmethod
+    def Height(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def AutoPositionX(self)->bool:
+        """
+        X positioning is automatic.
+
+        """
+        pass
+
+
+    @AutoPositionX.setter
+    @abc.abstractmethod
+    def AutoPositionX(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def AutoPositionY(self)->bool:
+        """
+        Y positioning is automatic.
+
+        """
+        pass
+
+
+    @AutoPositionY.setter
+    @abc.abstractmethod
+    def AutoPositionY(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @abc.abstractmethod
+    def Clear(self):
+        """
+        Clears chart legend.
+        Example::
+
+            #Create worksheet
+            workbook = Workbook()
+            workbook.LoadFromFile("Sample.xlsx")
+            worksheet = workbook.Worksheets[0]
+            #Clears the legend of chart
+            worksheet.Charts[0].Legend.Clear()
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @abc.abstractmethod
+    def Delete(self):
+        """
+        Deletes chart legend.
+        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"]
+            #Clears the legend of chart
+            worksheet.Charts[0].Legend.Delete()
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+