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

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

@@ -8,16 +8,13 @@ import abc
 
 class ChartSeriesFormatCollection (SpireObject) :
     """
-    <summary>
-        Represents collection of  <see cref="T:Spire.Presentation.Charts.ChartSeriesDataFormat" /></summary>
+    Represents a collection of ChartSeriesDataFormat objects.
     """
     @property
 
     def SeriesLabel(self)->'CellRanges':
         """
-    <summary>
-        Gets or sets chart series value.
-    </summary>
+        Gets or sets the chart series value.
         """
         GetDllLibPpt().ChartSeriesFormatCollection_get_SeriesLabel.argtypes=[c_void_p]
         GetDllLibPpt().ChartSeriesFormatCollection_get_SeriesLabel.restype=c_void_p
@@ -34,6 +31,18 @@ class ChartSeriesFormatCollection (SpireObject) :
 
     @dispatch
     def __getitem__(self, index):
+        """
+        Gets the element at the specified index.
+        
+        Args:
+            index: The zero-based index of the element to get.
+        
+        Returns:
+            The element at the specified index.
+        
+        Raises:
+            StopIteration: If index is equal to or greater than Count.
+        """
         if index >= self.Count:
             raise StopIteration
         GetDllLibPpt().ChartSeriesFormatCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -44,12 +53,13 @@ class ChartSeriesFormatCollection (SpireObject) :
 
     def get_Item(self ,index:int)->'ChartSeriesDataFormat':
         """
-    <summary>
         Gets the element at the specified index.
-    </summary>
-    <returns>
+        
+        Args:
+            index: The zero-based index of the element to get.
+        
+        Returns:
             The element at the specified index.
-              </returns>
         """
         
         GetDllLibPpt().ChartSeriesFormatCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -61,10 +71,8 @@ class ChartSeriesFormatCollection (SpireObject) :
     @property
     def Count(self)->int:
         """
-    <summary>
         Gets the number of elements actually contained in the collection.
-            Read-only <see cref="T:System.Int32" />.
-    </summary>
+        Read-only int.
         """
         GetDllLibPpt().ChartSeriesFormatCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().ChartSeriesFormatCollection_get_Count.restype=c_int
@@ -74,7 +82,13 @@ class ChartSeriesFormatCollection (SpireObject) :
     
     def AppendCellRange(self ,cellRange:'CellRange')->int:
         """
-
+        Appends a cell range to the collection.
+        
+        Args:
+            cellRange: The cell range to append.
+        
+        Returns:
+            The index at which the value has been added.
         """
         
         intPtrcellRange:c_void_p = cellRange.Ptr
@@ -87,11 +101,13 @@ class ChartSeriesFormatCollection (SpireObject) :
 
     def AppendStr(self ,value:str)->int:
         """
-    <summary>
-        Append a string value.
-    </summary>
-    <param name="value"></param>
-    <returns></returns>
+        Appends a string value to the collection.
+        
+        Args:
+            value: The string value to append.
+        
+        Returns:
+            The index at which the value has been added.
         """
         
         valuePtr = StrToPtr(value)
@@ -103,13 +119,14 @@ class ChartSeriesFormatCollection (SpireObject) :
 
     def AppendFloat(self ,value:float)->int:
         """
-    <summary>
-        Append a numberic value.
-    </summary>
-    <param name="value"></param>
-    <returns></returns>
-        """
+        Appends a numeric value to the collection.
+        
+        Args:
+            value: The float value to append.
         
+        Returns:
+            The index at which the value has been added.
+        """
         GetDllLibPpt().ChartSeriesFormatCollection_AppendV1.argtypes=[c_void_p ,c_float]
         GetDllLibPpt().ChartSeriesFormatCollection_AppendV1.restype=c_int
         ret = CallCFunction(GetDllLibPpt().ChartSeriesFormatCollection_AppendV1,self.Ptr, value)
@@ -118,11 +135,13 @@ class ChartSeriesFormatCollection (SpireObject) :
 
     def AppendSpireObject(self ,value:SpireObject)->int:
         """
-    <summary>
-        Append a value;
-    </summary>
-    <param name="value"></param>
-    <returns></returns>
+        Appends a SpireObject value to the collection.
+        
+        Args:
+            value: The SpireObject to append.
+        
+        Returns:
+            The index at which the value has been added.
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -134,11 +153,13 @@ class ChartSeriesFormatCollection (SpireObject) :
 
     def IndexOf(self ,value:'ChartSeriesDataFormat')->int:
         """
-    <summary>
-        Searches for the specified <see cref="T:Spire.Presentation.Charts.ChartSeriesDataFormat" /> and returns the zero-based index of the first occurrence within the entire Collection
-    </summary>
-    <param name="value">Chart series value.</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 ChartSeriesDataFormat and returns its index.
+        
+        Args:
+            value: The ChartSeriesDataFormat to locate.
+        
+        Returns:
+            The zero-based index of the first occurrence, or -1 if not found.
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -150,11 +171,13 @@ class ChartSeriesFormatCollection (SpireObject) :
 
     def Remove(self ,value:'ChartSeriesDataFormat'):
         """
-    <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 the specified ChartSeriesDataFormat from the collection.
+        
+        Args:
+            value: The ChartSeriesDataFormat to remove.
+        
+        Raises:
+            ArgumentException: If the value is not found in the collection.
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -163,6 +186,10 @@ class ChartSeriesFormatCollection (SpireObject) :
 
     def RemoveAt(self ,value:'int'):
         """
+        Removes the element at the specified index.
+        
+        Args:
+            value: The zero-based index of the element to remove.
         """
         intPtrvalue:c_void_p = value
 
@@ -171,6 +198,7 @@ class ChartSeriesFormatCollection (SpireObject) :
 
     def Clear(self):
         """
+        Removes all elements from the collection.
         """
 
         GetDllLibPpt().ChartSeriesFormatCollection_clear.argtypes=[c_void_p ,c_void_p]
@@ -179,9 +207,7 @@ class ChartSeriesFormatCollection (SpireObject) :
     @property
     def KeepSeriesFormat(self)->bool:
         """
-    <summary>
-        Get or set whether change series format when reset the SeriesLabel.
-    </summary>
+        Gets or sets whether to keep series format when resetting SeriesLabel.
         """
         GetDllLibPpt().ChartSeriesFormatCollection_get_KeepSeriesFormat.argtypes=[c_void_p]
         GetDllLibPpt().ChartSeriesFormatCollection_get_KeepSeriesFormat.restype=c_bool
@@ -196,8 +222,8 @@ class ChartSeriesFormatCollection (SpireObject) :
     @property
     def Capacity(self)->int:
         """
+        Gets or sets the total number of elements the collection can hold.
         """
-
         GetDllLibPpt().ChartSeriesFormatCollection_getCapacity.argtypes=[c_void_p ,c_void_p]
         ret = CallCFunction(GetDllLibPpt().ChartSeriesFormatCollection_getCapacity,self.Ptr)
         return ret

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

@@ -8,9 +8,16 @@ import abc
 
 class ChartShapeType(Enum):
     """
-    <summary>
-        Represents a shape of chart.
-    </summary>
+    Represents the shape type of a chart.
+
+    Attributes:
+        none:
+        Box:Box shape.
+        Cone:Cone shape.
+        ConeToMax:Cone shape scaled to maximum value.
+        Cylinder:Cylinder shape.
+        Pyramid:Pyramid shape.
+        PyramidToMaximum:Pyramid shape scaled to maximum value.
     """
     none = -1
     Box = 0

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

@@ -8,9 +8,7 @@ import abc
 
 class ChartStyle(Enum):
     """
-    <summary>
-        Represents chart style.
-    </summary>
+    Represents chart style.
     """
     Style1 = 0
     Style2 = 1

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

@@ -8,17 +8,12 @@ import abc
 
 class ChartTextArea (SpireObject) :
     """
-    <summary>
-        Represents chart text area properties.
-    </summary>
+    Represents text area properties for chart elements.
     """
     @property
     def Left(self)->float:
         """
-    <summary>
-        Gets or sets the x coordinate of a legend in points.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the x-coordinate in points.
         """
         GetDllLibPpt().ChartTextArea_get_Left.argtypes=[c_void_p]
         GetDllLibPpt().ChartTextArea_get_Left.restype=c_float
@@ -33,10 +28,7 @@ class ChartTextArea (SpireObject) :
     @property
     def Top(self)->float:
         """
-    <summary>
-        Gets or sets the y coordinate of a legend in points.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the y-coordinate in points.
         """
         GetDllLibPpt().ChartTextArea_get_Top.argtypes=[c_void_p]
         GetDllLibPpt().ChartTextArea_get_Top.restype=c_float
@@ -51,10 +43,7 @@ class ChartTextArea (SpireObject) :
     @property
     def Width(self)->float:
         """
-    <summary>
-        Gets or sets the width of a legend in points.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the width in points.
         """
         GetDllLibPpt().ChartTextArea_get_Width.argtypes=[c_void_p]
         GetDllLibPpt().ChartTextArea_get_Width.restype=c_float
@@ -69,10 +58,8 @@ class ChartTextArea (SpireObject) :
     @property
     def Height(self)->float:
         """
-    <summary>
         Gets or sets the height of a legend in points.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+    
         """
         GetDllLibPpt().ChartTextArea_get_Height.argtypes=[c_void_p]
         GetDllLibPpt().ChartTextArea_get_Height.restype=c_float
@@ -87,10 +74,8 @@ class ChartTextArea (SpireObject) :
     @property
     def IsOverlay(self)->bool:
         """
-    <summary>
         Indicates whether allowed to overlap title.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+           
         """
         GetDllLibPpt().ChartTextArea_get_IsOverlay.argtypes=[c_void_p]
         GetDllLibPpt().ChartTextArea_get_IsOverlay.restype=c_bool
@@ -106,9 +91,8 @@ class ChartTextArea (SpireObject) :
 
     def TextProperties(self)->'ITextFrameProperties':
         """
-    <summary>
         Gets text frame of a chart title.
-    </summary>
+  
         """
         GetDllLibPpt().ChartTextArea_get_TextProperties.argtypes=[c_void_p]
         GetDllLibPpt().ChartTextArea_get_TextProperties.restype=c_void_p
@@ -121,10 +105,8 @@ class ChartTextArea (SpireObject) :
 
     def Fill(self)->'FillFormat':
         """
-    <summary>
-        Gets fill style properties of a chart.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FillFormat" />.
-    </summary>
+        Gets the fill style properties.
+        Read-only FillFormat.
         """
         GetDllLibPpt().ChartTextArea_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().ChartTextArea_get_Fill.restype=c_void_p
@@ -137,9 +119,7 @@ class ChartTextArea (SpireObject) :
 
     def Line(self)->'IChartGridLine':
         """
-    <summary>
-        Gets line style properties of a chart.
-    </summary>
+        Gets the line style properties.
         """
         GetDllLibPpt().ChartTextArea_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().ChartTextArea_get_Line.restype=c_void_p
@@ -152,10 +132,8 @@ class ChartTextArea (SpireObject) :
 
     def Effect(self)->'EffectDag':
         """
-    <summary>
-        Gets effects used for a chart.
-            Read-only <see cref="T:Spire.Presentation.Drawing.EffectDag" />.
-    </summary>
+        Gets the effects applied to the text area.
+        Read-only EffectDag.
         """
         GetDllLibPpt().ChartTextArea_get_Effect.argtypes=[c_void_p]
         GetDllLibPpt().ChartTextArea_get_Effect.restype=c_void_p
@@ -168,10 +146,8 @@ class ChartTextArea (SpireObject) :
 
     def Effect3D(self)->'FormatThreeD':
         """
-    <summary>
-        Gets 3D format of a chart.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FormatThreeD" />.
-    </summary>
+        Gets the 3D formatting properties.
+        Read-only FormatThreeD.
         """
         GetDllLibPpt().ChartTextArea_get_Effect3D.argtypes=[c_void_p]
         GetDllLibPpt().ChartTextArea_get_Effect3D.restype=c_void_p

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

@@ -8,9 +8,8 @@ import abc
 
 class ChartType(Enum):
     """
-    <summary>
-        Represents a type of chart.
-    </summary>
+    Represents a type of chart.
+   
     """
     ColumnClustered = 0
     ColumnStacked = 1

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

@@ -8,16 +8,15 @@ import abc
 
 class ChartWallsOrFloor (  PptObject) :
     """
-    <summary>
-        Represents walls on 3d charts.
-    </summary>
+    Represents walls or floor on 3D charts.
     """
     @property
     def Thickness(self)->int:
         """
-    <summary>
-        Gets or sets the walls thickness.
-    </summary>
+        Gets or sets the thickness of the walls or floor.
+
+        Returns:
+            int: The thickness value.
         """
         GetDllLibPpt().ChartWallsOrFloor_get_Thickness.argtypes=[c_void_p]
         GetDllLibPpt().ChartWallsOrFloor_get_Thickness.restype=c_int
@@ -33,10 +32,10 @@ class ChartWallsOrFloor (  PptObject) :
 
     def Fill(self)->'FillFormat':
         """
-    <summary>
-        Gets fill style properties of a chart.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FillFormat" />.
-    </summary>
+        Gets the fill style properties of the chart walls or floor.
+
+        Returns:
+            FillFormat: Read-only fill format object.
         """
         GetDllLibPpt().ChartWallsOrFloor_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().ChartWallsOrFloor_get_Fill.restype=c_void_p
@@ -49,9 +48,10 @@ class ChartWallsOrFloor (  PptObject) :
 
     def Line(self)->'IChartGridLine':
         """
-    <summary>
-        Gets line style properties of a chart.
-    </summary>
+        Gets the line style properties of the chart walls or floor.
+
+        Returns:
+            IChartGridLine: Line style object.
         """
         GetDllLibPpt().ChartWallsOrFloor_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().ChartWallsOrFloor_get_Line.restype=c_void_p
@@ -64,10 +64,10 @@ class ChartWallsOrFloor (  PptObject) :
 
     def Effect(self)->'EffectDag':
         """
-    <summary>
-        Gets effects used for a chart.
-            Read-only <see cref="T:Spire.Presentation.Drawing.EffectDag" />.
-    </summary>
+        Gets effects used for the chart walls or floor.
+
+        Returns:
+            EffectDag: Read-only effect object.
         """
         GetDllLibPpt().ChartWallsOrFloor_get_Effect.argtypes=[c_void_p]
         GetDllLibPpt().ChartWallsOrFloor_get_Effect.restype=c_void_p
@@ -80,10 +80,10 @@ class ChartWallsOrFloor (  PptObject) :
 
     def Effect3D(self)->'FormatThreeD':
         """
-    <summary>
-        Gets 3D format of a chart.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FormatThreeD" />.
-    </summary>
+        Gets 3D format of the chart walls or floor.
+
+        Returns:
+            FormatThreeD: Read-only 3D format object.
         """
         GetDllLibPpt().ChartWallsOrFloor_get_Effect3D.argtypes=[c_void_p]
         GetDllLibPpt().ChartWallsOrFloor_get_Effect3D.restype=c_void_p
@@ -96,9 +96,10 @@ class ChartWallsOrFloor (  PptObject) :
 
     def PictureType(self)->'PictureType':
         """
-    <summary>
-        Gets or sets the picture type.
-    </summary>
+        Gets or sets the picture type for the walls or floor.
+
+        Returns:
+            PictureType: Enum value representing picture type.
         """
         GetDllLibPpt().ChartWallsOrFloor_get_PictureType.argtypes=[c_void_p]
         GetDllLibPpt().ChartWallsOrFloor_get_PictureType.restype=c_int

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

@@ -8,7 +8,11 @@ import abc
 
 class CrossBetweenType(Enum):
     """
+    Specifies how chart axes cross between categories.
 
+    Attributes:
+        Between:Axis crosses between categories
+        MidpointOfCategory:Axis crosses at midpoint of categories
     """
     none = 0
     Between = 0

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

@@ -8,9 +8,7 @@ import abc
 
 class DataLabelShapeType(Enum):
     """
-    <summary>
-        Represents a shape type of data label.
-    </summary>
+    Specifies the shape type used for data labels in charts.
     """
     none = 0
     Rectangle = 1

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

@@ -8,9 +8,8 @@ import abc
 
 class DisplayBlanksAsType(Enum):
     """
-    <summary>
-        Indicates how missing data will be displayed.
-    </summary>
+    Indicates how missing data will be displayed.
+    
     """
     Gap = 0
     Span = 1

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

@@ -8,7 +8,12 @@ import abc
 
 class ErrorBarSimpleType(Enum):
     """
-
+    Specifies the direction of error bars in charts.
+    
+    Attributes:
+        Both: Shows error bars in both positive and negative directions.
+        Minus: Shows error bars only in negative direction.
+        Plus: Shows error bars only in positive direction.
     """
     Both = 0
     Minus = 1

spire/presentation/charts/ErrorValueType.py

@@ -0,0 +1,25 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.presentation.common import *
+from spire.presentation import *
+from ctypes import *
+import abc
+
+class ErrorValueType(Enum):
+    """
+    Specifies the calculation method for error bar values.
+    
+    Attributes:
+        CustomErrorBars: Uses custom-defined error values.
+        FixedValue: Uses a fixed value for all error bars.
+        Percentage: Calculates errors as percentage of data values.
+        StandardDeviation: Calculates errors using standard deviation.
+        StandardError: Calculates errors using standard error.
+    """
+    CustomErrorBars = 0
+    FixedValue = 1
+    Percentage = 2
+    StandardDeviation = 3
+    StandardError = 4
+

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

@@ -8,18 +8,14 @@ import abc
 
 class HistogramAxisFormat (SpireObject) :
     """
-    <summary>
-        Class provide the options for Histogram and Pareto Chart axis
-    </summary>
+    Class provide the options for Histogram and Pareto Chart axis
+    
     """
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-    <summary>
         Check for the equals an object
-    </summary>
-    <param name="obj">input another histogram object</param>
-    <returns>the boolean value indicates whether the objects are equal or not.</returns>
+   
         """
         intPtrobj:c_void_p = obj.Ptr