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

spire/xls/IChartAxis.py

@@ -1,722 +0,0 @@
-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 IChartAxis (abc.ABC) :
-    """
-    <summary>
-        Represents an axis on the chart.
-    </summary>
-    """
-    @property
-
-    @abc.abstractmethod
-    def NumberFormat(self)->str:
-        """
-    <summary>
-         Gets or sets number format string.
-        <example>The following code illustrates how to set currency format "$#,##0_);($#,##0)" to 
-             NumberFormat to display value in the PrimaryValueAxis as currency:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10000";
-                       worksheet.Range["B2"].Text = "20000";
-                       worksheet.Range["C2"].Text = "30000";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart value axis
-        IChartAxis chartAxis = chart.PrimaryValueAxis;
-        //Set number format
-        chartAxis.NumberFormat = @"$#,##0_);($#,##0)";
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @NumberFormat.setter
-    @abc.abstractmethod
-    def NumberFormat(self, value:str):
-        """
-
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def AxisType(self)->'AxisType':
-        """
-    <summary>
-         Returns type of the axis. Read-only.
-        <example>The following code illustrates how to access the AxisType property:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10000";
-                       worksheet.Range["B2"].Text = "20000";
-                       worksheet.Range["C2"].Text = "30000";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart value axis
-        IChartAxis chartAxis = chart.PrimaryValueAxis;
-        //Get axis type
-        Console.WriteLine(chartAxis.AxisType);
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def Title(self)->str:
-        """
-    <summary>
-         Axis title.
-        <example>The following code illustrates how to set Title for the IChart.PrimaryCategoryAxis:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart category axis
-        IChartAxis categoryAxis = chart.PrimaryCategoryAxis;
-        //Set category title
-        categoryAxis.Title = "Categories";
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @Title.setter
-    @abc.abstractmethod
-    def Title(self, value:str):
-        """
-
-        """
-        pass
-
-
-    @property
-    @abc.abstractmethod
-    def TextRotationAngle(self)->int:
-        """
-    <summary>
-         Text rotation angle. Should be integer value between -90 and 90.
-        <example>The following code illustrates how to set TextRotationAngle for 
-             IChart.PrimaryCategoryAxis:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart category axis
-        IChartAxis chartAxis =  chart.PrimaryCategoryAxis;
-        //Set text rotation angle
-        chartAxis.TextRotationAngle = 90;
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @TextRotationAngle.setter
-    @abc.abstractmethod
-    def TextRotationAngle(self, value:int):
-        """
-
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def TitleArea(self)->'IChartTextArea':
-        """
-    <summary>
-         Returns text area for the axis title. Read-only.
-        <example>The following code illustrates how to set foreground color to 
-             IChart.PrimaryCategoryAxis's title area using TitleArea property:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart category axis
-        IChartAxis categoryAxis = chart.PrimaryCategoryAxis;
-        //Set category title
-        categoryAxis.Title = "Categories";
-        //Set title area
-        IChartTextArea titleArea = categoryAxis.TitleArea;
-        //Set color
-        titleArea.FrameFormat.Fill.ForeKnownColor = ExcelColors.Red;
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def Font(self)->'IFont':
-        """
-    <summary>
-         Returns font used for axis text displaying. Read-only.
-        <example>The following code illustrates how to set font color to the 
-             IChart.PrimaryCategoryAxis's category labels using Font property:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart axis
-        IChartAxis chartAxis =  chart.PrimaryCategoryAxis;
-        //Set font color
-        chartAxis.Font.Color = Color.Red;
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def MajorGridLines(self)->'IChartGridLine':
-        """
-    <summary>
-         Represents major gridLines. Read-only.
-        <example>The following code illustrates how to access MajorGridLines of 
-             IChart.PrimaryCategoryAxis and set colors to it:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart axis
-        IChartAxis chartAxis =  chart.PrimaryCategoryAxis;
-        //Set visibility
-        chartAxis.HasMajorGridLines = true;
-        //Set grid lines
-        IChartGridLine gridLine = chartAxis.MajorGridLines;
-        gridLine.LineProperties.Color = Color.Red;
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def MinorGridLines(self)->'IChartGridLine':
-        """
-    <summary>
-         Represents minor gridLines. Read-only.
-        <example>The following code illustrates how to access MinorGridLines of 
-             IChart.PrimaryCategoryAxis and set colors to it:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart axis
-        IChartAxis chartAxis =  chart.PrimaryCategoryAxis;
-        //Set visibility
-        chartAxis.HasMinorGridLines = true;
-        //Set grid lines
-        IChartGridLine gridLine = chartAxis.MinorGridLines;
-        gridLine.LineProperties.Color = Color.Red;
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @property
-    @abc.abstractmethod
-    def HasMinorGridLines(self)->bool:
-        """
-    <summary>
-         Gets or sets if axis has minor gridlines.
-        <example>The following code illustrates how to set visibility of MinorGridLines of 
-             IChart.PrimaryCategoryAxis:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart axis
-        IChartAxis chartAxis =  chart.PrimaryCategoryAxis;
-        //Set visibility
-        chartAxis.HasMinorGridLines = true;
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @HasMinorGridLines.setter
-    @abc.abstractmethod
-    def HasMinorGridLines(self, value:bool):
-        """
-
-        """
-        pass
-
-
-    @property
-    @abc.abstractmethod
-    def HasMajorGridLines(self)->bool:
-        """
-    <summary>
-         Gets or sets if axis has major gridlines.
-        <example>The following code illustrates how to set visibility of MajorGridLines of 
-             IChart.PrimaryCategoryAxis:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart axis
-        IChartAxis chartAxis =  chart.PrimaryCategoryAxis;
-        //Set visibility
-        chartAxis.HasMajorGridLines = true;
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @HasMajorGridLines.setter
-    @abc.abstractmethod
-    def HasMajorGridLines(self, value:bool):
-        """
-
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def MinorTickMark(self)->'TickMarkType':
-        """
-    <summary>
-         Represents minor tick marks.
-        <example>The following code illustrates how to set TickMarkType.TickMarkCross to MinorTickMark:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart category axis
-        IChartAxis categoryAxis = chart.PrimaryCategoryAxis;
-        //Set category minor tick type
-        categoryAxis.MinorTickMark = TickMarkType.TickMarkCross;
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @MinorTickMark.setter
-    @abc.abstractmethod
-    def MinorTickMark(self, value:'TickMarkType'):
-        """
-
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def MajorTickMark(self)->'TickMarkType':
-        """
-    <summary>
-         Represents major tick marks.
-        <example>The following code illustrates how to set TickMarkType.TickMarkCross to MajorTickMark:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart category axis
-        IChartAxis categoryAxis = chart.PrimaryCategoryAxis;
-        //Set category minor tick type
-        categoryAxis.MajorTickMark = TickMarkType.TickMarkCross;
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @MajorTickMark.setter
-    @abc.abstractmethod
-    def MajorTickMark(self, value:'TickMarkType'):
-        """
-
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def Border(self)->'ChartBorder':
-        """
-    <summary>
-         Represents chart border. Read only.
-        <example>The following code illustrates how to set color to IChart.PrimaryCategoryAxis's 
-             border using Border property:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart category axis
-        IChartAxis categoryAxis = chart.PrimaryCategoryAxis;
-        //Set border and color
-        IChartBorder border = categoryAxis.Border;
-        border.Color = Color.Red;
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def TickLabelPosition(self)->'TickLabelPositionType':
-        """
-    <summary>
-         Represents tick label position.
-        <example>The following code illustrates how to set TickLabelPositionType.TickLabelPositionHigh 
-             to TickLabelPosition property:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart category axis
-        IChartAxis categoryAxis = chart.PrimaryCategoryAxis;
-        //Set category tick labels position
-        categoryAxis.TickLabelPosition = TickLabelPositionType.TickLabelPositionHigh;
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @TickLabelPosition.setter
-    @abc.abstractmethod
-    def TickLabelPosition(self, value:'TickLabelPositionType'):
-        """
-
-        """
-        pass
-
-
-    @property
-    @abc.abstractmethod
-    def Visible(self)->bool:
-        """
-    <summary>
-         Indicates is axis is visible.
-        <example>The following code illustrates how to set visibility of IChart.PrimaryCategoryAxis:
-        <code>
-        //Create worksheet
-        Workbook workbook = new Workbook();
-        Worksheet worksheet = workbook.Worksheets[0];
-        //Add data
-        worksheet.Range["A1"].Text = "Jan";
-                       worksheet.Range["B1"].Text = "Feb";
-                       worksheet.Range["C1"].Text = "Mar";
-                       worksheet.Range["A2"].Text = "10";
-                       worksheet.Range["B2"].Text = "20";
-                       worksheet.Range["C2"].Text = "30";
-        //Create chart and set range
-        Chart chart = worksheet.Charts.Add();
-        chart.DataRange = worksheet.Range["A1:C2"];
-        //Set chart axis
-        IChartAxis chartAxis =  chart.PrimaryCategoryAxis;
-        //Set visibility
-        chartAxis.Visible = false;
-        //Save to file
-        workbook.SaveToFile("Chart.xlsx");
-        </code>
-        </example>
-    </summary>
-        """
-        pass
-
-
-    @Visible.setter
-    @abc.abstractmethod
-    def Visible(self, value:bool):
-        """
-
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def Alignment(self)->'AxisTextDirectionType':
-        """
-    <summary>
-        Represents alignment for the tick label.
-    </summary>
-        """
-        pass
-
-
-    @Alignment.setter
-    @abc.abstractmethod
-    def Alignment(self, value:'AxisTextDirectionType'):
-        """
-
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def Shadow(self)->'ChartShadow':
-        """
-    <summary>
-        Returns the Shadow properties.Read-only.
-    </summary>
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def Chart3DOptions(self)->'IFormat3D':
-        """
-    <summary>
-        Gets the three_ D.
-    </summary>
-<value>The three_ D.</value>
-        """
-        pass
-
-
-    @property
-    @abc.abstractmethod
-    def IsSourceLinked(self)->bool:
-        """
-
-        """
-        pass
-
-
-    @IsSourceLinked.setter
-    @abc.abstractmethod
-    def IsSourceLinked(self, value:bool):
-        """
-
-        """
-        pass
-
-
-    @property
-
-    @abc.abstractmethod
-    def TextDirection(self)->'TextVerticalValue':
-        """
-    <summary>
-        axis's text direction
-    </summary>
-        """
-        pass
-
-
-    @TextDirection.setter
-    @abc.abstractmethod
-    def TextDirection(self, value:'TextVerticalValue'):
-        """
-
-        """
-        pass
-
-