spire-xls 15.5.0__py3-none-win_amd64.whl

spire/xls/IChartDataTable.py

@@ -0,0 +1,197 @@
+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 IChartDataTable (  IFont, IExcelApplication, IOptimizedUpdate) :
+    """
+    <summary>
+        Represents the chart data table.
+    </summary>
+    """
+    @property
+    @abc.abstractmethod
+    def HasHorzBorder(self)->bool:
+        """
+    <summary>
+        True if data table has horizontal border.
+            <example>The following code illustrates how to remove horizontal border for IChartDataTable object:
+            <code>
+        //Create worksheet
+        Workbook workbook = new Workbook();
+        workbook.LoadFromFile("Sample.xlsx");
+        Worksheet worksheet = workbook.Worksheets[0];
+        //Create chart and set range
+        IChart chart = worksheet.Charts.Add();
+        chart.DataRange = worksheet.Range["A1:F2"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.ColumnClustered;
+        //Enabling the data table
+        chart.HasDataTable = true;
+        //Get data table of the chart
+        IChartDataTable dataTable = chart.DataTable;
+        //Set false to remove the horizontal border in data table
+        dataTable.HasHorzBorder = false;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @HasHorzBorder.setter
+    @abc.abstractmethod
+    def HasHorzBorder(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def HasVertBorder(self)->bool:
+        """
+    <summary>
+        True if data table has vertical border.
+            <example>The following code illustrates how to remove vertical border for IChartDataTable object:
+            <code>
+        //Create worksheet
+        Workbook workbook = new Workbook();
+        workbook.LoadFromFile("Sample.xlsx");
+        Worksheet worksheet = workbook.Worksheets[0];
+        //Create chart and set range
+        IChart chart = worksheet.Charts.Add();
+        chart.DataRange = worksheet.Range["A1:F2"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.ColumnClustered;
+        //Enabling the data table
+        chart.HasDataTable = true;
+        //Get data table of the chart
+        IChartDataTable dataTable = chart.DataTable;
+        //Set false to remove the vertical border in data table
+        dataTable.HasVertBorder = false;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @HasVertBorder.setter
+    @abc.abstractmethod
+    def HasVertBorder(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def HasBorders(self)->bool:
+        """
+    <summary>
+        True if data table has borders.
+            <example>The following code illustrates how to outline borders of IChartDataTable object:
+            <code>
+        //Create worksheet
+        Workbook workbook = new Workbook();
+        workbook.LoadFromFile("Sample.xlsx");
+        Worksheet worksheet = workbook.Worksheets[0];
+        //Create chart and set range
+        IChart chart = worksheet.Charts.Add();
+        chart.DataRange = worksheet.Range["A1:F2"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.ColumnClustered;
+        //Enabling the data table
+        chart.HasDataTable = true;
+        //Get data table of the chart
+        IChartDataTable dataTable = chart.DataTable;
+        //Set false to remove the borders in data table
+        dataTable.HasBorders = false;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @HasBorders.setter
+    @abc.abstractmethod
+    def HasBorders(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def ShowSeriesKeys(self)->bool:
+        """
+    <summary>
+        True if there is series keys in the data table.
+            <example>The following code illustrates how to show series keys in the IChartDataTable object:
+            <code>
+        //Create worksheet
+        Workbook workbook = new Workbook();
+        workbook.LoadFromFile("Sample.xlsx");
+        Worksheet worksheet = workbook.Worksheets[0];
+        //Create chart and set range
+        IChart chart = worksheet.Charts.Add();
+        chart.DataRange = worksheet.Range["A1:F2"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.ColumnClustered;
+        //Enabling the data table
+        chart.HasDataTable = true;
+        //Get data table of the chart
+        IChartDataTable dataTable = chart.DataTable;
+        //Set true to show series keys in the data table
+        dataTable.ShowSeriesKeys = true;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @ShowSeriesKeys.setter
+    @abc.abstractmethod
+    def ShowSeriesKeys(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def BackgroundMode(self)->'ChartBackgroundMode':
+        """
+
+        """
+        pass
+
+
+    @BackgroundMode.setter
+    @abc.abstractmethod
+    def BackgroundMode(self, value:'ChartBackgroundMode'):
+        """
+
+        """
+        pass
+
+

spire/xls/IChartDropBar.py

@@ -0,0 +1,12 @@
+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 IChartDropBar (  IChartFillBorder) :
+    """
+
+    """

spire/xls/IChartErrorBars.py

@@ -0,0 +1,373 @@
+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.XlsChartBorder import *
+from ctypes import *
+import abc
+
+class IChartErrorBars (SpireObject) :
+    """
+    <summary>
+        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.
+    </summary>
+    """
+    @property
+
+    def Border(self)->'IChartBorder':
+        """
+    <summary>
+        Represents border object. Read only.
+            <example>The following code illustrates how to access and format the IChartBorder for IChartErrorBars:
+            <code>
+        //Create worksheet
+        Workbook workbook = new Workbook();
+        workbook.LoadFromFile("Sample.xlsx");
+        Worksheet worksheet = workbook.Worksheets[0];
+        //Create chart and set range
+        IChart chart = worksheet.Charts.Add();
+        chart.DataRange = worksheet.Range["A1:C3"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.ColumnClustered;
+        //Get chart serie
+        IChartSerie serie = chart.Series[0];
+        //Enabling the Y Error bars
+        serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
+        IChartErrorBars errorBars = serie.ErrorBarsY;
+        //Set Error bars border color
+        errorBars.Border.Color = Color.Red;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        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':
+        """
+    <summary>
+        Reprsents error bar include type.
+            <example>The following code illustrates how to set include type for IChartErrorBars:
+            <code>
+        //Create worksheet
+        Workbook workbook = new Workbook();
+        workbook.LoadFromFile("Sample.xlsx");
+        Worksheet worksheet = workbook.Worksheets[0];
+        //Create chart and set range
+        IChart chart = worksheet.Charts.Add();
+        chart.DataRange = worksheet.Range["A1:C3"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.ColumnClustered;
+        //Get chart serie
+        IChartSerie serie = chart.Series[0];
+        //Enabling the Y Error bars
+        serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
+        IChartErrorBars errorBars = serie.ErrorBarsY;
+        //Set negative error only to include
+        errorBars.Include = ErrorBarIncludeType.Minus;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        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:
+        """
+    <summary>
+        Indicates if error bar has cap.
+            <example>The following code illustrates how to remove end style for IChartErrorBars:
+            <code>
+        //Create worksheet
+        Workbook workbook = new Workbook();
+        workbook.LoadFromFile("Sample.xlsx");
+        Worksheet worksheet = workbook.Worksheets[0];
+        //Create chart and set range
+        IChart chart = worksheet.Charts.Add();
+        chart.DataRange = worksheet.Range["A1:C3"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.ColumnClustered;
+        //Get chart serie
+        IChartSerie serie = chart.Series[0];
+        //Enabling the Y Error bars
+        serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
+        IChartErrorBars errorBars = serie.ErrorBarsY;
+        //Set false to remove the end style
+        errorBars.HasCap = false;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        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':
+        """
+    <summary>
+        Represents excel error bar type.
+            <example>The following code illustrates how to set the error bar type for IChartErrorBars:
+            <code>
+        //Create worksheet
+        Workbook workbook = new Workbook();
+        workbook.LoadFromFile("Sample.xlsx");
+        Worksheet worksheet = workbook.Worksheets[0];
+        //Create chart and set range
+        IChart chart = worksheet.Charts.Add();
+        chart.DataRange = worksheet.Range["A1:C3"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.ColumnClustered;
+        //Get chart serie
+        IChartSerie serie = chart.Series[0];
+        //Enabling the Y Error bars
+        serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
+        IChartErrorBars errorBars = serie.ErrorBarsY;
+        //Set error amount to standard deviation
+        errorBars.Type = ErrorBarType.StandardDeviation;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        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:
+        """
+    <summary>
+        Represents number value.
+            <example>The following code illustrates how to set the error value for IChartErrorBars:
+            <code>
+        //Create worksheet
+        Workbook workbook = new Workbook();
+        workbook.LoadFromFile("Sample.xlsx");
+        Worksheet worksheet = workbook.Worksheets[0];
+        //Create chart and set range
+        IChart chart = worksheet.Charts.Add();
+        chart.DataRange = worksheet.Range["A1:C3"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.ColumnClustered;
+        //Get chart serie
+        IChartSerie serie = chart.Series[0];
+        //Enabling the Y Error bars
+        serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
+        IChartErrorBars errorBars = serie.ErrorBarsY;
+        //Set error value
+        errorBars.NumberValue = 3.0;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        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':
+        """
+    <summary>
+        Represents custom plus value.
+            <example>The following code illustrates how to set the plus range for IChartErrorBars:
+            <code>
+        //Create worksheet
+        Workbook workbook = new Workbook();
+        workbook.LoadFromFile("Sample.xlsx");
+        Worksheet worksheet = workbook.Worksheets[0];
+        //Create chart and set range
+        IChart chart = worksheet.Charts.Add();
+        chart.DataRange = worksheet.Range["A1:C3"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.ColumnClustered;
+        //Get chart serie
+        IChartSerie serie = chart.Series[0];
+        //Enabling the Y Error bars
+        serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
+        IChartErrorBars errorBars = serie.ErrorBarsY;
+        //Set plus range
+        errorBars.PlusRange = worksheet["D2"];
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        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':
+        """
+    <summary>
+        Represents custom minus value.
+            <example>The following code illustrates how to set the minus range for IChartErrorBars:
+            <code>
+        //Create worksheet
+        Workbook workbook = new Workbook();
+        workbook.LoadFromFile("Sample.xlsx");
+        Worksheet worksheet = workbook.Worksheets[0];
+        //Create chart and set range
+        IChart chart = worksheet.Charts.Add();
+        chart.DataRange = worksheet.Range["A1:C3"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.ColumnClustered;
+        //Get chart serie
+        IChartSerie serie = chart.Series[0];
+        //Enabling the Y Error bars
+        serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
+        IChartErrorBars errorBars = serie.ErrorBarsY;
+        //Set minus range
+        errorBars.MinusRange = worksheet["D2"];
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        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':
+        """
+    <summary>
+        Gets the shadow.
+            <example>The following code illustrates how to access and format the IShadow for IChartErrorBars:
+            <code>
+        //Create worksheet
+        Workbook workbook = new Workbook();
+        workbook.LoadFromFile("Sample.xlsx");
+        Worksheet worksheet = workbook.Worksheets[0];
+        //Create chart and set range
+        IChart chart = worksheet.Charts.Add();
+        chart.DataRange = worksheet.Range["A1:C3"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.ColumnClustered;
+        //Get chart serie
+        IChartSerie serie = chart.Series[0];
+        //Enabling the Y Error bars
+        serie.ErrorBar(true,ErrorBarIncludeType.Both,ErrorBarType.Percentage,10);
+        IChartErrorBars 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");
+        </code>
+        </example>
+    </summary>
+<value>The shadow.</value>
+        """
+        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':
+        """
+    <summary>
+        Gets the chart3 D options.
+    </summary>
+<value>The chart3 D options.</value>
+        """
+        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):
+        """
+    <summary>
+        Clears current error bar.
+    </summary>
+        """
+        GetDllLibXls().IChartErrorBars_ClearFormats.argtypes=[c_void_p]
+        CallCFunction(GetDllLibXls().IChartErrorBars_ClearFormats, self.Ptr)
+
+    def Delete(self):
+        """
+    <summary>
+        Delete current error bar.
+    </summary>
+        """
+        GetDllLibXls().IChartErrorBars_Delete.argtypes=[c_void_p]
+        CallCFunction(GetDllLibXls().IChartErrorBars_Delete, self.Ptr)
+