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

spire/xls/interfaces/IChartErrorBars.py

@@ -0,0 +1,340 @@
+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 spire.xls.charts.XlsChartBorder import *
+from ctypes import *
+import abc
+
+class IChartErrorBars (SpireObject) :
+    """
+    Represent error bars on the chart series. Error bars indicate the degree of uncertainty for chart data. Only series in area, bar, column, line, and scatter groups on a 2-D chart can have error bars. Only series in scatter groups can have x and y error bars.
+
+    """
+    @property
+
+    def Border(self)->'IChartBorder':
+        """
+        Represents border object. 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:C3"]
+            #Set chart type
+            chart.ChartType = ExcelChartType.ColumnClustered
+            #Get chart serie
+            serie = chart.Series[0]
+            #Enabling the Y Error bars
+            serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10)
+            errorBars = serie.ErrorBarsY
+            #Set Error bars border color
+            errorBars.Border.Color = Color.Red
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        GetDllLibXls().IChartErrorBars_get_Border.argtypes=[c_void_p]
+        GetDllLibXls().IChartErrorBars_get_Border.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IChartErrorBars_get_Border, self.Ptr)
+        ret = None if intPtr==None else XlsChartBorder(intPtr)
+        return ret
+
+
+    @property
+
+    def Include(self)->'ErrorBarIncludeType':
+        """
+        Reprsents error bar include type.
+        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.ColumnClustered
+            #Get chart serie
+            serie = chart.Series[0]
+            #Enabling the Y Error bars
+            serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10)
+            errorBars = serie.ErrorBarsY
+            #Set negative error only to include
+            errorBars.Include = ErrorBarIncludeType.Minus
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        GetDllLibXls().IChartErrorBars_get_Include.argtypes=[c_void_p]
+        GetDllLibXls().IChartErrorBars_get_Include.restype=c_int
+        ret = CallCFunction(GetDllLibXls().IChartErrorBars_get_Include, self.Ptr)
+        objwraped = ErrorBarIncludeType(ret)
+        return objwraped
+
+    @Include.setter
+    def Include(self, value:'ErrorBarIncludeType'):
+        GetDllLibXls().IChartErrorBars_set_Include.argtypes=[c_void_p, c_int]
+        CallCFunction(GetDllLibXls().IChartErrorBars_set_Include, self.Ptr, value.value)
+
+    @property
+    def HasCap(self)->bool:
+        """
+        Indicates if error bar has cap.
+        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.ColumnClustered
+            #Get chart serie
+            serie = chart.Series[0]
+            #Enabling the Y Error bars
+            serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10)
+            errorBars = serie.ErrorBarsY
+            #Set false to remove the end style
+            errorBars.HasCap = false
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        GetDllLibXls().IChartErrorBars_get_HasCap.argtypes=[c_void_p]
+        GetDllLibXls().IChartErrorBars_get_HasCap.restype=c_bool
+        ret = CallCFunction(GetDllLibXls().IChartErrorBars_get_HasCap, self.Ptr)
+        return ret
+
+    @HasCap.setter
+    def HasCap(self, value:bool):
+        GetDllLibXls().IChartErrorBars_set_HasCap.argtypes=[c_void_p, c_bool]
+        CallCFunction(GetDllLibXls().IChartErrorBars_set_HasCap, self.Ptr, value)
+
+    @property
+
+    def Type(self)->'ErrorBarType':
+        """
+        Represents excel error bar type.
+        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.ColumnClustered
+            #Get chart serie
+            serie = chart.Series[0]
+            #Enabling the Y Error bars
+            serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10)
+            errorBars = serie.ErrorBarsY
+            #Set error amount to standard deviation
+            errorBars.Type = ErrorBarType.StandardDeviation
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        GetDllLibXls().IChartErrorBars_get_Type.argtypes=[c_void_p]
+        GetDllLibXls().IChartErrorBars_get_Type.restype=c_int
+        ret = CallCFunction(GetDllLibXls().IChartErrorBars_get_Type, self.Ptr)
+        objwraped = ErrorBarType(ret)
+        return objwraped
+
+    @Type.setter
+    def Type(self, value:'ErrorBarType'):
+        GetDllLibXls().IChartErrorBars_set_Type.argtypes=[c_void_p, c_int]
+        CallCFunction(GetDllLibXls().IChartErrorBars_set_Type, self.Ptr, value.value)
+
+    @property
+    def NumberValue(self)->float:
+        """
+        Represents number value.
+        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.ColumnClustered
+            #Get chart serie
+            serie = chart.Series[0]
+            #Enabling the Y Error bars
+            serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10)
+            errorBars = serie.ErrorBarsY
+            #Set error value
+            errorBars.NumberValue = 3.0
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        GetDllLibXls().IChartErrorBars_get_NumberValue.argtypes=[c_void_p]
+        GetDllLibXls().IChartErrorBars_get_NumberValue.restype=c_double
+        ret = CallCFunction(GetDllLibXls().IChartErrorBars_get_NumberValue, self.Ptr)
+        return ret
+
+    @NumberValue.setter
+    def NumberValue(self, value:float):
+        GetDllLibXls().IChartErrorBars_set_NumberValue.argtypes=[c_void_p, c_double]
+        CallCFunction(GetDllLibXls().IChartErrorBars_set_NumberValue, self.Ptr, value)
+
+    @property
+
+    def PlusRange(self)->'IXLSRange':
+        """
+        Represents custom plus value.
+        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.ColumnClustered
+            #Get chart serie
+            serie = chart.Series[0]
+            #Enabling the Y Error bars
+            serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10)
+            errorBars = serie.ErrorBarsY
+            #Set plus range
+            errorBars.PlusRange = worksheet["D2"]
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        GetDllLibXls().IChartErrorBars_get_PlusRange.argtypes=[c_void_p]
+        GetDllLibXls().IChartErrorBars_get_PlusRange.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IChartErrorBars_get_PlusRange, self.Ptr)
+        ret = None if intPtr==None else XlsRange(intPtr)
+        return ret
+
+
+    @PlusRange.setter
+    def PlusRange(self, value:'IXLSRange'):
+        GetDllLibXls().IChartErrorBars_set_PlusRange.argtypes=[c_void_p, c_void_p]
+        CallCFunction(GetDllLibXls().IChartErrorBars_set_PlusRange, self.Ptr, value.Ptr)
+
+    @property
+
+    def MinusRange(self)->'IXLSRange':
+        """
+        Represents custom minus value.
+        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.ColumnClustered
+            #Get chart serie
+            serie = chart.Series[0]
+            #Enabling the Y Error bars
+            serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10)
+            errorBars = serie.ErrorBarsY
+            #Set minus range
+            errorBars.MinusRange = worksheet["D2"]
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        GetDllLibXls().IChartErrorBars_get_MinusRange.argtypes=[c_void_p]
+        GetDllLibXls().IChartErrorBars_get_MinusRange.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IChartErrorBars_get_MinusRange, self.Ptr)
+        ret = None if intPtr==None else XlsRange(intPtr)
+        return ret
+
+
+    @MinusRange.setter
+    def MinusRange(self, value:'IXLSRange'):
+        GetDllLibXls().IChartErrorBars_set_MinusRange.argtypes=[c_void_p, c_void_p]
+        CallCFunction(GetDllLibXls().IChartErrorBars_set_MinusRange, self.Ptr, value.Ptr)
+
+    @property
+
+    def Shadow(self)->'IShadow':
+        """
+        Gets the shadow.
+        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.ColumnClustered
+            #Get chart serie
+            serie = chart.Series[0]
+            #Enabling the Y Error bars
+            serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10)
+            errorBars = serie.ErrorBarsY
+            #Set Error bars shadow color
+            errorBars.Shadow.Color = Color.Red
+            #Set Error bars shadow outer presets
+            errorBars.Shadow.ShadowOuterType = XLSXChartShadowOuterType.OffsetDiagonalTopRight
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        GetDllLibXls().IChartErrorBars_get_Shadow.argtypes=[c_void_p]
+        GetDllLibXls().IChartErrorBars_get_Shadow.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IChartErrorBars_get_Shadow, self.Ptr)
+        ret = None if intPtr==None else ChartShadow(intPtr)
+        return ret
+
+
+    @property
+
+    def Chart3DOptions(self)->'IFormat3D':
+        """
+        Gets the chart3 D options.
+
+        """
+        GetDllLibXls().IChartErrorBars_get_Chart3DOptions.argtypes=[c_void_p]
+        GetDllLibXls().IChartErrorBars_get_Chart3DOptions.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IChartErrorBars_get_Chart3DOptions, self.Ptr)
+        ret = None if intPtr==None else Format3D(intPtr)
+        return ret
+
+
+    def ClearFormats(self):
+        """
+        Clears current error bar.
+
+        """
+        GetDllLibXls().IChartErrorBars_ClearFormats.argtypes=[c_void_p]
+        CallCFunction(GetDllLibXls().IChartErrorBars_ClearFormats, self.Ptr)
+
+    def Delete(self):
+        """
+        Delete current error bar.
+
+        """
+        GetDllLibXls().IChartErrorBars_Delete.argtypes=[c_void_p]
+        CallCFunction(GetDllLibXls().IChartErrorBars_Delete, self.Ptr)
+

spire/xls/interfaces/IChartFillBorder.py

@@ -0,0 +1,268 @@
+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 IChartFillBorder (abc.ABC) :
+    """
+    Provides formatting options for area elements in the chart.
+
+    """
+    @property
+    @abc.abstractmethod
+    def HasInterior(self)->bool:
+        """
+        This property indicates whether interior object was created. 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.Column3DClustered
+            #Create a fill border and set interior value
+            fillBorder = chart.ChartArea
+            chart.ChartArea.Interior.ForegroundColor = Color.Yellow
+            #True if the chart element has interior formatting
+            if (fillBorder.HasInterior){#Your Code Here}
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def HasLineProperties(self)->bool:
+        """
+        This property indicates whether line formatting object was created. 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.Column3DClustered
+            #Create a fill border and set line border value
+            fillBorder = chart.ChartArea
+            chart.ChartArea.Border.Color = Color.Yellow
+            #True if the chart element has line formatting
+            if (fillBorder.HasLineProperties){#Your Code Here}
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def HasFormat3D(self)->bool:
+        """
+        Gets a value indicating whether [has3d properties].
+        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.Column3DClustered
+            #Create a fill border and set 3D formatting value
+            fillBorder = chart.ChartArea
+            chart.ChartArea.Format3D.BevelTopType = XLSXChartBevelType.Slope
+            #True if the chart element has 3D formatting
+            if (fillBorder.HasFormat3D){#Your Code Here}
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def HasShadow(self)->bool:
+        """
+        Gets a value indicating whether this instance has shadow properties.
+        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.Column3DClustered
+            #Create a fill border and set line border value
+            fillBorder = chart.ChartArea
+            chart.ChartArea.Shadow.ShadowOuterType = XLSXChartShadowOuterType.OffsetBottom
+            #True if the chart element has 3D formatting
+            if (fillBorder.HasShadow){#Your Code Here}
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def LineProperties(self)->'ChartBorder':
+        """
+        Returns object, that represents line properties. 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.Column3DClustered
+            #Gets line formatting properties for the chart element
+            border = chart.PlotArea.Border
+            border.Pattern = ChartLinePatternType.DashDotDot
+            border.Color = Color.Orange
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Interior(self)->'IChartInterior':
+        """
+        Returns object, that represents area properties. 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.Column3DClustered
+            #Gets interior formatting properties for the chart element
+            chartInterior = chart.ChartArea.Interior
+            chartInterior.BackgroundColor = Color.Beige
+            chartInterior.Pattern = ExcelPatternType.DarkDownwardDiagonal
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Fill(self)->'IShapeFill':
+        """
+        Represents XlsFill options. 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.Column3DClustered
+            #Gets fill options for the chart element
+            fillChart = chart.ChartArea.Fill
+            fillChart.FillType = ShapeFillType.Gradient
+            fillChart.BackColor = Color.FromArgb(205, 217, 234)
+            fillChart.ForeColor = Color.White
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Format3D(self)->'Format3D':
+        """
+        Gets the chart3 D properties.
+        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.Column3DClustered
+            #Gets 3D-effect properties for the chart element
+            threeDFromat = chart.ChartArea.Format3D
+            threeDFromat.BevelTopType = XLSXChartBevelType.Slope
+            threeDFromat.BevelTopHeight = 16
+            threeDFromat.BevelTopWidth = 7
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Shadow(self)->'ChartShadow':
+        """
+        Gets the shadow properties.
+        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.Column3DClustered
+            #Gets shadow formatting properties for the chart element
+            shadowChart = chart.ChartArea.Shadow
+            shadowChart.ShadowPrespectiveType = XLSXChartPrespectiveType.Below
+            shadowChart.Color = Color.Aqua
+            shadowChart.Blur = 22
+            #Save to file
+            workbook.SaveToFile("Chart.xlsx")
+
+        """
+        pass
+
+