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

spire/xls/Format3D.py

@@ -7,14 +7,20 @@ from ctypes import *
 import abc
 
 class Format3D (  XlsObject, IFormat3D, ICloneParent) :
-    """
-
+    """Represents 3D formatting for Excel objects.
+    
+    This class provides properties and methods to manipulate 3D formatting effects
+    for Excel objects such as shapes, charts, and other elements. It allows control
+    over bevels, lighting, materials, extrusion, and contours to create sophisticated
+    3D visual effects.
     """
     @property
 
     def BevelTopType(self)->'XLSXChartBevelType':
-        """
-
+        """Gets the bevel type for the top surface of the 3D object.
+        
+        Returns:
+            XLSXChartBevelType: An enumeration value representing the bevel type for the top surface.
         """
         GetDllLibXls().Format3D_get_BevelTopType.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_BevelTopType.restype=c_int
@@ -24,14 +30,21 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @BevelTopType.setter
     def BevelTopType(self, value:'XLSXChartBevelType'):
+        """Sets the bevel type for the top surface of the 3D object.
+        
+        Args:
+            value (XLSXChartBevelType): An enumeration value representing the bevel type for the top surface.
+        """
         GetDllLibXls().Format3D_set_BevelTopType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().Format3D_set_BevelTopType, self.Ptr, value.value)
 
     @property
 
     def BevelBottomType(self)->'XLSXChartBevelType':
-        """
-
+        """Gets the bevel type for the bottom surface of the 3D object.
+        
+        Returns:
+            XLSXChartBevelType: An enumeration value representing the bevel type for the bottom surface.
         """
         GetDllLibXls().Format3D_get_BevelBottomType.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_BevelBottomType.restype=c_int
@@ -41,14 +54,21 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @BevelBottomType.setter
     def BevelBottomType(self, value:'XLSXChartBevelType'):
+        """Sets the bevel type for the bottom surface of the 3D object.
+        
+        Args:
+            value (XLSXChartBevelType): An enumeration value representing the bevel type for the bottom surface.
+        """
         GetDllLibXls().Format3D_set_BevelBottomType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().Format3D_set_BevelBottomType, self.Ptr, value.value)
 
     @property
 
     def MaterialType(self)->'XLSXChartMaterialType':
-        """
-
+        """Gets the material type of the 3D object.
+        
+        Returns:
+            XLSXChartMaterialType: An enumeration value representing the material type.
         """
         GetDllLibXls().Format3D_get_MaterialType.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_MaterialType.restype=c_int
@@ -58,14 +78,21 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @MaterialType.setter
     def MaterialType(self, value:'XLSXChartMaterialType'):
+        """Sets the material type of the 3D object.
+        
+        Args:
+            value (XLSXChartMaterialType): An enumeration value representing the material type.
+        """
         GetDllLibXls().Format3D_set_MaterialType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().Format3D_set_MaterialType, self.Ptr, value.value)
 
     @property
 
     def LightingType(self)->'XLSXChartLightingType':
-        """
-
+        """Gets the lighting type applied to the 3D object.
+        
+        Returns:
+            XLSXChartLightingType: An enumeration value representing the lighting type.
         """
         GetDllLibXls().Format3D_get_LightingType.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_LightingType.restype=c_int
@@ -75,13 +102,20 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @LightingType.setter
     def LightingType(self, value:'XLSXChartLightingType'):
+        """Sets the lighting type applied to the 3D object.
+        
+        Args:
+            value (XLSXChartLightingType): An enumeration value representing the lighting type.
+        """
         GetDllLibXls().Format3D_set_LightingType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibXls().Format3D_set_LightingType, self.Ptr, value.value)
 
     @property
     def BevelTopWidth(self)->float:
-        """
-
+        """Gets the width of the top bevel in points.
+        
+        Returns:
+            float: The width of the top bevel in points.
         """
         GetDllLibXls().Format3D_get_BevelTopWidth.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_BevelTopWidth.restype=c_double
@@ -90,13 +124,20 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @BevelTopWidth.setter
     def BevelTopWidth(self, value:float):
+        """Sets the width of the top bevel in points.
+        
+        Args:
+            value (float): The width of the top bevel in points.
+        """
         GetDllLibXls().Format3D_set_BevelTopWidth.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibXls().Format3D_set_BevelTopWidth, self.Ptr, value)
 
     @property
     def BevelTopHeight(self)->float:
-        """
-
+        """Gets the height of the top bevel in points.
+        
+        Returns:
+            float: The height of the top bevel in points.
         """
         GetDllLibXls().Format3D_get_BevelTopHeight.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_BevelTopHeight.restype=c_double
@@ -105,13 +146,20 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @BevelTopHeight.setter
     def BevelTopHeight(self, value:float):
+        """Sets the height of the top bevel in points.
+        
+        Args:
+            value (float): The height of the top bevel in points.
+        """
         GetDllLibXls().Format3D_set_BevelTopHeight.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibXls().Format3D_set_BevelTopHeight, self.Ptr, value)
 
     @property
     def BevelBottomWidth(self)->float:
-        """
-
+        """Gets the width of the bottom bevel in points.
+        
+        Returns:
+            float: The width of the bottom bevel in points.
         """
         GetDllLibXls().Format3D_get_BevelBottomWidth.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_BevelBottomWidth.restype=c_double
@@ -120,13 +168,20 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @BevelBottomWidth.setter
     def BevelBottomWidth(self, value:float):
+        """Sets the width of the bottom bevel in points.
+        
+        Args:
+            value (float): The width of the bottom bevel in points.
+        """
         GetDllLibXls().Format3D_set_BevelBottomWidth.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibXls().Format3D_set_BevelBottomWidth, self.Ptr, value)
 
     @property
     def BevelBottomHeight(self)->float:
-        """
-
+        """Gets the height of the bottom bevel in points.
+        
+        Returns:
+            float: The height of the bottom bevel in points.
         """
         GetDllLibXls().Format3D_get_BevelBottomHeight.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_BevelBottomHeight.restype=c_double
@@ -135,13 +190,20 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @BevelBottomHeight.setter
     def BevelBottomHeight(self, value:float):
+        """Sets the height of the bottom bevel in points.
+        
+        Args:
+            value (float): The height of the bottom bevel in points.
+        """
         GetDllLibXls().Format3D_set_BevelBottomHeight.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibXls().Format3D_set_BevelBottomHeight, self.Ptr, value)
 
     @property
     def ExtrusionHeight(self)->float:
-        """
-
+        """Gets the extrusion height of the 3D object in points.
+        
+        Returns:
+            float: The extrusion height in points.
         """
         GetDllLibXls().Format3D_get_ExtrusionHeight.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_ExtrusionHeight.restype=c_double
@@ -150,14 +212,21 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @ExtrusionHeight.setter
     def ExtrusionHeight(self, value:float):
+        """Sets the extrusion height of the 3D object in points.
+        
+        Args:
+            value (float): The extrusion height in points.
+        """
         GetDllLibXls().Format3D_set_ExtrusionHeight.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibXls().Format3D_set_ExtrusionHeight, self.Ptr, value)
 
     @property
 
     def ExtrusionColor(self)->'Color':
-        """
-
+        """Gets the color of the extrusion effect.
+        
+        Returns:
+            Color: A Color object representing the extrusion color.
         """
         GetDllLibXls().Format3D_get_ExtrusionColor.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_ExtrusionColor.restype=c_void_p
@@ -168,13 +237,20 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @ExtrusionColor.setter
     def ExtrusionColor(self, value:'Color'):
+        """Sets the color of the extrusion effect.
+        
+        Args:
+            value (Color): A Color object representing the extrusion color.
+        """
         GetDllLibXls().Format3D_set_ExtrusionColor.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().Format3D_set_ExtrusionColor, self.Ptr, value.Ptr)
 
     @property
     def ContourWidth(self)->float:
-        """
-
+        """Gets the width of the contour effect in points.
+        
+        Returns:
+            float: The contour width in points.
         """
         GetDllLibXls().Format3D_get_ContourWidth.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_ContourWidth.restype=c_double
@@ -183,14 +259,21 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @ContourWidth.setter
     def ContourWidth(self, value:float):
+        """Sets the width of the contour effect in points.
+        
+        Args:
+            value (float): The contour width in points.
+        """
         GetDllLibXls().Format3D_set_ContourWidth.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibXls().Format3D_set_ContourWidth, self.Ptr, value)
 
     @property
 
     def ContourColor(self)->'Color':
-        """
-
+        """Gets the color of the contour effect.
+        
+        Returns:
+            Color: A Color object representing the contour color.
         """
         GetDllLibXls().Format3D_get_ContourColor.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_ContourColor.restype=c_void_p
@@ -201,13 +284,20 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @ContourColor.setter
     def ContourColor(self, value:'Color'):
+        """Sets the color of the contour effect.
+        
+        Args:
+            value (Color): A Color object representing the contour color.
+        """
         GetDllLibXls().Format3D_set_ContourColor.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibXls().Format3D_set_ContourColor, self.Ptr, value.Ptr)
 
     @property
     def LightingAngle(self)->float:
-        """
-
+        """Gets the angle of the lighting effect in degrees.
+        
+        Returns:
+            float: The lighting angle in degrees.
         """
         GetDllLibXls().Format3D_get_LightingAngle.argtypes=[c_void_p]
         GetDllLibXls().Format3D_get_LightingAngle.restype=c_double
@@ -216,13 +306,23 @@ class Format3D (  XlsObject, IFormat3D, ICloneParent) :
 
     @LightingAngle.setter
     def LightingAngle(self, value:float):
+        """Sets the angle of the lighting effect in degrees.
+        
+        Args:
+            value (float): The lighting angle in degrees.
+        """
         GetDllLibXls().Format3D_set_LightingAngle.argtypes=[c_void_p, c_double]
         CallCFunction(GetDllLibXls().Format3D_set_LightingAngle, self.Ptr, value)
 
 
     def Clone(self ,parent:'SpireObject')->'SpireObject':
-        """
-
+        """Creates a clone of this Format3D object.
+        
+        Args:
+            parent (SpireObject): The parent object for the cloned Format3D object.
+            
+        Returns:
+            SpireObject: A new Format3D object that is a copy of this instance.
         """
         intPtrparent:c_void_p = parent.Ptr
 

spire/xls/GeomertyAdjustValue.py

@@ -7,14 +7,20 @@ from ctypes import *
 import abc
 
 class GeomertyAdjustValue (SpireObject) :
-    """
-
+    """Represents a geometry adjustment value for shapes in Excel.
+    
+    This class provides properties and methods for manipulating geometry
+    adjustment values, which control the appearance of adjustable shapes
+    in Excel. It allows for setting formulas and parameters that define
+    how shapes can be adjusted.
     """
     @property
 
     def Name(self)->str:
-        """
-
+        """Gets the name of the geometry adjustment value.
+        
+        Returns:
+            str: The name of the geometry adjustment value.
         """
         GetDllLibXls().GeomertyAdjustValue_get_Name.argtypes=[c_void_p]
         GetDllLibXls().GeomertyAdjustValue_get_Name.restype=c_void_p
@@ -25,8 +31,10 @@ class GeomertyAdjustValue (SpireObject) :
     @property
 
     def Formula(self)->str:
-        """
-
+        """Gets the formula of the geometry adjustment value.
+        
+        Returns:
+            str: The formula string that defines the geometry adjustment.
         """
         GetDllLibXls().GeomertyAdjustValue_get_Formula.argtypes=[c_void_p]
         GetDllLibXls().GeomertyAdjustValue_get_Formula.restype=c_void_p
@@ -36,8 +44,10 @@ class GeomertyAdjustValue (SpireObject) :
 
 
     def SetFormulaParameter(self ,args:List[float]):
-        """
-
+        """Sets the parameters for the formula of the geometry adjustment value.
+        
+        Args:
+            args (List[float]): A list of floating-point values representing the parameters for the formula.
         """
         #arrayargs:ArrayTypeargs = ""
         countargs = len(args)
@@ -52,8 +62,10 @@ class GeomertyAdjustValue (SpireObject) :
 
 
     def FormulaType(self)->'GeomertyAdjustValueFormulaType':
-        """
-
+        """Gets the formula type of the geometry adjustment value.
+        
+        Returns:
+            GeomertyAdjustValueFormulaType: An enumeration value representing the formula type.
         """
         GetDllLibXls().GeomertyAdjustValue_FormulaType.argtypes=[c_void_p]
         GetDllLibXls().GeomertyAdjustValue_FormulaType.restype=c_int

spire/xls/GetText.py

@@ -7,8 +7,14 @@ from ctypes import *
 import abc
 
 class GetText(Enum):
-    """
-
+    """Represents options for retrieving text from Excel cells.
+    
+    This enumeration defines the different ways to extract text content
+    from Excel cells, either as formatted number text or as raw values.
+    
+    Attributes:
+        NumberText: Get the text as a formatted number string according to the cell's format.
+        Value: Get the raw value of the cell without formatting.
     """
     NumberText = 0
     Value = 1

spire/xls/GoalSeek.py

@@ -7,11 +7,19 @@ from ctypes import *
 import abc
 
 class GoalSeek (SpireObject) :
-    """
-
+    """Represents a Goal Seek operation in Excel.
+    
+    This class provides functionality to perform Goal Seek analysis, which is used to find
+    the input value needed to achieve a desired result in a formula. Goal Seek works by
+    varying the value in one specific cell until a formula that depends on that cell returns
+    the desired result.
     """
     @dispatch
     def __init__(self):
+        """Initializes a new instance of the GoalSeek class.
+        
+        Creates a new Goal Seek operation with default settings.
+        """
         GetDllLibXls().GoalSeek_CreateGoalSeek.restype = c_void_p
         intPtr = CallCFunction(GetDllLibXls().GoalSeek_CreateGoalSeek)
         super(GoalSeek, self).__init__(intPtr)
@@ -19,8 +27,13 @@ class GoalSeek (SpireObject) :
 
     @property
     def MaxIterations(self)->int :
-        """
-
+        """Gets or sets the maximum number of iterations for the Goal Seek operation.
+        
+        This property determines how many calculation attempts the Goal Seek operation
+        will make before stopping if it cannot find an exact solution.
+        
+        Returns:
+            int: The maximum number of iterations.
         """
         GetDllLibXls().GoalSeek_get_MaxIterations.argtypes=[c_void_p]
         GetDllLibXls().GoalSeek_get_MaxIterations.restype=c_int
@@ -29,15 +42,23 @@ class GoalSeek (SpireObject) :
 
     @MaxIterations.setter
     def MaxIterations(self, value:int):
-        GetDllLibXls().GoalSeek_get_MaxIterations.argtypes=[c_void_p, c_int]
-        CallCFunction(GetDllLibXls().GoalSeek_get_MaxIterations, self.Ptr, value)
+        GetDllLibXls().GoalSeek_set_MaxIterations.argtypes=[c_void_p, c_int]
+        CallCFunction(GetDllLibXls().GoalSeek_set_MaxIterations, self.Ptr, value)
 
     @dispatch
     def TryCalculate(self ,targetCell:'CellRange', targetValue:float , variableCell:'CellRange')->GoalSeekResult:
-        """
-    <summary>
-        Try goal seek calculate.
-    </summary>
+        """Attempts to perform a Goal Seek calculation with default initial guess.
+        
+        This method tries to find a value for the variable cell that makes the formula
+        in the target cell return the specified target value.
+        
+        Args:
+            targetCell (CellRange): The cell containing the formula whose value you want to set.
+            targetValue (float): The value you want the formula to return.
+            variableCell (CellRange): The cell whose value will be adjusted to reach the target value.
+            
+        Returns:
+            GoalSeekResult: An object containing the results of the Goal Seek operation.
         """
         intPtrtargetCell:c_void_p = targetCell.Ptr
         intPtrvariableCell:c_void_p = variableCell.Ptr
@@ -50,10 +71,19 @@ class GoalSeek (SpireObject) :
 
     @dispatch
     def TryCalculate(self ,targetCell:'CellRange', targetValue:float , variableCell:'CellRange',guess:float)->GoalSeekResult:
-        """
-    <summary>
-        Try goal seek calculate.
-    </summary>
+        """Attempts to perform a Goal Seek calculation with a specified initial guess.
+        
+        This method tries to find a value for the variable cell that makes the formula
+        in the target cell return the specified target value, starting from the specified guess.
+        
+        Args:
+            targetCell (CellRange): The cell containing the formula whose value you want to set.
+            targetValue (float): The value you want the formula to return.
+            variableCell (CellRange): The cell whose value will be adjusted to reach the target value.
+            guess (float): The initial value to use for the variable cell.
+            
+        Returns:
+            GoalSeekResult: An object containing the results of the Goal Seek operation.
         """
         intPtrtargetCell:c_void_p = targetCell.Ptr
         intPtrvariableCell:c_void_p = variableCell.Ptr

spire/xls/GoalSeekResult.py

@@ -7,19 +7,32 @@ from ctypes import *
 import abc
 
 class GoalSeekResult (SpireObject) :
+    """Represents the result of a Goal Seek operation in Excel.
     
-
+    This class encapsulates the results of a Goal Seek analysis, including information about
+    the target and variable cells, the number of iterations performed, the target value,
+    and the calculated result. It provides methods to determine if the operation was successful
+    and to access the results of the calculation.
+    """
 
     
     def Determine(self):
-        """
-
+        """Determines if the Goal Seek operation was successful.
+        
+        This method evaluates the results of the Goal Seek operation to determine
+        if it successfully found a solution that achieves the target value within
+        acceptable tolerance.
         """
         GetDllLibXls().GoalSeekResult_Determine.argtypes=[c_void_p]
         CallCFunction(GetDllLibXls().GoalSeekResult_Determine, self.Ptr)
 
     @property
     def TargetCellName(self)->str:
+        """Gets the name or address of the target cell used in the Goal Seek operation.
+        
+        Returns:
+            str: The name or address of the target cell.
+        """
         GetDllLibXls().GoalSeekResult_get_TargetCellName.argtypes=[c_void_p]
         GetDllLibXls().GoalSeekResult_get_TargetCellName.restype=c_void_p
         ret = CallCFunction(GetDllLibXls().GoalSeekResult_get_TargetCellName, self.Ptr)
@@ -27,6 +40,11 @@ class GoalSeekResult (SpireObject) :
 
     @property
     def VariableCellName(self)->str:
+        """Gets the name or address of the variable cell used in the Goal Seek operation.
+        
+        Returns:
+            str: The name or address of the variable cell.
+        """
         GetDllLibXls().GoalSeekResult_get_VariableCellName.argtypes=[c_void_p]
         GetDllLibXls().GoalSeekResult_get_VariableCellName.restype=c_void_p
         ret = CallCFunction(GetDllLibXls().GoalSeekResult_get_VariableCellName, self.Ptr)
@@ -35,6 +53,11 @@ class GoalSeekResult (SpireObject) :
 
     @property
     def Iterations(self)->int:
+        """Gets the number of iterations performed during the Goal Seek operation.
+        
+        Returns:
+            int: The number of iterations performed.
+        """
         GetDllLibXls().GoalSeekResult_get_Iterations.argtypes=[c_void_p]
         GetDllLibXls().GoalSeekResult_get_Iterations.restype=c_int
         ret = CallCFunction(GetDllLibXls().GoalSeekResult_get_Iterations, self.Ptr)
@@ -42,6 +65,11 @@ class GoalSeekResult (SpireObject) :
 
     @property
     def TargetValue(self)->float:
+        """Gets the target value that was specified for the Goal Seek operation.
+        
+        Returns:
+            float: The target value that the operation attempted to achieve.
+        """
         GetDllLibXls().GoalSeekResult_get_TargetValue.argtypes=[c_void_p]
         GetDllLibXls().GoalSeekResult_get_TargetValue.restype=c_double
         ret = CallCFunction(GetDllLibXls().GoalSeekResult_get_TargetValue, self.Ptr)
@@ -51,6 +79,11 @@ class GoalSeekResult (SpireObject) :
 
     @property
     def GuessResult(self)->float:
+        """Gets the calculated result value for the variable cell.
+        
+        Returns:
+            float: The value found for the variable cell that best achieves the target value.
+        """
         GetDllLibXls().GoalSeekResult_get_GuessResult.argtypes=[c_void_p]
         GetDllLibXls().GoalSeekResult_get_GuessResult.restype=c_double
         ret = CallCFunction(GetDllLibXls().GoalSeekResult_get_GuessResult, self.Ptr)