spire-xls 15.5.0__py3-none-macosx_10_7_universal.whl

spire/xls/IChartFormat.py

@@ -0,0 +1,571 @@
+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) :
+    """
+    <summary>
+        Provides access to the formatting options for chart elements.
+    </summary>
+    """
+    @property
+    @abc.abstractmethod
+    def IsVaryColor(self)->bool:
+        """
+    <summary>
+        Vary color for each data point.
+            <example>The following code illustrates how to set IsVaryColor for charts:
+            <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:C2"];
+        //Set chart format
+        IChartFormat format = chart.Series[0].Format.Options;
+        //Set vary color
+        format.IsVaryColor = true;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @IsVaryColor.setter
+    @abc.abstractmethod
+    def IsVaryColor(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Overlap(self)->int:
+        """
+    <summary>
+        Space between bars ( -100 : 100 ).
+            <example>The following code illustrates how to set Overlap for charts:
+            <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.ColumnStacked;
+        //Set chart format
+        IChartFormat format = chart.Series[0].Format.Options;
+        //Set overlap
+        format.Overlap = 20;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @Overlap.setter
+    @abc.abstractmethod
+    def Overlap(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def GapWidth(self)->int:
+        """
+    <summary>
+        Space between categories (percent of bar width), default = 50.
+            <example>The following code illustrates how to set GapWidth for ExcelChartType.Column3DStacked chart:
+            <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.Column3DStacked;
+        //Set chart format
+        IChartFormat format = chart.Series[0].Format.Options;
+        //Set Gap width
+        format.GapWidth = 400;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @GapWidth.setter
+    @abc.abstractmethod
+    def GapWidth(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def FirstSliceAngle(self)->int:
+        """
+    <summary>
+        Angle of the first pie slice expressed in degrees. ( 0 - 360 ).
+            <example>The following code illustrates how to set FirstSliceAngle for ExcelChartType.Pie chart:
+            <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:C2"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.Pie;
+        //Set chart format
+        IChartFormat format = chart.Series[0].Format.Options;
+        //Set Gap width
+        format.FirstSliceAngle = 60;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @FirstSliceAngle.setter
+    @abc.abstractmethod
+    def FirstSliceAngle(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def DoughnutHoleSize(self)->int:
+        """
+    <summary>
+        Size of center hole in a doughnut chart (as a percentage).( 10 - 90 ).
+            <example>The following code illustrates how to set DoughnutHoleSize for ExcelChartType.Doughnut chart:
+            <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:C2"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.Doughnut;
+        //Set chart format
+        IChartFormat format = chart.Series[0].Format.Options;
+        //Set Doughnut hole size
+        format.DoughnutHoleSize = 60;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @DoughnutHoleSize.setter
+    @abc.abstractmethod
+    def DoughnutHoleSize(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def BubbleScale(self)->int:
+        """
+    <summary>
+        Percent of largest bubble compared to chart in general. ( 0 - 300 ).
+            <example>The following code illustrates how to set BubbleScale for ExcelChartType.Bubble3D chart:
+            <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(ExcelChartType.Bubble3D);
+        chart.DataRange = worksheet.Range["A1:C2"];
+        chart.Series[0].Bubbles = worksheet.Range["A2:C3"];
+        //Set chart format
+        IChartFormat format = chart.Series[0].Format.Options;
+        //Set bubble scale
+        format.BubbleScale = 50;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @BubbleScale.setter
+    @abc.abstractmethod
+    def BubbleScale(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def SizeRepresents(self)->'BubbleSizeType':
+        """
+    <summary>
+        Returns or sets what the bubble size represents on a bubble chart.
+            <example>The following code illustrates how to set BubbleSizeType.Width to SizeRepresents property:
+            <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(ExcelChartType.Bubble3D);
+        chart.DataRange = worksheet.Range["A1:C2"];
+        chart.Series[0].Bubbles = worksheet.Range["A2:C3"];
+        //Set chart format
+        IChartFormat 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");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @SizeRepresents.setter
+    @abc.abstractmethod
+    def SizeRepresents(self, value:'BubbleSizeType'):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def ShowNegativeBubbles(self)->bool:
+        """
+    <summary>
+        True to show negative bubbles.
+            <example>The following code illustrates how to load negative values to 
+            ExcelChartType.Bubble3D chart value axis and set ShowNegativeBubbles to "true":
+            <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(ExcelChartType.Bubble3D);
+        chart.DataRange = worksheet.Range["A1:D2"];
+        chart.Series[0].Bubbles = worksheet.Range["A2:C3"];
+        //Set chart format
+        IChartFormat format = chart.Series[0].Format.Options;
+        //Set negative bubble visibility
+        format.ShowNegativeBubbles = true;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @ShowNegativeBubbles.setter
+    @abc.abstractmethod
+    def ShowNegativeBubbles(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def HasRadarAxisLabels(self)->bool:
+        """
+    <summary>
+        True if a radar chart has axis labels. Applies only to radar charts.
+            <example>The following code illustrates how to hide the axis labels of radar charts:
+            <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:C2"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.Radar;
+        //Set chart format
+        IChartFormat format = chart.Series[0].Format.Options;
+        //Set radar label visibility
+        format.HasRadarAxisLabels = false;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @HasRadarAxisLabels.setter
+    @abc.abstractmethod
+    def HasRadarAxisLabels(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def SplitType(self)->'SplitType':
+        """
+    <summary>
+        Returns or sets the way the two sections of either a pie of pie chart or a bar
+            of pie chart are split.
+            <example>The following code illustrates how to set SplitType.Value to SplitType:
+            <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.PieOfPie;
+        //Set chart format
+        IChartFormat format = chart.Series[0].Format.Options;
+        //Set split type
+        format.SplitType = SplitType.Value;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @SplitType.setter
+    @abc.abstractmethod
+    def SplitType(self, value:'SplitType'):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def SplitValue(self)->int:
+        """
+    <summary>
+        Returns or sets the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart.
+            <example>The following code illustrates how to set SplitValue for charts:
+            <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.PieOfPie;
+        //Set chart format
+        IChartFormat format = chart.Series[0].Format.Options;
+        //Set split value
+        format.SplitValue = 20;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @SplitValue.setter
+    @abc.abstractmethod
+    def SplitValue(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def PieSecondSize(self)->int:
+        """
+    <summary>
+        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>The following code illustrates how to set PieSecondSize for charts:
+            <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.PieOfPie;
+        //Set chart format
+        IChartFormat format = chart.Series[0].Format.Options;
+        //Set second pie size
+        format.PieSecondSize = 40;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @PieSecondSize.setter
+    @abc.abstractmethod
+    def PieSecondSize(self, value:int):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def FirstDropBar(self)->'IChartDropBar':
+        """
+    <summary>
+        Returns object that represents first drop bar.
+            <example>The following code illustrates how to access FirstDropBar:
+            <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.Line;
+        //Set chart drop bar
+        IChartDropBar dropBar = chart.Series[0].Format.Options.FirstDropBar;
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def SecondDropBar(self)->'IChartDropBar':
+        """
+    <summary>
+        Returns object that represents second drop bar.
+            <example>The following code illustrates how to access SecondDropBar:
+            <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.Line;
+        //Set chart first drop bar
+        IChartDropBar dropBar = chart.Series[0].Format.Options.FirstDropBar;
+        //Set chart second drop bar
+        dropBar = chart.Series[0].Format.Options.SecondDropBar;
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def PieSeriesLine(self)->'IChartBorder':
+        """
+    <summary>
+        Represents series line properties. ( For pie of pie or pie of bar chart types only. ) Read only.
+            <example>The following code illusrates how to set color to IChartBorder.Color property for 
+            ExcelChartType.PieOfPie chart using PieSeriesLine property:
+            <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.PieOfPie;
+        //Set pie series line border
+        IChartBorder border =  chart.Series[0].Format.Options.PieSeriesLine;
+        //Set color
+        border.Color = Color.Red;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+

spire/xls/IChartFrameFormat.py

@@ -0,0 +1,93 @@
+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) :
+    """
+    <summary>
+        Represent the borders and layout options of the chart elements.
+    </summary>
+    """
+    @property
+    @abc.abstractmethod
+    def IsBorderCornersRound(self)->bool:
+        """
+    <summary>
+        Gets or sets flag if border corners is round.
+            <example>The following code illustrates use of IsBorderCornersRound property:
+            <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["B2:C6"];
+        //Set chart type
+        chart.ChartType = ExcelChartType.Cone3DClustered;
+        //True if the chart area has rounded corners
+        IChartFrameFormat chartArea = chart.ChartArea;
+        chartArea.IsBorderCornersRound = true;
+        //Save to file
+        workbook.SaveToFile("Chart.xlsx");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @IsBorderCornersRound.setter
+    @abc.abstractmethod
+    def IsBorderCornersRound(self, value:bool):
+        """
+
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Border(self)->'IChartBorder':
+        """
+    <summary>
+        Represents chart border. Read only.
+            <example>The following code illustrates use of Border property:
+            <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["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");
+        </code>
+        </example>
+    </summary>
+        """
+        pass
+
+
+    @abc.abstractmethod
+    def Clear(self):
+        """
+    <summary>
+        Clear curent plot area.
+    </summary>
+        """
+        pass
+
+