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

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

@@ -8,7 +8,7 @@ import abc
 
 class InteriorColorPattern(Enum):
     """
-<summary></summary>
+    Specifies shading patterns used for shape fills.
     """
     Auto = 0
     Checker = 1

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

@@ -8,16 +8,17 @@ import abc
 
 class LayoutProperty (SpireObject) :
     """
+    Contains advanced layout properties for specialized chart types.
 
+    Provides configuration options for waterfall and box-whisker charts.
     """
     @property
     def ShowConnectorLines(self)->bool:
         """
-    <summary>
-        Gets or sets a boolean value indicating whether to display 
-            Connector Lines between data points
-    </summary>
-<remarks>Applies only to Waterfall Charts</remarks>
+        Indicates whether connector lines are displayed (Waterfall charts).
+
+        Returns:
+            bool: True to show connector lines, False to hide.
         """
         GetDllLibPpt().LayoutProperty_get_ShowConnectorLines.argtypes=[c_void_p]
         GetDllLibPpt().LayoutProperty_get_ShowConnectorLines.restype=c_bool
@@ -32,10 +33,10 @@ class LayoutProperty (SpireObject) :
     @property
     def ShowMeanLine(self)->bool:
         """
-    <summary>
-        Gets or sets a boolean value indicating whether to display
-            Mean Line in Box and Whisker chart
-    </summary>
+        Indicates whether mean line is displayed (Box-Whisker charts).
+
+        Returns:
+            bool: True to show mean line, False to hide.
         """
         GetDllLibPpt().LayoutProperty_get_ShowMeanLine.argtypes=[c_void_p]
         GetDllLibPpt().LayoutProperty_get_ShowMeanLine.restype=c_bool
@@ -50,10 +51,10 @@ class LayoutProperty (SpireObject) :
     @property
     def ShowMeanMarkers(self)->bool:
         """
-    <summary>
-        Gets or sets a boolean value indicating whether to display
-            Mean Marker in Box and Whisker chart
-    </summary>
+        Indicates whether mean markers are displayed (Box-Whisker charts).
+
+        Returns:
+            bool: True to show markers, False to hide.
         """
         GetDllLibPpt().LayoutProperty_get_ShowMeanMarkers.argtypes=[c_void_p]
         GetDllLibPpt().LayoutProperty_get_ShowMeanMarkers.restype=c_bool
@@ -68,10 +69,10 @@ class LayoutProperty (SpireObject) :
     @property
     def ShowOutlierPoints(self)->bool:
         """
-    <summary>
-        Gets or sets a boolean value indicating whether to display
-            Outlier Points in Box and Whisker chart
-    </summary>
+        Indicates whether outlier points are shown (Box-Whisker charts).
+
+        Returns:
+            bool: True to show outliers, False to hide.
         """
         GetDllLibPpt().LayoutProperty_get_ShowOutlierPoints.argtypes=[c_void_p]
         GetDllLibPpt().LayoutProperty_get_ShowOutlierPoints.restype=c_bool
@@ -86,10 +87,10 @@ class LayoutProperty (SpireObject) :
     @property
     def ShowInnerPoints(self)->bool:
         """
-    <summary>
-        Gets or sets a boolean value indicating whether to display
-            Inner Points in Box and Whisker chart
-    </summary>
+        Indicates whether inner points are shown (Box-Whisker charts).
+
+        Returns:
+            bool: True to show inner points, False to hide.
         """
         GetDllLibPpt().LayoutProperty_get_ShowInnerPoints.argtypes=[c_void_p]
         GetDllLibPpt().LayoutProperty_get_ShowInnerPoints.restype=c_bool
@@ -105,10 +106,10 @@ class LayoutProperty (SpireObject) :
 
     def QuartileCalculationType(self)->'QuartileCalculation':
         """
-    <summary>
-         Gets / Sets whether the Quartile calculation is Exclusive or Inclusive
-    </summary>
-<remarks>Applies only to Box and Whisker Charts</remarks>
+        Gets/sets quartile calculation method (Box-Whisker charts).
+
+        Returns:
+            QuartileCalculation: Current calculation method.
         """
         GetDllLibPpt().LayoutProperty_get_QuartileCalculationType.argtypes=[c_void_p]
         GetDllLibPpt().LayoutProperty_get_QuartileCalculationType.restype=c_int

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

@@ -8,17 +8,18 @@ import abc
 
 class LegendEntry (SpireObject) :
     """
-    <summary>
-        Legend entry.
-    </summary>
+    Represents an entry in a chart legend.
+
+    Contains formatting and text properties for individual legend items.
     """
     @property
 
     def TextProperties(self)->'ITextFrameProperties':
         """
-    <summary>
-        Represent text properties of legend entry.
-    </summary>
+        Gets text formatting properties.
+
+        Returns:
+            ITextFrameProperties: Text formatting settings.
         """
         GetDllLibPpt().LegendEntry_get_TextProperties.argtypes=[c_void_p]
         GetDllLibPpt().LegendEntry_get_TextProperties.restype=c_void_p

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

@@ -8,18 +8,24 @@ import abc
 
 class LegendEntryCollection (SpireObject) :
     """
-    <summary>
-        Represents collection of  <see cref="T:Spire.Presentation.Charts.ChartSeriesDataFormat" /></summary>
+    Represents a collection of chart series data formats.
+
+    This class provides access to legend entries in a chart, allowing retrieval of individual entries by index.
+
+    Example:
+        collection = chart.legend.entries
+        first_entry = collection[0]
     """
 
     def get_Item(self ,index:int)->'LegendEntry':
         """
-    <summary>
         Gets the element at the specified index.
-    </summary>
-    <returns>
-            The element at the specified index.
-              </returns>
+
+        Args:
+            index: The zero-based index of the element to get
+
+        Returns:
+            LegendEntry: The legend entry at the specified index
         """
         
         GetDllLibPpt().LegendEntryCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -32,6 +38,10 @@ class LegendEntryCollection (SpireObject) :
     @property
     def Count(self)->int:
         """
+        Gets the number of elements contained in the collection.
+
+        Returns:
+            int: The total number of legend entries in the collection
         """
         
         GetDllLibPpt().LegendEntryCollection_GetCount.argtypes=[c_void_p]

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

@@ -8,9 +8,13 @@ import abc
 
 class PictureType(Enum):
     """
-    <summary>
-        Indicates mode of bar picture filling.
-    </summary>
+    Specifies how an image fills chart bars.
+
+    Enumeration Members:
+        none: No picture filling
+        Stack: Stacks images to fill bars
+        StackScale: Stacks and scales images to fill bars
+        Stretch: Stretches a single image to fill bars
     """
     none = -1
     Stack = 0

spire/presentation/charts/ProjectionType.py

@@ -0,0 +1,22 @@
+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 ProjectionType(Enum):
+    """
+    Specifies the type of map projection used for geographic data visualization.
+    
+    Attributes:
+        Automatic: Automatically determine the best projection type.
+        Mercator: Mercator cylindrical map projection.
+        Miller: Miller cylindrical map projection.
+        Robinson: Robinson pseudo-cylindrical map projection.
+    """
+    Automatic = 0
+    Mercator = 1
+    Miller = 2
+    Robinson = 2

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

@@ -8,9 +8,9 @@ import abc
 
 class QuartileCalculation(Enum):
     """
-    <summary>
-        It represents Quartile calculation used for Box and Whisker Chart series
-     </summary>
+    Defines the method used for calculating quartiles in Box and Whisker charts.
+    
+    This enumeration determines how quartiles are calculated when generating Box and Whisker chart statistics.
     """
     InclusiveMedian = 0
     ExclusiveMedian = 1

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

@@ -8,9 +8,13 @@ import abc
 
 class TickLabelPositionType(Enum):
     """
-    <summary>
-        Represents the position type of tick-mark labels on the specified axis.
-    </summary>
+    Represents the position type of tick-mark labels on the specified axis.
+
+    Attributes:
+        TickLabelPositionHigh: High position.
+        TickLabelPositionLow: Low position.
+        TickLabelPositionNextToAxis: Next to axis position.
+        TickLabelPositionNone: No position.
     """
     TickLabelPositionHigh = 0
     TickLabelPositionLow = 1

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

@@ -8,9 +8,13 @@ import abc
 
 class TickMarkType(Enum):
     """
-    <summary>
-        Represents the tick mark type for the specified axis.
-    </summary>
+    Represents the tick mark type for the specified axis.
+    
+    Attributes:
+        TickMarkNone: No tick marks
+        TickMarkCross: Cross-shaped tick marks
+        TickMarkInside: Tick marks inside the axis
+        TickMarkOutside: Tick marks outside the axis
     """
     TickMarkNone = 0
     TickMarkCross = 1

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

@@ -8,9 +8,12 @@ import abc
 
 class TreeMapLabelOption(Enum):
     """
-    <summary>
-        It represents the Label position in Tree Map chart
-     </summary>
+    Defines label positioning options for TreeMap charts.
+    
+    Attributes:
+        none: No labels displayed.
+        Banner: Labels displayed in banners.
+        Overlapping: Labels displayed overlapping data points.
     """
     none = 0
     Banner = 1

spire/presentation/charts/TrendlinesType.py

@@ -0,0 +1,27 @@
+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 TrendlinesType(Enum):
+    """
+    Specifies the type of trendline used in charts.
+    
+    Attributes:
+        Exponential: Represents an exponential trendline.
+        Linear: Represents a linear trendline.
+        Logarithmic: Represents a logarithmic trendline.
+        MovingAverage: Represents a moving average trendline.
+        Polynomial: Represents a polynomial trendline.
+        Power: Represents a power trendline.
+    """
+    Exponential = 0
+    Linear = 1
+    Logarithmic = 2
+    MovingAverage = 3
+    Polynomial = 4
+    Power = 5
+

spire/presentation/{CommentAuthorCollection.py → collections/CommentAuthorCollection.py}

@@ -8,9 +8,11 @@ import abc
 
 class CommentAuthorCollection (  CommentAuthorList) :
     """
-    <summary>
-        Represents a collection of comment authors.
-    </summary>
+    Represents a collection of comment authors. Inherits from CommentAuthorList.
+    
+    Attributes:
+        IsSynchronized (bool): Indicates whether access to the collection is thread-safe.
+        SyncRoot (SpireObject): Gets an object that can be used to synchronize access to the collection.
     """
 #
 #    def CopyTo(self ,array:'Array',index:int):
@@ -30,9 +32,10 @@ class CommentAuthorCollection (  CommentAuthorList) :
     @property
     def IsSynchronized(self)->bool:
         """
-    <summary>
-        Gets a value indicating whether access to the collection is synchronized (thread-safe).
-    </summary>
+        Indicates whether access to the collection is synchronized (thread-safe).
+        
+        Returns:
+            bool: True if access is synchronized; otherwise False.
         """
         GetDllLibPpt().CommentAuthorCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().CommentAuthorCollection_get_IsSynchronized.restype=c_bool
@@ -43,10 +46,10 @@ class CommentAuthorCollection (  CommentAuthorList) :
 
     def SyncRoot(self)->'SpireObject':
         """
-    <summary>
-        Gets a synchronization root.
-            Readonly <see cref="T:System.Object" />.
-    </summary>
+        Gets a synchronization root object.
+        
+        Returns:
+            SpireObject: Object that can be used to synchronize access to the collection.
         """
         GetDllLibPpt().CommentAuthorCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().CommentAuthorCollection_get_SyncRoot.restype=c_void_p

spire/presentation/{CommentAuthorList.py → collections/CommentAuthorList.py}

@@ -8,12 +8,19 @@ import abc
 
 class CommentAuthorList (SpireObject) :
     """
-
+    Manages a collection of comment authors in a presentation.
+    
+    Attributes:
+        Count (int): Number of authors in the collection.
+        Presentation (Presentation): Parent presentation object containing this collection.
     """
     @property
     def Count(self)->int:
         """
-
+        Gets the number of authors in the collection.
+        
+        Returns:
+            int: Number of comment authors.
         """
         GetDllLibPpt().CommentAuthorList_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().CommentAuthorList_get_Count.restype=c_int
@@ -22,6 +29,15 @@ class CommentAuthorList (SpireObject) :
 
     @dispatch
     def __getitem__(self, index):
+        """
+        Gets the author at the specified index using indexer syntax.
+        
+        Args:
+            index (int): Zero-based index of the author.
+        
+        Returns:
+            ICommentAuthor: Comment author object.
+        """
         if index >= self.Count:
             raise StopIteration
          
@@ -33,7 +49,13 @@ class CommentAuthorList (SpireObject) :
 
     def get_Item(self ,index:int)->'ICommentAuthor':
         """
-
+        Gets the author at the specified index.
+        
+        Args:
+            index (int): Zero-based index of the author.
+        
+        Returns:
+            ICommentAuthor: Comment author object.
         """
         
         GetDllLibPpt().CommentAuthorList_get_Item.argtypes=[c_void_p ,c_int]
@@ -46,14 +68,15 @@ class CommentAuthorList (SpireObject) :
 
     def AddAuthor(self ,name:str,initials:str)->'ICommentAuthor':
         """
-    <summary>
-        Add new author at the end of a collection.
-    </summary>
-    <param name="name">Name of a new author.</param>
-    <param name="initials">Initials of a new author.</param>
-    <returns>ICommentAuthor</returns>
-        """
+        Adds a new author to the collection.
         
+        Args:
+            name (str): Display name of the new author.
+            initials (str): Initials of the new author.
+        
+        Returns:
+            ICommentAuthor: Newly created comment author object.
+        """
         namePtr = StrToPtr(name)
         initialsPtr = StrToPtr(initials)
         GetDllLibPpt().CommentAuthorList_AddAuthor.argtypes=[c_void_p ,c_char_p,c_char_p]
@@ -78,12 +101,14 @@ class CommentAuthorList (SpireObject) :
 
     def FindByName(self ,name:str)->List['ICommentAuthor']:
        """
-   <summary>
-       Find author in a collection by name.
-   </summary>
-   <param name="name">Name of an author to find.</param>
-   <returns>Authors or null.</returns>
-       """
+        Finds authors by their display name.
+        
+        Args:
+            name (str): Name to search for.
+        
+        Returns:
+            List[ICommentAuthor]: List of matching comment authors.
+        """
        namePtr = StrToPtr(name)
        GetDllLibPpt().CommentAuthorList_FindByName.argtypes=[c_void_p ,c_char_p]
        GetDllLibPpt().CommentAuthorList_FindByName.restype=IntPtrArray
@@ -113,7 +138,10 @@ class CommentAuthorList (SpireObject) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-
+        Gets an enumerator that iterates through the collection.
+        
+        Returns:
+            IEnumerator: Enumerator object for the collection.
         """
         GetDllLibPpt().CommentAuthorList_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().CommentAuthorList_GetEnumerator.restype=c_void_p
@@ -126,7 +154,10 @@ class CommentAuthorList (SpireObject) :
 
     def Presentation(self)->'Presentation':
         """
-
+        Gets the parent presentation containing this collection.
+        
+        Returns:
+            Presentation: Parent presentation object.
         """
         GetDllLibPpt().CommentAuthorList_get_Presentation.argtypes=[c_void_p]
         GetDllLibPpt().CommentAuthorList_get_Presentation.restype=c_void_p

spire/presentation/{CommentCollection.py → collections/CommentCollection.py}

@@ -8,31 +8,18 @@ import abc
 
 class CommentCollection (  CommentList) :
     """
-    <summary>
-        Represents a collection of comments of one author.
-    </summary>
+    Represents a collection of comments of one author.
+    
+    Inherits from CommentList and provides thread-safety properties.
     """
-#
-#    def CopyTo(self ,array:'Array',index:int):
-#        """
-#    <summary>
-#        Copies all elements from the collection to the specified array.
-#    </summary>
-#    <param name="array">Target array.</param>
-#    <param name="index">Starting index in the target array.</param>
-#        """
-#        intPtrarray:c_void_p = array.Ptr
-#
-#        GetDllLibPpt().CommentCollection_CopyTo.argtypes=[c_void_p ,c_void_p,c_int]
-#        CallCFunction(GetDllLibPpt().CommentCollection_CopyTo,self.Ptr, intPtrarray,index)
-
 
     @property
     def IsSynchronized(self)->bool:
         """
-    <summary>
-        Gets a value indicating whether access to the collection is synchronized (thread-safe).
-    </summary>
+        Indicates whether access to the collection is synchronized (thread-safe).
+        
+        Returns:
+            bool: True if access is thread-safe, False otherwise.
         """
         GetDllLibPpt().CommentCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().CommentCollection_get_IsSynchronized.restype=c_bool
@@ -43,10 +30,10 @@ class CommentCollection (  CommentList) :
 
     def SyncRoot(self)->'SpireObject':
         """
-    <summary>
-        Gets a synchronization root.
-            Readonly <see cref="T:System.Object" />.
-    </summary>
+        Gets the synchronization root object for thread-safe access.
+        
+        Returns:
+            SpireObject: An object that can be used to synchronize access to the collection.
         """
         GetDllLibPpt().CommentCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().CommentCollection_get_SyncRoot.restype=c_void_p