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

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

@@ -8,16 +8,18 @@ import abc
 
 class ChartAxis (  PptObject, IChartAxis) :
     """
-    <summary>
-        Encapsulates the object that represents a chart's axis.
-    </summary>
+    Represents a chart axis, defining scale, labels, and formatting for chart dimensions.
+    
+    This class provides comprehensive control over axis properties including scaling, 
+    tick marks, grid lines, labels, and positioning for both category and value axes.
     """
     @property
     def IsCrossCategories(self)->bool:
         """
-    <summary>
-         Indicates that the value axis crosses the category axis between categorie
-    </summary>
+        Indicates whether the value axis crosses between categories.
+        
+        Returns:
+            bool: True if crossing between categories, False otherwise
         """
         GetDllLibPpt().ChartAxis_get_IsCrossCategories.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_IsCrossCategories.restype=c_bool
@@ -32,11 +34,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def CrossAt(self)->float:
         """
-    <summary>
-        Represents the point on the value axis where the category axis crosses it.
-    </summary>
-<remarks>The number should be a integer when it applies to category axis.
-            And the value must be between 1 and 31999.</remarks>
+        Gets or sets the point where the category axis crosses the value axis.
+        
+        Returns:
+            float: The crossing point value
         """
         GetDllLibPpt().ChartAxis_get_CrossAt.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_CrossAt.restype=c_float
@@ -52,9 +53,10 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def DisplayUnit(self)->'ChartDisplayUnitType':
         """
-    <summary>
-          Returns or sets the unit label for the specified axis.
-    </summary>
+        Gets or sets the unit label for the axis.
+        
+        Returns:
+            ChartDisplayUnitType: The current display unit type
         """
         GetDllLibPpt().ChartAxis_get_DisplayUnit.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_DisplayUnit.restype=c_int
@@ -70,9 +72,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def IsAutoMax(self)->bool:
         """
-    <summary>
-         Automatic maximum selected.
-    </summary>
+        Indicates whether the axis maximum is automatically calculated.
+        
+        Returns:
+            bool: True if maximum is automatic, False if manually specified
         """
         GetDllLibPpt().ChartAxis_get_IsAutoMax.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_IsAutoMax.restype=c_bool
@@ -87,9 +90,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def MaxValue(self)->float:
         """
-    <summary>
-         Maximum value on axis.
-    </summary>
+        Gets or sets the maximum value for the axis.
+        
+        Returns:
+            float: The maximum axis value
         """
         GetDllLibPpt().ChartAxis_get_MaxValue.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_MaxValue.restype=c_float
@@ -104,9 +108,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def MinorUnit(self)->float:
         """
-    <summary>
-         Value of minor increment.
-    </summary>
+        Gets or sets value of minor increment.
+        
+        Returns:
+            float: The minor increment.
         """
         GetDllLibPpt().ChartAxis_get_MinorUnit.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_MinorUnit.restype=c_float
@@ -121,9 +126,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def IsAutoMinor(self)->bool:
         """
-    <summary>
-         Indicates whether the minor unit of the axis is automatically assigned.
-    </summary>
+        Gets or sets Indicates whether the minor unit of the axis is automatically assigned.
+        
+        Returns:
+            bool: if the minor unit of the axis is automatically assigned.
         """
         GetDllLibPpt().ChartAxis_get_IsAutoMinor.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_IsAutoMinor.restype=c_bool
@@ -138,9 +144,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def MajorUnit(self)->float:
         """
-    <summary>
-         Represents the major units for the axis.
-    </summary>
+        Gets or sets the major units for the axis.
+        
+        Returns:
+            float: The major units value.
         """
         GetDllLibPpt().ChartAxis_get_MajorUnit.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_MajorUnit.restype=c_float
@@ -155,9 +162,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def IsAutoMajor(self)->bool:
         """
-    <summary>
-        Automatic major selected. 
-    </summary>
+        Gets or sets automatic major selected. 
+        
+        Returns:
+            bool: if major unit is automatic.
         """
         GetDllLibPpt().ChartAxis_get_IsAutoMajor.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_IsAutoMajor.restype=c_bool
@@ -172,9 +180,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def IsAutoMin(self)->bool:
         """
-    <summary>
-         Automatic minimum selected.
-     </summary>
+        Gets or sets automatic min selected. 
+        
+        Returns:
+            bool: if min unit is automatic.
         """
         GetDllLibPpt().ChartAxis_get_IsAutoMin.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_IsAutoMin.restype=c_bool
@@ -189,9 +198,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def MinValue(self)->float:
         """
-    <summary>
-         Represents the minimum value on the value axis.
-    </summary>
+        Represents the minimum value on the value axis.
+        
+        Returns:
+            float: minimum value.
         """
         GetDllLibPpt().ChartAxis_get_MinValue.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_MinValue.restype=c_float
@@ -206,9 +216,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def IsLogScale(self)->bool:
         """
-    <summary>
-         Logarithmic scale.
-    </summary>
+        Logarithmic scale.
+        
+        Returns:
+            bool: if Logarithmic scale.
         """
         GetDllLibPpt().ChartAxis_get_IsLogScale.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_IsLogScale.restype=c_bool
@@ -223,9 +234,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def LogScale(self)->int:
         """
-    <summary>
-         Gets or sets the logarithmic base.
-     </summary>
+        Gets or sets the logarithmic base.
+        
+        Returns:
+            int: logarithmic base.
         """
         GetDllLibPpt().ChartAxis_get_LogScale.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_LogScale.restype=c_int
@@ -240,9 +252,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def IsReversed(self)->bool:
         """
-    <summary>
-         Gets or set plots data points from last to first.
-     </summary>
+        Gets or set plots data points from last to first.
+        
+        Returns:
+            bool:if plots data points are from last to first.
         """
         GetDllLibPpt().ChartAxis_get_IsReversed.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_IsReversed.restype=c_bool
@@ -257,9 +270,7 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def IsVisible(self)->bool:
         """
-    <summary>
-         Gets or sets if the axis is visible.
-     </summary>
+        Gets or sets if the axis is visible.
         """
         GetDllLibPpt().ChartAxis_get_IsVisible.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_IsVisible.restype=c_bool
@@ -275,9 +286,10 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def MajorTickMark(self)->'TickMarkType':
         """
-    <summary>
-         Represents major tick marks.
-    </summary>
+        Represents major tick marks.
+        
+        Returns:
+            TickMarkType:TickMark Type.
         """
         GetDllLibPpt().ChartAxis_get_MajorTickMark.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_MajorTickMark.restype=c_int
@@ -294,9 +306,7 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def MinorTickMark(self)->'TickMarkType':
         """
-    <summary>
-         Represents the type of minor tick mark for the specified axis.
-    </summary>
+        Represents the type of minor tick mark for the specified axis.
         """
         GetDllLibPpt().ChartAxis_get_MinorTickMark.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_MinorTickMark.restype=c_int
@@ -313,9 +323,7 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def TickLabelPosition(self)->'TickLabelPositionType':
         """
-    <summary>
-         Represents the position of tick-mark labels on the specified axis.
-     </summary>
+        Represents the position of tick-mark labels on the specified axis.
         """
         GetDllLibPpt().ChartAxis_get_TickLabelPosition.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_TickLabelPosition.restype=c_int
@@ -331,10 +339,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
 
     def MajorUnitScale(self)->'ChartBaseUnitType':
+        
         """
-    <summary>
-         Represents the major unit scale for the category axis.
-     </summary>
+        Represents the major unit scale for the category axis.
+  
         """
         GetDllLibPpt().ChartAxis_get_MajorUnitScale.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_MajorUnitScale.restype=c_int
@@ -351,9 +359,8 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def MinorUnitScale(self)->'ChartBaseUnitType':
         """
-    <summary>
          Represents the major unit scale for the category axis.
-     </summary>
+
         """
         GetDllLibPpt().ChartAxis_get_MinorUnitScale.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_MinorUnitScale.restype=c_int
@@ -370,9 +377,8 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def BaseUnitScale(self)->'ChartBaseUnitType':
         """
-    <summary>
          Represents the base unit scale for the category axis.
-     </summary>
+     
         """
         GetDllLibPpt().ChartAxis_get_BaseUnitScale.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_BaseUnitScale.restype=c_int
@@ -389,9 +395,8 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def MinorGridLines(self)->'IChartGridLine':
         """
-    <summary>
-         Represents minor gridlines on a chart axis.
-     </summary>
+        Represents minor gridlines on a chart axis.
+
         """
         GetDllLibPpt().ChartAxis_get_MinorGridLines.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_MinorGridLines.restype=c_void_p
@@ -404,9 +409,8 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def MajorGridTextLines(self)->'IChartGridLine':
         """
-    <summary>
-         Represents major gridlines on a chart axis.
-     </summary>
+        Represents major gridlines on a chart axis.
+    
         """
         GetDllLibPpt().ChartAxis_get_MajorGridTextLines.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_MajorGridTextLines.restype=c_void_p
@@ -419,9 +423,8 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def ChartEffectFormat(self)->'IChartEffectFormat':
         """
-    <summary>
-         Represents format of axis
-     </summary>
+        Represents format of axis.
+
         """
         GetDllLibPpt().ChartAxis_get_ChartEffectFormat.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_ChartEffectFormat.restype=c_void_p
@@ -434,9 +437,8 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def TextProperties(self)->'ITextFrameProperties':
         """
-    <summary>
-         Represent text properties of axis
-     </summary>
+        Represent text properties of axis
+   
         """
         GetDllLibPpt().ChartAxis_get_TextProperties.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_TextProperties.restype=c_void_p
@@ -449,9 +451,8 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def Title(self)->'ChartTextArea':
         """
-    <summary>
-         Gets the axis' title.
-     </summary>
+        Gets the axis' title.
+     
         """
         GetDllLibPpt().ChartAxis_get_Title.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_Title.restype=c_void_p
@@ -464,9 +465,8 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def ChartCrossType(self)->'ChartCrossesType':
         """
-    <summary>
          Represents the CrossType on the specified axis where the other axis crosses.
-     </summary>
+    
         """
         GetDllLibPpt().ChartAxis_get_ChartCrossType.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_ChartCrossType.restype=c_int
@@ -483,9 +483,8 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def Position(self)->'AxisPositionType':
         """
-    <summary>
-         Represents position of axis
-     </summary>
+        Represents position of axis
+   
         """
         GetDllLibPpt().ChartAxis_get_Position.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_Position.restype=c_int
@@ -501,10 +500,8 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def HasTitle(self)->bool:
         """
-    <summary>
         Indicates whether a axis has a visible title.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+   
         """
         GetDllLibPpt().ChartAxis_get_HasTitle.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_HasTitle.restype=c_bool
@@ -537,9 +534,8 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def NumberFormat(self)->str:
         """
-    <summary>
         Gets or sets number format string.
-    </summary>
+    
         """
         GetDllLibPpt().ChartAxis_get_NumberFormat.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_NumberFormat.restype=c_void_p
@@ -556,9 +552,8 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def HasDataSource(self)->bool:
         """
-    <summary>
         Indicates whether the format is linked source data.
-    </summary>
+
         """
         GetDllLibPpt().ChartAxis_get_HasDataSource.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_HasDataSource.restype=c_bool
@@ -573,9 +568,8 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def TextRotationAngle(self)->float:
         """
-    <summary>
         Text rotation angle.
-    </summary>
+
         """
         GetDllLibPpt().ChartAxis_get_TextRotationAngle.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_TextRotationAngle.restype=c_float
@@ -591,9 +585,8 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def TickLabelSpacing(self)->'UInt32':
         """
-    <summary>
         Represents the number of categories or series between tick-mark labels.
-    </summary>
+
         """
         GetDllLibPpt().ChartAxis_get_TickLabelSpacing.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_TickLabelSpacing.restype=c_void_p
@@ -610,7 +603,7 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def IsAutomaticTickLabelSpacing(self)->bool:
         """
-
+        Indicates whether tick label spacing is automatic.
         """
         GetDllLibPpt().ChartAxis_get_IsAutomaticTickLabelSpacing.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_IsAutomaticTickLabelSpacing.restype=c_bool
@@ -626,9 +619,8 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def TickMarkSpacing(self)->'UInt32':
         """
-    <summary>
         Represents the number of ticks between tick-mark labels.
-    </summary>
+
         """
         GetDllLibPpt().ChartAxis_get_TickMarkSpacing.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_TickMarkSpacing.restype=c_void_p
@@ -660,6 +652,7 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def LblOffset(self)->int:
         """
+        Represents the distance between tick-mark labels and axis.
 
         """
         GetDllLibPpt().ChartAxis_get_LblOffset.argtypes=[c_void_p]
@@ -670,9 +663,8 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def HasMultiLvlLbl(self)->bool:
         """
-    <summary>
         Gets or sets if the label of categoryAxis has multiple levels.
-    </summary>
+
         """
         GetDllLibPpt().ChartAxis_get_HasMultiLvlLbl.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_HasMultiLvlLbl.restype=c_bool
@@ -687,9 +679,8 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def IsMergeSameLabel(self)->bool:
         """
-    <summary>
         Gets or sets if the first level label of categoryAxis merge the same item.
-    </summary>
+   
         """
         GetDllLibPpt().ChartAxis_get_IsMergeSameLabel.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_IsMergeSameLabel.restype=c_bool
@@ -705,7 +696,7 @@ class ChartAxis (  PptObject, IChartAxis) :
 
     def AxisType(self)->'AxisType':
         """
-
+        Axis type.
         """
         GetDllLibPpt().ChartAxis_get_AxisType.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_AxisType.restype=c_int
@@ -721,10 +712,8 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def IsBinningByCategory(self)->bool:
         """
-    <summary>
         True if bins generated by category values. otherwise False
-    </summary>
-<remarks>Applies only to Histogram and Pareto charts.</remarks>
+    
         """
         GetDllLibPpt().ChartAxis_get_IsBinningByCategory.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_IsBinningByCategory.restype=c_bool
@@ -739,10 +728,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def HasAutomaticBins(self)->bool:
         """
-    <summary>
+    
         True if bins generated are automatic. otherwise False
-    </summary>
-<remarks>Applies only to Histogram and Pareto charts.</remarks>
+        Applies only to Histogram and Pareto charts.
+
         """
         GetDllLibPpt().ChartAxis_get_HasAutomaticBins.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_HasAutomaticBins.restype=c_bool
@@ -757,10 +746,10 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def NumberOfBins(self)->int:
         """
-    <summary>
         Get or set the Number of Bins in the axis
-    </summary>
-<remarks>Applies only to Histogram and Pareto charts.Can be a value from 1 through 31999.</remarks>
+    
+        Applies only to Histogram and Pareto charts.Can be a value from 1 through 31999.
+
         """
         GetDllLibPpt().ChartAxis_get_NumberOfBins.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_NumberOfBins.restype=c_int
@@ -775,10 +764,9 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def BinWidth(self)->float:
         """
-    <summary>
         Get or Set the number of data points in each range.
-    </summary>
-<remarks>Applies only to Histogram and Pareto charts.</remarks>
+   
+        Applies only to Histogram and Pareto charts.
         """
         GetDllLibPpt().ChartAxis_get_BinWidth.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_BinWidth.restype=c_double
@@ -793,10 +781,9 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def UnderflowBinValue(self)->float:
         """
-    <summary>
         Get or Set the UnderFlow Bin value
-    </summary>
-<remarks>Applies only to Histogram and Pareto charts.</remarks>
+        Applies only to Histogram and Pareto charts.
+
         """
         GetDllLibPpt().ChartAxis_get_UnderflowBinValue.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_UnderflowBinValue.restype=c_double
@@ -811,10 +798,8 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def OverflowBinValue(self)->float:
         """
-    <summary>
         Get or Set the OverFlow Bin value
-    </summary>
-<remarks>Applies only to Histogram and Pareto charts.</remarks>
+        Applies only to Histogram and Pareto charts.
         """
         GetDllLibPpt().ChartAxis_get_OverflowBinValue.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_OverflowBinValue.restype=c_double
@@ -829,7 +814,7 @@ class ChartAxis (  PptObject, IChartAxis) :
     @property
     def GapWidth(self)->int:
         """
-
+        Get or Set the gap width between two ticks.
         """
         GetDllLibPpt().ChartAxis_get_GapWidth.argtypes=[c_void_p]
         GetDllLibPpt().ChartAxis_get_GapWidth.restype=c_int

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

@@ -8,9 +8,8 @@ import abc
 
 class ChartBaseUnitType(Enum):
     """
-    <summary>
-        Represents the base unit for the category axis
-    </summary>
+    Specifies the base unit type for category axis scaling.
+    
     """
     Days = 0
     Months = 1

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

@@ -8,17 +8,17 @@ import abc
 
 class ChartCategory (  PptObject) :
     """
-    <summary>
-        Represents chart categories.
-    </summary>
+    Represents chart categories in a presentation.
+    
     """
     @property
 
     def DataRange(self)->'CellRange':
         """
-    <summary>
-        Gets or sets Spire.Xls.Cell object.
-    </summary>
+        Gets or sets the CellRange object associated with this chart category.
+        
+        Returns:
+            CellRange: The cell range defining the category's data source.
         """
         GetDllLibPpt().ChartCategory_get_DataRange.argtypes=[c_void_p]
         GetDllLibPpt().ChartCategory_get_DataRange.restype=c_void_p
@@ -29,6 +29,12 @@ class ChartCategory (  PptObject) :
 
     @DataRange.setter
     def DataRange(self, value:'CellRange'):
+        """
+        Sets the CellRange object for this chart category.
+        
+        Args:
+            value (CellRange): The new cell range to associate with this category.
+        """
         GetDllLibPpt().ChartCategory_set_DataRange.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().ChartCategory_set_DataRange,self.Ptr, value.Ptr)