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

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

@@ -8,18 +8,17 @@ import abc
 
 class ChartDataLabelCollection (  SpireObject ) :
     """
-    <summary>
-        Represents a series labels.
-    </summary>
+    Represents a collection of data labels for a chart series.
+    Provides properties and methods to manage the appearance, formatting, and behavior of data labels in a chart.
     """
     @property
 
     def NumberFormat(self)->str:
         """
-    <summary>
-        Represents the format string for the DataLabels object.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        Gets or sets the number formatting string for data label values.
+        
+        Returns:
+            str: The current number format string
         """
         GetDllLibPpt().ChartDataLabelCollection_get_NumberFormat.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_NumberFormat.restype=c_void_p
@@ -36,9 +35,10 @@ class ChartDataLabelCollection (  SpireObject ) :
     @property
     def HasDataSource(self)->bool:
         """
-    <summary>
         Gets and sets a reference to the worksheet
-    </summary>
+        
+        Returns:
+            bool: whethere use worksheet data. 
         """
         GetDllLibPpt().ChartDataLabelCollection_get_HasDataSource.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_HasDataSource.restype=c_bool
@@ -53,9 +53,10 @@ class ChartDataLabelCollection (  SpireObject ) :
     @property
     def IsDelete(self)->bool:
         """
-    <summary>
         Gets or sets delete flag.
-    </summary>
+        
+        Returns:
+            bool: whethere delete the data label. 
         """
         GetDllLibPpt().ChartDataLabelCollection_get_IsDelete.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_IsDelete.restype=c_bool
@@ -71,10 +72,10 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     def TextProperties(self)->'ITextFrameProperties':
         """
-    <summary>
-        Gets a text properties of this data labels
-            Readonly <see cref="T:Spire.Presentation.TextFrameProperties" />.
-    </summary>
+        Gets a text properties of this data labels.
+        
+        Returns:
+            ITextFrameProperties: text properties of this data labels.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_TextProperties.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_TextProperties.restype=c_void_p
@@ -87,10 +88,10 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     def Fill(self)->'FillFormat':
         """
-    <summary>
-        Gets fill style properties of a chart.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FillFormat" />.
-    </summary>
+        Gets fill style properties of a data label.
+        
+        Returns:
+            FillFormat: fill style properties of a data label.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_Fill.restype=c_void_p
@@ -103,9 +104,10 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     def Line(self)->'IChartGridLine':
         """
-    <summary>
-        Gets line style properties of a chart.
-    </summary>
+        Gets line style properties of data labels.
+        
+        Returns:
+            IChartGridLine: line style properties of data labels.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_Line.restype=c_void_p
@@ -118,10 +120,10 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     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 data labels.
+        
+        Returns:
+            EffectDag: effects style of data labels.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_Effect.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_Effect.restype=c_void_p
@@ -134,10 +136,10 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     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 data labels.
+        
+        Returns:
+            FormatThreeD: 3D format of data labels.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_Effect3D.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_Effect3D.restype=c_void_p
@@ -150,10 +152,10 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     def Position(self)->'ChartDataLabelPosition':
         """
-    <summary>
         Represents the position of the data lable.
-            Read/write <see cref="T:Spire.Presentation.Charts.DataLabelPosition" />.
-    </summary>
+        
+        Returns:
+            ChartDataLabelPosition: the position of the data lable.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_Position.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_Position.restype=c_int
@@ -169,10 +171,10 @@ class ChartDataLabelCollection (  SpireObject ) :
     @property
     def LegendKeyVisible(self)->bool:
         """
-    <summary>
         Indicates chart's data label legend key display behavior. 
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        
+        Returns:
+            bool: whethere chart's data label legend key display.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_LegendKeyVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_LegendKeyVisible.restype=c_bool
@@ -187,10 +189,10 @@ class ChartDataLabelCollection (  SpireObject ) :
     @property
     def LeaderLinesVisible(self)->bool:
         """
-    <summary>
         Indicates chart's data label leader line display behavior. 
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        
+        Returns:
+            bool: whethere chart's data label leader line display.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_LeaderLinesVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_LeaderLinesVisible.restype=c_bool
@@ -205,10 +207,10 @@ class ChartDataLabelCollection (  SpireObject ) :
     @property
     def CategoryNameVisible(self)->bool:
         """
-    <summary>
         Indicates chart's data label category name display behavior.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        
+        Returns:
+            bool: whethere chart's data label category name display.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_CategoryNameVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_CategoryNameVisible.restype=c_bool
@@ -223,10 +225,10 @@ class ChartDataLabelCollection (  SpireObject ) :
     @property
     def LabelValueVisible(self)->bool:
         """
-    <summary>
         Indicates chart's data label value display behavior.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        
+        Returns:
+            bool: whethere chart's data label value display.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_LabelValueVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_LabelValueVisible.restype=c_bool
@@ -241,10 +243,10 @@ class ChartDataLabelCollection (  SpireObject ) :
     @property
     def PercentValueVisible(self)->bool:
         """
-    <summary>
         Indicates chart's data label percentage value display behavior.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        
+        Returns:
+            bool: whethere chart's data label percentage value display.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_PercentValueVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_PercentValueVisible.restype=c_bool
@@ -259,10 +261,10 @@ class ChartDataLabelCollection (  SpireObject ) :
     @property
     def SeriesNameVisible(self)->bool:
         """
-    <summary>
-        Gets or sets a Boolean to indicate the series name display behavior for the data labels on a chart. 
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Gets or sets a Boolean to indicate the series name display behavior for the data labels on a chart.
+        
+        Returns:
+            bool: whethere the series name display.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_SeriesNameVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_SeriesNameVisible.restype=c_bool
@@ -277,10 +279,10 @@ class ChartDataLabelCollection (  SpireObject ) :
     @property
     def BubbleSizeVisible(self)->bool:
         """
-    <summary>
         Indicates chart's data label bubble size value display behavior.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        
+        Returns:
+            bool: whethere data label bubble size value display.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_BubbleSizeVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_BubbleSizeVisible.restype=c_bool
@@ -296,10 +298,10 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     def Separator(self)->str:
         """
-    <summary>
         Sets or returns a Variant representing the separator used for the data labels on a chart.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        
+        Returns:
+            str: the separator used for the data labels on a chart.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_Separator.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_Separator.restype=c_void_p
@@ -316,10 +318,10 @@ class ChartDataLabelCollection (  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>
+        
+        Returns:
+            int: the number of elements actually contained in the collection.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_Count.restype=c_int
@@ -330,10 +332,10 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     def DataLabelShapeType(self)->'DataLabelShapeType':
         """
-    <summary>
         Gets or sets shape type of data labels.
-            Read/write <see cref="P:Spire.Presentation.Collections.ChartDataLabelCollection.DataLabelShapeType" />.
-    </summary>
+        
+        Returns:
+            DataLabelShapeType: DataLabel shape type.
         """
         GetDllLibPpt().ChartDataLabelCollection_get_DataLabelShapeType.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_DataLabelShapeType.restype=c_int
@@ -349,7 +351,10 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     def Add(self)->'ChartDataLabel':
         """
-
+        Add ChartDataLabel.
+        
+        Returns:
+            ChartDataLabel: chart datalabel.
         """
         GetDllLibPpt().ChartDataLabelCollection_Add.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_Add.restype=c_void_p
@@ -361,10 +366,10 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     def Remove(self ,value:'ChartDataLabel'):
         """
-    <summary>
-        Removes the first occurrence of a specific object from the collection.
-    </summary>
-    <param name="value">The DataLabel to remove from the collection.</param>
+        Add ChartDataLabel.
+        
+        Args:
+            value: chart datalabel which will be removed..
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -374,11 +379,13 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     def IndexOf(self ,value:'ChartDataLabel')->int:
         """
-    <summary>
-        Gets an index of the specified DataLabel in the collection.
-    </summary>
-    <param name="value">DataLabel to find.</param>
-    <returns>Index of a DataLabel or -1 if DataLabel not from this collection.</returns>
+        Gets the index of a specific data label.
+        
+        Args:
+            value (ChartDataLabel): The data label to locate
+            
+        Returns:
+            int: The zero-based index if found; otherwise, -1
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -389,6 +396,15 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     @dispatch
     def __getitem__(self, index):
+        """
+        Gets the data label at the specified index.
+        
+        Args:
+            index: The zero-based index of the label to retrieve
+            
+        Returns:
+            ChartDataLabel: The data label at the specified position
+        """
         if index >= self.Count:
             raise StopIteration
         GetDllLibPpt().ChartDataLabelCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -399,10 +415,13 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     def get_Item(self ,index:int)->'ChartDataLabel':
         """
-    <summary>
-        Gets the element at the specified index.
-            Read-only <see cref="T:Spire.Presentation.Charts.ChartDataLabel" />.
-    </summary>
+        Gets the data label at the specified index.
+        
+        Args:
+            index: The zero-based index of the label to retrieve
+            
+        Returns:
+            ChartDataLabel: The data label at the specified position
         """
         
         GetDllLibPpt().ChartDataLabelCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -416,7 +435,10 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     def LeaderLines(self)->'IChartGridLine':
         """
-
+        Gets the formatting for leader lines connecting labels to data points.
+        
+        Returns:
+            IChartGridLine: The leader lines formatting object
         """
         GetDllLibPpt().ChartDataLabelCollection_get_LeaderLines.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_get_LeaderLines.restype=c_void_p
@@ -428,9 +450,10 @@ class ChartDataLabelCollection (  SpireObject ) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
-        Gets an enumerator for the entire collection.
-    </summary>
+        Gets an enumerator to iterate through the data label collection.
+        
+        Returns:
+            IEnumerator: An enumerator for the collection
         """
         GetDllLibPpt().ChartDataLabelCollection_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabelCollection_GetEnumerator.restype=c_void_p

spire/presentation/charts/ChartDataLabelPosition.py

@@ -0,0 +1,35 @@
+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 ChartDataLabelPosition(Enum):
+    """
+    Indicates position options for data labels.
+
+    Attributes:
+        Bottom:Positioned at bottom
+        BestFit:Automatically determine best position
+        Center:Positioned at center
+        InsideBase:Positioned inside base
+        InsideEnd:Positioned inside end
+        Left:Positioned at left
+        OutsideEnd:Positioned outside end
+        Right:Positioned at right
+        Top:Positioned at top
+        none:No specific position
+    """
+    Bottom = 0
+    BestFit = 1
+    Center = 2
+    InsideBase = 3
+    InsideEnd = 4
+    Left = 5
+    OutsideEnd = 6
+    Right = 7
+    Top = 8
+    none = 9
+

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

@@ -6,15 +6,28 @@ from spire.presentation import *
 from ctypes import *
 
 class ChartDataPoint (  PptObject) :
+    """
+    Represents an individual data point within a chart series.
+    
+    This class provides properties to control the visual appearance and behavior
+    of individual data points in a chart.
+    """
 
     @dispatch
     def __init__(self):
+        """Initializes a new instance of ChartDataPoint."""
         GetDllLibPpt().ChartDataPoint_Creat.restype = c_void_p
         intPtr = CallCFunction(GetDllLibPpt().ChartDataPoint_Creat)
         super(ChartDataPoint, self).__init__(intPtr)
 
     @dispatch
     def __init__(self,param):
+        """
+        Initializes a new instance of ChartDataPoint.
+        
+        Args:
+            param: Either a numeric value or another ChartDataPoint to clone
+        """
         if isinstance(param, (int,float)):
             super(ChartDataPoint, self).__init__(param)
         else:
@@ -22,19 +35,14 @@ class ChartDataPoint (  PptObject) :
             GetDllLibPpt().ChartDataPoint_Creat.restype = c_void_p
             intPtr = CallCFunction(GetDllLibPpt().ChartDataPoint_Creat,param.Ptr)
             super(ChartDataPoint, self).__init__(intPtr)
-    
-    """
-    <summary>
-        Represents a data point on the chart.
-    </summary>
-    """
+  
     @property
     def Index(self)->int:
         """
-    <summary>
-        This index of collection.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Indicates whether bubbles have a 3D effect applied.
+        
+        Returns:
+            bool: True if 3D effect is enabled for bubbles
         """
         GetDllLibPpt().ChartDataPoint_get_Index.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPoint_get_Index.restype=c_int
@@ -49,9 +57,10 @@ class ChartDataPoint (  PptObject) :
     @property
     def IsBubble3D(self)->bool:
         """
-    <summary>
-        Specifies that the bubbles have a 3-D effect applied to them.
-    </summary>
+        Indicates whether bubbles have a 3D effect applied.
+        
+        Returns:
+            bool: True if 3D effect is enabled for bubbles
         """
         GetDllLibPpt().ChartDataPoint_get_IsBubble3D.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPoint_get_IsBubble3D.restype=c_bool
@@ -66,9 +75,10 @@ class ChartDataPoint (  PptObject) :
     @property
     def Distance(self)->int:
         """
-    <summary>
-        Specifies the distance from the center of the pie.
-    </summary>
+        Specifies the distance from the center of a pie chart (for slice explosion).
+        
+        Returns:
+            int: Distance value (0-100)
         """
         GetDllLibPpt().ChartDataPoint_get_Distance.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPoint_get_Distance.restype=c_int
@@ -83,9 +93,10 @@ class ChartDataPoint (  PptObject) :
     @property
     def InvertIfNegative(self)->bool:
         """
-    <summary>
-        Indicates whether invert its colors if the value is negative.
-    </summary>
+        Indicates whether colors should be inverted for negative values.
+        
+        Returns:
+            bool: True if colors should invert for negative values
         """
         GetDllLibPpt().ChartDataPoint_get_InvertIfNegative.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPoint_get_InvertIfNegative.restype=c_bool
@@ -101,10 +112,10 @@ class ChartDataPoint (  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 formatting properties for the data point.
+        
+        Returns:
+            FillFormat: Object containing fill properties
         """
         GetDllLibPpt().ChartDataPoint_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPoint_get_Fill.restype=c_void_p
@@ -117,9 +128,10 @@ class ChartDataPoint (  PptObject) :
 
     def Line(self)->'IChartGridLine':
         """
-    <summary>
-        Gets line style properties of a chart.
-    </summary>
+        Gets the line formatting properties for the data point.
+        
+        Returns:
+            IChartGridLine: Object containing line properties
         """
         GetDllLibPpt().ChartDataPoint_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPoint_get_Line.restype=c_void_p
@@ -132,10 +144,10 @@ class ChartDataPoint (  PptObject) :
 
     def Effect(self)->'EffectDag':
         """
-    <summary>
-        Gets effects used for a chart.
-            Read-only <see cref="T:Spire.Presentation.Drawing.EffectDag" />.
-    </summary>
+        Gets the effect properties for the data point.
+        
+        Returns:
+            EffectDag: Object containing effect properties
         """
         GetDllLibPpt().ChartDataPoint_get_Effect.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPoint_get_Effect.restype=c_void_p
@@ -148,10 +160,10 @@ class ChartDataPoint (  PptObject) :
 
     def Effect3D(self)->'FormatThreeD':
         """
-    <summary>
-        Gets 3D format of a chart.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FormatThreeD" />.
-    </summary>
+        Gets the 3D format properties for the data point.
+        
+        Returns:
+            FormatThreeD: Object containing 3D format properties
         """
         GetDllLibPpt().ChartDataPoint_get_Effect3D.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPoint_get_Effect3D.restype=c_void_p
@@ -164,10 +176,10 @@ class ChartDataPoint (  PptObject) :
 
     def MarkerFill(self)->'ChartEffectFormat':
         """
-    <summary>
-        Represents the formatting properties for marker.
-            A chart with Bubble type or Bubble3D type does not support this property.
-    </summary>
+        Gets the formatting properties for data point markers.
+        
+        Returns:
+            ChartEffectFormat: Object containing marker properties
         """
         GetDllLibPpt().ChartDataPoint_get_MarkerFill.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPoint_get_MarkerFill.restype=c_void_p
@@ -179,9 +191,10 @@ class ChartDataPoint (  PptObject) :
     @property
     def MarkerSize(self)->int:
         """
-    <summary>
-        Represents the marker size in a line chart, scatter chart, or radar chart.
-    </summary>
+        Gets or sets the size of markers in line/scatter/radar charts.
+        
+        Returns:
+            int: Marker size in points
         """
         GetDllLibPpt().ChartDataPoint_get_MarkerSize.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPoint_get_MarkerSize.restype=c_int
@@ -197,9 +210,10 @@ class ChartDataPoint (  PptObject) :
 
     def MarkerStyle(self)->'ChartMarkerType':
         """
-    <summary>
-        Represents the marker style in a line chart, scatter chart, or radar chart.
-    </summary>
+        Gets or sets the style of markers in line/scatter/radar charts.
+        
+        Returns:
+            ChartMarkerType: Enum value specifying marker style
         """
         GetDllLibPpt().ChartDataPoint_get_MarkerStyle.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPoint_get_MarkerStyle.restype=c_int
@@ -215,10 +229,10 @@ class ChartDataPoint (  PptObject) :
     @property
     def SetAsTotal(self)->bool:
         """
-    <summary>
-         True if the data point is considered as Subtotals or Totals. otherwise False.
-    </summary>
-<remarks>Applies only to Waterfall charts.</remarks>
+        Indicates if the data point represents a total in waterfall charts.
+        
+        Returns:
+            bool: True if data point is a total
         """
         GetDllLibPpt().ChartDataPoint_get_SetAsTotal.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPoint_get_SetAsTotal.restype=c_bool