spire-presentation 10.6.4__py3-none-win_amd64.whl → 10.8.1__py3-none-win_amd64.whl

spire/presentation/{ChartCategoryCollection.py → charts/ChartCategoryCollection.py}

@@ -8,18 +8,19 @@ import abc
 
 class ChartCategoryCollection (SpireObject) :
     """
-    <summary>
-        Represents collection of <see cref="T:Spire.Presentation.Charts.ChartCategory" /></summary>
+    Represents a collection of ChartCategory objects in a chart.
+    Provides methods to manage categories including adding, removing, and accessing items.
     """
 
     def get_Item(self ,index:int)->'ChartCategory':
         """
-    <summary>
-        Gets the element at the specified index.
-    </summary>
-    <returns>
-            The element at the specified index.
-            </returns>
+        Gets the ChartCategory at the specified index.
+        
+        Args:
+            index (int): The zero-based index of the category to retrieve.
+        
+        Returns:
+            ChartCategory: The category at the specified index.
         """
         
         GetDllLibPpt().ChartCategoryCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -33,7 +34,10 @@ class ChartCategoryCollection (SpireObject) :
 
     def CategoryLabels(self)->'CellRanges':
         """
-
+        Gets or sets the cell ranges containing category labels.
+        
+        Returns:
+            CellRanges: The collection of cell ranges defining category labels.
         """
         GetDllLibPpt().ChartCategoryCollection_get_CategoryLabels.argtypes=[c_void_p]
         GetDllLibPpt().ChartCategoryCollection_get_CategoryLabels.restype=c_void_p
@@ -50,11 +54,13 @@ class ChartCategoryCollection (SpireObject) :
 
     def AppendCellRange(self ,cellRange:'CellRange')->int:
         """
-    <summary>
-        Creates new chart category from <see cref="T:Spire.Presentation.Charts.CellRange" /> and adds it to the collection.
-    </summary>
-    <param name="cellRange">Cell to create chart category.</param>
-    <returns>Index of new chart category.</returns>
+        Creates a new chart category from a CellRange and adds it to the collection.
+        
+        Args:
+            cellRange (CellRange): The cell range to create the category from.
+        
+        Returns:
+            int: Index of the newly added category.
         """
         intPtrcellRange:c_void_p = cellRange.Ptr
 
@@ -66,13 +72,14 @@ class ChartCategoryCollection (SpireObject) :
 
     def AppendStr(self ,value:str)->int:
         """
-    <summary>
-        Append a string value.
-    </summary>
-    <param name="value"></param>
-    <returns></returns>
-        """
+        Appends a new category using a string value.
+        
+        Args:
+            value (str): The string value for the new category.
         
+        Returns:
+            int: Index of the newly added category.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().ChartCategoryCollection_AppendV.argtypes=[c_void_p ,c_char_p]
         GetDllLibPpt().ChartCategoryCollection_AppendV.restype=c_int
@@ -82,13 +89,14 @@ class ChartCategoryCollection (SpireObject) :
 
     def AppendFloat(self ,value:float)->int:
         """
-    <summary>
-        Append a numberic value.
-    </summary>
-    <param name="value"></param>
-    <returns></returns>
-        """
+        Appends a new category using a numeric value.
+        
+        Args:
+            value (float): The numeric value for the new category.
         
+        Returns:
+            int: Index of the newly added category.
+        """
         GetDllLibPpt().ChartCategoryCollection_AppendV1.argtypes=[c_void_p ,c_float]
         GetDllLibPpt().ChartCategoryCollection_AppendV1.restype=c_int
         ret = CallCFunction(GetDllLibPpt().ChartCategoryCollection_AppendV1,self.Ptr, value)
@@ -96,11 +104,13 @@ class ChartCategoryCollection (SpireObject) :
 
     def AppendSpireObject(self ,value:SpireObject)->int:
         """
-    <summary>
-         Creates new <see cref="T:Spire.Presentation.Charts.ChartCategory" /> from value and adds it to the collection.
-    </summary>
-    <param name="value">The value.</param>
-    <returns>Index of a new added <see cref="T:Spire.Presentation.Charts.CellRange" />.</returns>
+        Creates a new ChartCategory from a SpireObject and adds it to the collection.
+        
+        Args:
+            value (SpireObject): The object to create the category from.
+        
+        Returns:
+            int: Index of the newly added category.
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -112,11 +122,13 @@ class ChartCategoryCollection (SpireObject) :
 
     def IndexOf(self ,value:'ChartCategory')->int:
         """
-    <summary>
-        Searches for the specified <see cref="T:Spire.Presentation.Charts.ChartCategory" /> and returns the zero-based index of the first occurrence within the entire Collection
-    </summary>
-    <param name="value">Chart category.</param>
-    <returns>The zero-based index of the first occurrence of value within the entire CollectionBase, if found; otherwise, -1.</returns>
+        Searches for the specified ChartCategory and returns its index.
+        
+        Args:
+            value (ChartCategory): The category to locate.
+        
+        Returns:
+            int: Zero-based index if found; otherwise -1.
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -128,11 +140,10 @@ class ChartCategoryCollection (SpireObject) :
 
     def Remove(self ,value:'ChartCategory'):
         """
-    <summary>
-        Removes the specified value.
-    </summary>
-    <param name="value">The value.</param>
-<exception cref="T:System.ArgumentException">The value parameter was not found in the collection.</exception>
+        Removes a specific category from the collection.
+        
+        Args:
+            value (ChartCategory): The category to remove.
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -142,6 +153,10 @@ class ChartCategoryCollection (SpireObject) :
     @property
     def Count(self)->int:
         """
+        Gets the number of categories in the collection.
+        
+        Returns:
+            int: Total count of categories.
         """
 
         GetDllLibPpt().ChartCategoryCollection_GetCount.argtypes=[c_void_p ,c_void_p]
@@ -150,16 +165,19 @@ class ChartCategoryCollection (SpireObject) :
 
     def Clear(self):
         """
+        Removes all categories from the collection.
         """
-
         GetDllLibPpt().ChartCategoryCollection_Clear.argtypes=[c_void_p ,c_void_p]
         CallCFunction(GetDllLibPpt().ChartCategoryCollection_Clear,self.Ptr)
 
     @property
     def Capacity(self)->int:
         """
+        Gets or sets the capacity of the collection.
+        
+        Returns:
+            int: Current capacity of the collection.
         """
-
         GetDllLibPpt().ChartCategoryCollection_getCapacity.argtypes=[c_void_p ,c_void_p]
         ret = CallCFunction(GetDllLibPpt().ChartCategoryCollection_getCapacity,self.Ptr)
         return ret
@@ -167,8 +185,11 @@ class ChartCategoryCollection (SpireObject) :
     @Capacity.setter
     def Capacity(self, value:int)->int:
         """
+        Sets the capacity of the collection.
+        
+        Args:
+            value (int): The new capacity value.
         """
-
         GetDllLibPpt().ChartCategoryCollection_setCapacity.argtypes=[c_void_p ,c_void_p]
         CallCFunction(GetDllLibPpt().ChartCategoryCollection_setCapacity,self.Ptr,value)
 

spire/presentation/{ChartCrossesType.py → charts/ChartCrossesType.py}

@@ -8,9 +8,12 @@ import abc
 
 class ChartCrossesType(Enum):
     """
-    <summary>
-        Indicates where axis will cross.
-    </summary>
+    Specifies where an axis crosses another axis in a chart.
+
+    Attributes:
+        AxisCrossesAtZero:Axis crosses at the zero point.
+        Maximum:Axis crosses at the maximum value
+        Custom:Axis crosses at a custom specified value
     """
     AxisCrossesAtZero = 0
     Maximum = 1

spire/presentation/{ChartData.py → charts/ChartData.py}

@@ -8,13 +8,24 @@ import abc
 
 class ChartData (SpireObject) :
     """
-    <summary>
-        Chart data.
-    </summary>
+    Represents the data associated with a chart.
+    
+    This class provides access to individual cells or ranges of cells within the chart's data source.
+    It includes methods to retrieve specific data points and clear data ranges.
     """
 
     @dispatch
     def __getitem__(self, row,column):
+        """
+        Accesses a single cell in the chart data by row and column indices.
+        
+        Args:
+            row: Row index (0-based)
+            column: Column index (0-based)
+            
+        Returns:
+            CellRange: Object representing the requested cell
+        """
         
         GetDllLibPpt().ChartData_get_Item.argtypes=[c_void_p ,c_int,c_int]
         GetDllLibPpt().ChartData_get_Item.restype=c_void_p
@@ -24,6 +35,18 @@ class ChartData (SpireObject) :
 
     @dispatch
     def __getitem__(self, startRow,startColumn,endRow,endColumn):
+        """
+        Accesses a range of cells in the chart data.
+        
+        Args:
+            startRow: Starting row index
+            startColumn: Starting column index
+            endRow: Ending row index
+            endColumn: Ending column index
+            
+        Returns:
+            CellRanges: Collection of cells in the specified range
+        """
         
         GetDllLibPpt().ChartData_get_ItemRCLL.argtypes=[c_void_p ,c_int,c_int,c_int,c_int]
         GetDllLibPpt().ChartData_get_ItemRCLL.restype=c_void_p
@@ -33,6 +56,15 @@ class ChartData (SpireObject) :
 
     @dispatch
     def __getitem__(self, name:str):
+        """
+        Accesses a cell by its Excel-style name (e.g., "A1").
+        
+        Args:
+            name: Cell reference in Excel format
+            
+        Returns:
+            CellRange: Object representing the requested cell
+        """
         
         namePtr = StrToPtr(name)
         GetDllLibPpt().ChartData_get_ItemN.argtypes=[c_void_p ,c_char_p]
@@ -45,12 +77,14 @@ class ChartData (SpireObject) :
 
     def get_Item(self ,row:int,column:int)->CellRange:
         """
-    <summary>
-        Get cell range.
-    </summary>
-    <param name="row"></param>
-    <param name="column"></param>
-    <returns></returns>
+        Retrieves a specific cell in the chart data.
+        
+        Args:
+            row: Row index (0-based)
+            column: Column index (0-based)
+            
+        Returns:
+            CellRange: Object representing the requested cell
         """
         
         GetDllLibPpt().ChartData_get_Item.argtypes=[c_void_p ,c_int,c_int]
@@ -63,16 +97,14 @@ class ChartData (SpireObject) :
 
     def Clear(self ,row:int,column:int,lastRow:int,lastColumn:int):
         """
-    <summary>
-        clear data.
-    </summary>
-    <param name="row"></param>
-    <param name="column"></param>
-    <param name="lastRow"></param>
-    <param name="lastColumn"></param>
-    <returns></returns>
-        """
+        Clears data within the specified range.
         
+        Args:
+            row: Starting row index
+            column: Starting column index
+            lastRow: Ending row index
+            lastColumn: Ending column index
+        """
         GetDllLibPpt().ChartData_Clear.argtypes=[c_void_p ,c_int,c_int,c_int,c_int]
         CallCFunction(GetDllLibPpt().ChartData_Clear,self.Ptr, row,column,lastRow,lastColumn)
 
@@ -80,16 +112,17 @@ class ChartData (SpireObject) :
 
     def get_Item(self ,row:int,column:int,lastRow:int,lastColumn:int)->CellRanges:
         """
-    <summary>
-        Get cell ranges.
-    </summary>
-    <param name="row"></param>
-    <param name="column"></param>
-    <param name="lastRow"></param>
-    <param name="lastColumn"></param>
-    <returns></returns>
-        """
+        Retrieves a range of cells.
         
+        Args:
+            row: Starting row index
+            column: Starting column index
+            lastRow: Ending row index
+            lastColumn: Ending column index
+            
+        Returns:
+            CellRanges: Collection of cells in the specified range
+        """
         GetDllLibPpt().ChartData_get_ItemRCLL.argtypes=[c_void_p ,c_int,c_int,c_int,c_int]
         GetDllLibPpt().ChartData_get_ItemRCLL.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().ChartData_get_ItemRCLL,self.Ptr, row,column,lastRow,lastColumn)
@@ -101,15 +134,17 @@ class ChartData (SpireObject) :
 
     def get_Item(self ,worksheetIndex:int,row:int,column:int,lastRow:int,lastColumn:int)->CellRanges:
         """
-    <summary>
-        Get cell ranges.
-    </summary>
-    <param name="worksheetIndex"></param>
-    <param name="row"></param>
-    <param name="column"></param>
-    <param name="lastRow"></param>
-    <param name="lastColumn"></param>
-    <returns></returns>
+        Retrieves a range of cells from a specific worksheet.
+        
+        Args:
+            worksheetIndex: Index of the worksheet
+            row: Starting row index
+            column: Starting column index
+            lastRow: Ending row index
+            lastColumn: Ending column index
+            
+        Returns:
+            CellRanges: Collection of cells in the specified range
         """
         
         GetDllLibPpt().ChartData_get_ItemWRCLL.argtypes=[c_void_p ,c_int,c_int,c_int,c_int,c_int]
@@ -123,13 +158,14 @@ class ChartData (SpireObject) :
 
     def get_Item(self ,name:str)->CellRange:
         """
-    <summary>
-        Get cell range.
-    </summary>
-    <param name="name"></param>
-    <returns></returns>
-        """
+        Retrieves a cell by its Excel-style name.
         
+        Args:
+            name: Cell reference in Excel format
+            
+        Returns:
+            CellRange: Object representing the requested cell
+        """
         namePtr = StrToPtr(name)
         GetDllLibPpt().ChartData_get_ItemN.argtypes=[c_void_p ,c_char_p]
         GetDllLibPpt().ChartData_get_ItemN.restype=c_void_p
@@ -142,13 +178,15 @@ class ChartData (SpireObject) :
 
     def get_Item(self ,name:str,endCellName:str)->CellRanges:
         """
-    <summary>
-        Get cell range.
-    </summary>
-    <param name="name"></param>
-    <returns></returns>
-        """
+        Retrieves a range of cells by starting and ending Excel-style names.
         
+        Args:
+            name: Starting cell reference
+            endCellName: Ending cell reference
+            
+        Returns:
+            CellRanges: Collection of cells in the specified range
+        """
         namePtr = StrToPtr(name)
         endCellNamePtr = StrToPtr(endCellName)
         GetDllLibPpt().ChartData_get_ItemNE.argtypes=[c_void_p ,c_char_p,c_char_p]
@@ -162,13 +200,15 @@ class ChartData (SpireObject) :
 
     def get_Item(self ,worksheetIndex:int,name:str)->CellRange:
         """
-    <summary>
-        Get cell range.
-    </summary>
-    <param name="name"></param>
-    <returns></returns>
-        """
+        Retrieves a cell from a specific worksheet by Excel-style name.
         
+        Args:
+            worksheetIndex: Index of the worksheet
+            name: Cell reference in Excel format
+            
+        Returns:
+            CellRange: Object representing the requested cell
+        """
         namePtr = StrToPtr(name)
         GetDllLibPpt().ChartData_get_ItemWN.argtypes=[c_void_p ,c_int,c_char_p]
         GetDllLibPpt().ChartData_get_ItemWN.restype=c_void_p
@@ -181,13 +221,16 @@ class ChartData (SpireObject) :
 
     def get_Item(self ,worksheetIndex:int,name:str,endCellName:str)->CellRanges:
         """
-    <summary>
-        Get cell range.
-    </summary>
-    <param name="name"></param>
-    <returns></returns>
-        """
+        Retrieves a range of cells from a specific worksheet.
         
+        Args:
+            worksheetIndex: Index of the worksheet
+            name: Starting cell reference
+            endCellName: Ending cell reference
+            
+        Returns:
+            CellRanges: Collection of cells in the specified range
+        """
         namePtr = StrToPtr(name)
         endCellNamePtr = StrToPtr(endCellName)
         GetDllLibPpt().ChartData_get_ItemWNE.argtypes=[c_void_p ,c_int,c_char_p,c_char_p]
@@ -200,8 +243,11 @@ class ChartData (SpireObject) :
     @property
     def LastRowIndex(self)->int:
         """
+        Gets the index of the last row containing data.
+        
+        Returns:
+            int: 0-based index of the last data row
         """
-
         GetDllLibPpt().ChartData_LastRowIndex.argtypes=[c_void_p ,c_void_p]
         ret = CallCFunction(GetDllLibPpt().ChartData_LastRowIndex,self.Ptr)
         return ret
@@ -209,8 +255,11 @@ class ChartData (SpireObject) :
     @property
     def LastColIndex(self)->int:
         """
+        Gets the index of the last column containing data.
+        
+        Returns:
+            int: 0-based index of the last data column
         """
-
         GetDllLibPpt().ChartData_LastColIndex.argtypes=[c_void_p ,c_void_p]
         ret = CallCFunction(GetDllLibPpt().ChartData_LastColIndex,self.Ptr)
         return ret