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

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

@@ -8,17 +8,16 @@ import abc
 
 class ChartDataLabel (  PptObject) :
     """
-    <summary>
-        Represents a series labels.
-    </summary>
+    Represents a series label for a chart data point.
     """
     @property
 
     def DataLabelSize(self)->'SizeF':
         """
-    <summary>
-        Size of DataLabel
-    </summary>
+        Gets or sets the size of the data label.
+
+        Returns:
+            SizeF: Current size of the data label
         """
         GetDllLibPpt().ChartDataLabel_get_DataLabelSize.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_DataLabelSize.restype=c_void_p
@@ -35,10 +34,10 @@ class ChartDataLabel (  PptObject) :
     @property
     def IsDelete(self)->bool:
         """
-    <summary>
-        Gets or sets the label's delete flag.
-            True means that data label was removed by user but preserved in file.
-    </summary>
+        Indicates if the label was deleted by user but preserved in file.
+
+        Returns:
+            bool: True if marked for deletion
         """
         GetDllLibPpt().ChartDataLabel_get_IsDelete.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_IsDelete.restype=c_bool
@@ -53,10 +52,10 @@ class ChartDataLabel (  PptObject) :
     @property
     def ID(self)->int:
         """
-    <summary>
-        Specifies which data label are applied properties.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Specifies which data labels the properties apply to.
+
+        Returns:
+            int: Identifier for the data label
         """
         GetDllLibPpt().ChartDataLabel_get_ID.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_ID.restype=c_int
@@ -71,9 +70,10 @@ class ChartDataLabel (  PptObject) :
     @property
     def HasDataSource(self)->bool:
         """
-    <summary>
-        Gets and sets a reference to the worksheet
-    </summary>
+        Indicates if the data label has a reference to a worksheet.
+
+        Returns:
+            bool: True if has data source reference
         """
         GetDllLibPpt().ChartDataLabel_get_HasDataSource.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_HasDataSource.restype=c_bool
@@ -89,10 +89,10 @@ class ChartDataLabel (  PptObject) :
 
     def NumberFormat(self)->str:
         """
-    <summary>
-        Indicates the format string for the DataLabels object.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        Gets or sets the format string for the data label.
+
+        Returns:
+            str: Number format string
         """
         GetDllLibPpt().ChartDataLabel_get_NumberFormat.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_NumberFormat.restype=c_void_p
@@ -110,9 +110,10 @@ class ChartDataLabel (  PptObject) :
 
     def TextFrame(self)->'ITextFrameProperties':
         """
-    <summary>
-        Gets a textframe of this data label.
-    </summary>
+        Gets text frame properties of the data label.
+
+        Returns:
+            ITextFrameProperties: Text frame properties
         """
         GetDllLibPpt().ChartDataLabel_get_TextFrame.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_TextFrame.restype=c_void_p
@@ -125,10 +126,10 @@ class ChartDataLabel (  PptObject) :
 
     def TextProperties(self)->'ITextFrameProperties':
         """
-    <summary>
-        Gets text properties.
-            Readonly <see cref="T:Spire.Presentation.TextFrameProperties" />.
-    </summary>
+        Gets text properties of the data label.
+
+        Returns:
+            ITextFrameProperties: Read-only text properties
         """
         GetDllLibPpt().ChartDataLabel_get_TextProperties.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_TextProperties.restype=c_void_p
@@ -141,10 +142,10 @@ class ChartDataLabel (  PptObject) :
 
     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 the data label.
+
+        Returns:
+            FillFormat: Read-only FillFormat object
         """
         GetDllLibPpt().ChartDataLabel_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_Fill.restype=c_void_p
@@ -157,9 +158,10 @@ class ChartDataLabel (  PptObject) :
 
     def Line(self)->'IChartGridLine':
         """
-    <summary>
-        Gets line style properties of a chart.
-    </summary>
+        Gets line style properties of the data label.
+
+        Returns:
+            IChartGridLine: Line style properties
         """
         GetDllLibPpt().ChartDataLabel_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_Line.restype=c_void_p
@@ -172,10 +174,10 @@ class ChartDataLabel (  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 data label.
+
+        Returns:
+            EffectDag: Read-only EffectDag object
         """
         GetDllLibPpt().ChartDataLabel_get_Effect.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_Effect.restype=c_void_p
@@ -188,10 +190,10 @@ class ChartDataLabel (  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 properties of the data label.
+
+        Returns:
+            FormatThreeD: Read-only 3D format properties
         """
         GetDllLibPpt().ChartDataLabel_get_Effect3D.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_Effect3D.restype=c_void_p
@@ -204,10 +206,10 @@ class ChartDataLabel (  PptObject) :
 
     def Position(self)->'ChartDataLabelPosition':
         """
-    <summary>
-        Indicates the position of the data lable.
-            Read/write <see cref="T:Spire.Presentation.Charts.DataLabelPosition" />.
-    </summary>
+        Gets or sets the position of the data label.
+
+        Returns:
+            ChartDataLabelPosition: Current position value
         """
         GetDllLibPpt().ChartDataLabel_get_Position.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_Position.restype=c_int
@@ -223,10 +225,10 @@ class ChartDataLabel (  PptObject) :
     @property
     def LegendKeyVisible(self)->bool:
         """
-    <summary>
         Indicates whethere 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().ChartDataLabel_get_LegendKeyVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_LegendKeyVisible.restype=c_bool
@@ -241,10 +243,10 @@ class ChartDataLabel (  PptObject) :
     @property
     def CategoryNameVisible(self)->bool:
         """
-    <summary>
         Indicates whethere 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().ChartDataLabel_get_CategoryNameVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_CategoryNameVisible.restype=c_bool
@@ -259,10 +261,10 @@ class ChartDataLabel (  PptObject) :
     @property
     def LabelValueVisible(self)->bool:
         """
-    <summary>
         Indicates whethere 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().ChartDataLabel_get_LabelValueVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_LabelValueVisible.restype=c_bool
@@ -277,10 +279,10 @@ class ChartDataLabel (  PptObject) :
     @property
     def PercentageVisible(self)->bool:
         """
-    <summary>
         Indicates whethere 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().ChartDataLabel_get_PercentageVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_PercentageVisible.restype=c_bool
@@ -295,10 +297,10 @@ class ChartDataLabel (  PptObject) :
     @property
     def SeriesNameVisible(self)->bool:
         """
-    <summary>
         Indicates whethere the series name display behavior for the data labels on a chart. 
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+
+        Returns:
+            bool:whethere the series name display.
         """
         GetDllLibPpt().ChartDataLabel_get_SeriesNameVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_SeriesNameVisible.restype=c_bool
@@ -313,11 +315,12 @@ class ChartDataLabel (  PptObject) :
     @property
     def BubbleSizeVisible(self)->bool:
         """
-    <summary>
         Indicates whethere chart's data label bubble size value will display. 
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+
+        Returns:
+            bool:whethere chart's data label bubble size value will display.
         """
+        
         GetDllLibPpt().ChartDataLabel_get_BubbleSizeVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_BubbleSizeVisible.restype=c_bool
         ret = CallCFunction(GetDllLibPpt().ChartDataLabel_get_BubbleSizeVisible,self.Ptr)
@@ -332,10 +335,10 @@ class ChartDataLabel (  PptObject) :
 
     def Separator(self)->str:
         """
-    <summary>
         Gets or sets 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.
         """
         GetDllLibPpt().ChartDataLabel_get_Separator.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_Separator.restype=c_void_p
@@ -352,11 +355,11 @@ class ChartDataLabel (  PptObject) :
     @property
     def X(self)->float:
         """
-    <summary>
         Specifies the x location(left) of the dataLabel as a fraction of the width of the chart.
-            The position is relative to the default position.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        The position is relative to the default position.
+
+        Returns:
+            float:the x location(left) of the dataLabel.
         """
         GetDllLibPpt().ChartDataLabel_get_X.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_X.restype=c_float
@@ -371,11 +374,11 @@ class ChartDataLabel (  PptObject) :
     @property
     def Y(self)->float:
         """
-    <summary>
         Specifies the y location(top) of the dataLabel as a fraction of the height of the chart.
-            The position is relative to the default position.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        The position is relative to the default position.
+
+        Returns:
+            float:the y location(top) of the dataLabel.
         """
         GetDllLibPpt().ChartDataLabel_get_Y.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_Y.restype=c_float
@@ -390,10 +393,10 @@ class ChartDataLabel (  PptObject) :
     @property
     def RotationAngle(self)->float:
         """
-    <summary>
         Gets or sets rotation angle of chart's data label.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+
+        Returns:
+            float:rotation angle of chart's data label.
         """
         GetDllLibPpt().ChartDataLabel_get_RotationAngle.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_RotationAngle.restype=c_float
@@ -409,10 +412,10 @@ class ChartDataLabel (  PptObject) :
 
     def DataLabelShapeType(self)->'DataLabelShapeType':
         """
-    <summary>
         Gets or sets shape type of data label.
-            Read/write <see cref="P:Spire.Presentation.Charts.ChartDataLabel.DataLabelShapeType" />.
-    </summary>
+
+        Returns:
+            DataLabelShapeType:shape type of data label..
         """
         GetDllLibPpt().ChartDataLabel_get_DataLabelShapeType.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_DataLabelShapeType.restype=c_int
@@ -428,9 +431,10 @@ class ChartDataLabel (  PptObject) :
     @property
     def ShowDataLabelsRange(self)->bool:
         """
-    <summary>
         if show data labels range.
-    </summary>
+
+        Returns:
+            bool:whethere show data labels range.
         """
         GetDllLibPpt().ChartDataLabel_get_ShowDataLabelsRange.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_ShowDataLabelsRange.restype=c_bool
@@ -445,9 +449,10 @@ class ChartDataLabel (  PptObject) :
     @property
     def UseValuePlaceholder(self)->bool:
         """
-    <summary>
-        If use ValuePlaceholder
-    </summary>
+        If use ValuePlaceholder.
+
+        Returns:
+            bool:whethere use ValuePlaceholder.
         """
         GetDllLibPpt().ChartDataLabel_get_UseValuePlaceholder.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataLabel_get_UseValuePlaceholder.restype=c_bool
@@ -463,9 +468,10 @@ class ChartDataLabel (  PptObject) :
 
     def ValuePlaceholder()->str:
         """
-    <summary>
         Use the ValuePlaceholder to represent chart value
-    </summary>
+
+        Returns:
+            str:value placeholder.
         """
         #GetDllLibPpt().ChartDataLabel_ValuePlaceholder.argtypes=[]
         GetDllLibPpt().ChartDataLabel_ValuePlaceholder.restype=c_void_p