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

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

@@ -7,19 +7,19 @@ from ctypes import *
 
 class ChartDataPointCollection (  IEnumerable) :
     """
-    <summary>
-        Represents a collection of ChartPoint.
-    </summary>
+    Represents a collection of ChartPoint.
     """
 
     def get_Item(self ,index:int)->'ChartDataPoint':
         """
-    <summary>
         Gets the element at the specified index.
-            Read-only <see cref="T:Spire.Presentation.Charts.ChartDataPoint" />.
-    </summary>
+
+        Args:
+            index (int): The zero-based index of the element to get
+
+        Returns:
+            ChartDataPoint: The ChartDataPoint at the specified index
         """
-        
         GetDllLibPpt().ChartDataPointCollection_get_Item.argtypes=[c_void_p ,c_int]
         GetDllLibPpt().ChartDataPointCollection_get_Item.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().ChartDataPointCollection_get_Item,self.Ptr, index)
@@ -30,11 +30,13 @@ class ChartDataPointCollection (  IEnumerable) :
 
     def Add(self ,value:'ChartDataPoint')->int:
         """
-    <summary>
-        Adds the new DataLabel at the end of a collection.
-    </summary>
-    <param name="value">The DataLabel </param>
-    <returns></returns>
+        Adds a new DataLabel at the end of the collection.
+
+        Args:
+            value (ChartDataPoint): The ChartDataPoint to add
+
+        Returns:
+            int: The index at which the value has been added
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -46,9 +48,10 @@ class ChartDataPointCollection (  IEnumerable) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
         Gets an enumerator for the entire collection.
-    </summary>
+
+        Returns:
+            IEnumerator: An IEnumerator for the entire collection
         """
         GetDllLibPpt().ChartDataPointCollection_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPointCollection_GetEnumerator.restype=c_void_p
@@ -60,10 +63,10 @@ class ChartDataPointCollection (  IEnumerable) :
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets the number of elements actually contained in the collection.
-            Read-only <see cref="T:System.Int32" />.
-    </summary>
+        Gets the number of elements contained in the collection.
+
+        Returns:
+            int: The number of elements actually contained in the collection
         """
         GetDllLibPpt().ChartDataPointCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataPointCollection_get_Count.restype=c_int

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

@@ -8,18 +8,16 @@ import abc
 
 class ChartDataTable (SpireObject) :
     """
-    <summary>
-        Represents data table format.
-    </summary>
+    Represents data table format properties for a chart.
     """
     @property
 
     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 chart data table.
+
+        Returns:
+            FillFormat: Read-only FillFormat object
         """
         GetDllLibPpt().ChartDataTable_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataTable_get_Fill.restype=c_void_p
@@ -32,9 +30,10 @@ class ChartDataTable (SpireObject) :
 
     def Line(self)->'IChartGridLine':
         """
-    <summary>
-        Gets line style properties of a chart.
-    </summary>
+        Gets line style properties of the chart data table.
+
+        Returns:
+            IChartGridLine: Line style properties
         """
         GetDllLibPpt().ChartDataTable_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataTable_get_Line.restype=c_void_p
@@ -47,10 +46,10 @@ class ChartDataTable (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 the chart data table.
+
+        Returns:
+            EffectDag: Read-only EffectDag object
         """
         GetDllLibPpt().ChartDataTable_get_Effect.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataTable_get_Effect.restype=c_void_p
@@ -63,10 +62,10 @@ class ChartDataTable (SpireObject) :
 
     def Text(self)->'ITextFrameProperties':
         """
-    <summary>
-        Gets Text used for a DataTable.
-            Read-only <see cref="T:Spire.Presentation.Drawing.EffectDag" />.
-    </summary>
+        Gets text properties used for the data table.
+
+        Returns:
+            ITextFrameProperties: Text properties object
         """
         GetDllLibPpt().ChartDataTable_get_Text.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataTable_get_Text.restype=c_void_p
@@ -79,10 +78,10 @@ class ChartDataTable (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 properties of the chart data table.
+
+        Returns:
+            FormatThreeD: Read-only 3D format properties
         """
         GetDllLibPpt().ChartDataTable_get_Effect3D.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataTable_get_Effect3D.restype=c_void_p
@@ -94,9 +93,10 @@ class ChartDataTable (SpireObject) :
     @property
     def HasHorzBorder(self)->bool:
         """
-    <summary>
-         True if data table has horizontal border.
-    </summary>
+        Indicates if the data table has horizontal borders.
+
+        Returns:
+            bool: True if horizontal borders are visible
         """
         GetDllLibPpt().ChartDataTable_get_HasHorzBorder.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataTable_get_HasHorzBorder.restype=c_bool
@@ -111,9 +111,10 @@ class ChartDataTable (SpireObject) :
     @property
     def HasBorders(self)->bool:
         """
-    <summary>
-        True if data table has borders.
-    </summary>
+        Indicates if the data table has any borders.
+
+        Returns:
+            bool: True if any borders are visible
         """
         GetDllLibPpt().ChartDataTable_get_HasBorders.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataTable_get_HasBorders.restype=c_bool
@@ -128,9 +129,10 @@ class ChartDataTable (SpireObject) :
     @property
     def HasVertBorder(self)->bool:
         """
-    <summary>
-        True if data table has vertical border.
-    </summary>
+        Indicates if the data table has vertical borders.
+
+        Returns:
+            bool: True if vertical borders are visible
         """
         GetDllLibPpt().ChartDataTable_get_HasVertBorder.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataTable_get_HasVertBorder.restype=c_bool
@@ -145,9 +147,10 @@ class ChartDataTable (SpireObject) :
     @property
     def ShowLegendKey(self)->bool:
         """
-    <summary>
-        Indicates that the data label has legend key.
-    </summary>
+        Indicates that the data label has a legend key.
+
+        Returns:
+            bool: True if legend key is visible
         """
         GetDllLibPpt().ChartDataTable_get_ShowLegendKey.argtypes=[c_void_p]
         GetDllLibPpt().ChartDataTable_get_ShowLegendKey.restype=c_bool

spire/presentation/charts/ChartDisplayUnitType.py

@@ -0,0 +1,37 @@
+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 ChartDisplayUnitType(Enum):
+    """
+    Specifies the unit of measurement for displaying chart values.
+    
+    Attributes:
+        none:No scaling - display actual values.
+        Hundreds:Display values in hundreds.
+        Thousands:Display values in thousands.
+        TenThousands:Display values in ten thousands.
+        HundredThousands:Display values in hundred thousands.
+        Millions:Display values in millions.
+        TenMillions:Display values in ten millions.
+        HundredMillions:Display values in hundred millions.
+        Billions:Display values in billions.
+        Trillions:Display values in trillions.
+        Percentage:Display values as percentages.
+    """
+    none = 0
+    Hundreds = 1
+    Thousands = 2
+    TenThousands = 3
+    HundredThousands = 4
+    Millions = 5
+    TenMillions = 6
+    HundredMillions = 7
+    Billions = 8
+    Trillions = 9
+    Percentage = 10
+

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

@@ -8,18 +8,16 @@ import abc
 
 class ChartEffectFormat (  PptObject, IChartEffectFormat) :
     """
-    <summary>
-        Represents chart format properties.
-    </summary>
+    Represents chart format properties.
     """
     @property
 
     def Fill(self)->'FillFormat':
         """
-    <summary>
         Gets fill style properties of a chart.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FillFormat" />.
-    </summary>
+
+        Returns:
+            FillFormat: Read-only FillFormat object
         """
         GetDllLibPpt().ChartEffectFormat_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().ChartEffectFormat_get_Fill.restype=c_void_p
@@ -32,9 +30,10 @@ class ChartEffectFormat (  PptObject, IChartEffectFormat) :
 
     def Line(self)->'IChartGridLine':
         """
-    <summary>
         Gets line style properties of a chart.
-    </summary>
+
+        Returns:
+            IChartGridLine: Line style properties
         """
         GetDllLibPpt().ChartEffectFormat_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().ChartEffectFormat_get_Line.restype=c_void_p
@@ -47,10 +46,10 @@ class ChartEffectFormat (  PptObject, IChartEffectFormat) :
 
     def Effect(self)->'EffectDag':
         """
-    <summary>
         Gets effects used for a chart.
-            Read-only <see cref="T:Spire.Presentation.Drawing.EffectDag" />.
-    </summary>
+
+        Returns:
+            EffectDag: Read-only EffectDag object
         """
         GetDllLibPpt().ChartEffectFormat_get_Effect.argtypes=[c_void_p]
         GetDllLibPpt().ChartEffectFormat_get_Effect.restype=c_void_p
@@ -63,10 +62,10 @@ class ChartEffectFormat (  PptObject, IChartEffectFormat) :
 
     def Effect3D(self)->'FormatThreeD':
         """
-    <summary>
         Gets 3D format of a chart.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FormatThreeD" />.
-    </summary>
+
+        Returns:
+            FormatThreeD: Read-only 3D format properties
         """
         GetDllLibPpt().ChartEffectFormat_get_Effect3D.argtypes=[c_void_p]
         GetDllLibPpt().ChartEffectFormat_get_Effect3D.restype=c_void_p

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

@@ -8,17 +8,17 @@ import abc
 
 class ChartLegend (SpireObject) :
     """
-    <summary>
-        Represents chart's legend properties.
-    </summary>
+    Represents the legend properties of a chart.
+    
+    This class controls the position, appearance, and content of a chart's legend.
     """
     @property
     def Width(self)->float:
         """
-    <summary>
-        Gets or sets the width of a legend.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the width of the legend.
+        
+        Returns:
+            float: Width in points
         """
         GetDllLibPpt().ChartLegend_get_Width.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_Width.restype=c_float
@@ -33,10 +33,10 @@ class ChartLegend (SpireObject) :
     @property
     def Height(self)->float:
         """
-    <summary>
-        Gets or sets the height of a legend.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the height of the legend.
+        
+        Returns:
+            float: Height in points
         """
         GetDllLibPpt().ChartLegend_get_Height.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_Height.restype=c_float
@@ -51,10 +51,10 @@ class ChartLegend (SpireObject) :
     @property
     def Left(self)->float:
         """
-    <summary>
-        Gets or sets the x coordinate of a legend.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the X-coordinate of the legend.
+        
+        Returns:
+            float: Position from left in points
         """
         GetDllLibPpt().ChartLegend_get_Left.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_Left.restype=c_float
@@ -69,10 +69,10 @@ class ChartLegend (SpireObject) :
     @property
     def Top(self)->float:
         """
-    <summary>
-        Gets or sets the y coordinate of a legend.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the Y-coordinate of the legend.
+        
+        Returns:
+            float: Position from top in points
         """
         GetDllLibPpt().ChartLegend_get_Top.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_Top.restype=c_float
@@ -87,10 +87,10 @@ class ChartLegend (SpireObject) :
     @property
     def IsOverlay(self)->bool:
         """
-    <summary>
-        Indicates whether other chart elements allowed to overlap legend.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Indicates whether other chart elements can overlap the legend.
+        
+        Returns:
+            bool: True if overlapping is allowed
         """
         GetDllLibPpt().ChartLegend_get_IsOverlay.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_IsOverlay.restype=c_bool
@@ -106,10 +106,10 @@ class ChartLegend (SpireObject) :
 
     def Position(self)->'ChartLegendPositionType':
         """
-    <summary>
-        Gets or sets the position of the legend on a chart.
-            Read/write <see cref="T:Spire.Presentation.Charts.ChartLegendPositionType" />.
-    </summary>
+        Gets or sets the position of the legend relative to the chart.
+        
+        Returns:
+            ChartLegendPositionType: Enum value specifying position
         """
         GetDllLibPpt().ChartLegend_get_Position.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_Position.restype=c_int
@@ -126,10 +126,10 @@ class ChartLegend (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 formatting properties for the legend.
+        
+        Returns:
+            FillFormat: Object containing fill properties
         """
         GetDllLibPpt().ChartLegend_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_Fill.restype=c_void_p
@@ -142,9 +142,10 @@ class ChartLegend (SpireObject) :
 
     def Line(self)->'IChartGridLine':
         """
-    <summary>
-        Gets line style properties of a chart.
-    </summary>
+        Gets the line formatting properties for the legend border.
+        
+        Returns:
+            IChartGridLine: Object containing line properties
         """
         GetDllLibPpt().ChartLegend_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_Line.restype=c_void_p
@@ -157,10 +158,10 @@ class ChartLegend (SpireObject) :
 
     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 legend.
+        
+        Returns:
+            EffectDag: Object containing effect properties
         """
         GetDllLibPpt().ChartLegend_get_Effect.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_Effect.restype=c_void_p
@@ -173,10 +174,10 @@ class ChartLegend (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 format properties for the legend.
+        
+        Returns:
+            FormatThreeD: Object containing 3D properties
         """
         GetDllLibPpt().ChartLegend_get_Effect3D.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_Effect3D.restype=c_void_p
@@ -189,9 +190,10 @@ class ChartLegend (SpireObject) :
 
     def TextProperties(self)->'ITextFrameProperties':
         """
-    <summary>
-        Represent text properties of Legend
-    </summary>
+        Gets the text formatting properties for the legend title.
+        
+        Returns:
+            ITextFrameProperties: Object containing text properties
         """
         GetDllLibPpt().ChartLegend_get_TextProperties.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_TextProperties.restype=c_void_p
@@ -203,9 +205,10 @@ class ChartLegend (SpireObject) :
 
     def setEntrys(self ,range:'CellRanges'):
         """
-    <summary>
-        set Legend Entry
-    </summary>
+        Sets the legend entries using data from specified cell ranges.
+        
+        Args:
+            range: CellRanges object containing legend entry data
         """
         intPtrrange:c_void_p = range.Ptr
 
@@ -215,12 +218,11 @@ class ChartLegend (SpireObject) :
 
     def DeleteEntry(self ,index:int):
         """
-    <summary>
-        Delete legend entry by index
-    </summary>
-    <param name="index">The legend entry index must be between 0 and LegendCount - 1 + TrendLinesCount</param>
-        """
+        Deletes a specific legend entry.
         
+        Args:
+            index: The 0-based index of the entry to delete
+        """
         GetDllLibPpt().ChartLegend_DeleteEntry.argtypes=[c_void_p ,c_int]
         CallCFunction(GetDllLibPpt().ChartLegend_DeleteEntry,self.Ptr, index)
 
@@ -228,9 +230,10 @@ class ChartLegend (SpireObject) :
 
     def EntryTextProperties(self)->List['TextCharacterProperties']:
         """
-    <summary>
-        Represent text properties of Legend Entry
-    </summary>
+        Gets text properties for individual legend entries.
+        
+        Returns:
+            List[TextCharacterProperties]: Collection of text properties
         """
         GetDllLibPpt().ChartLegend_get_EntryTextProperties.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_EntryTextProperties.restype=IntPtrArray
@@ -243,9 +246,10 @@ class ChartLegend (SpireObject) :
 
     def LegendEntrys(self)->'LegendEntryCollection':
         """
-    <summary>
-        Get legend entry collection.
-    </summary>
+        Gets the collection of legend entries.
+        
+        Returns:
+            LegendEntryCollection: Collection of legend entries
         """
         GetDllLibPpt().ChartLegend_get_LegendEntrys.argtypes=[c_void_p]
         GetDllLibPpt().ChartLegend_get_LegendEntrys.restype=c_void_p

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

@@ -8,9 +8,15 @@ import abc
 
 class ChartLegendPositionType(Enum):
     """
-    <summary>
-        Indicates a position of legend on a chart.
-    </summary>
+    Indicates the position of legend on a chart.
+
+    Attributes:
+        none:
+        Bottom:Legend positioned at bottom
+        Left:Legend positioned at left
+        Right:Legend positioned at right
+        Top:Legend positioned at top
+        TopRight:Legend positioned at top-right
     """
     none = -1
     Bottom = 0

spire/presentation/charts/ChartMarkerType.py

@@ -0,0 +1,39 @@
+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 ChartMarkerType(Enum):
+    """
+    Chart marker types used in data points.
+
+    Attributes:
+        UnDefined:Undefined marker type
+        Circle:Circular marker
+        Dash:Dash-shaped marker
+        Diamond:Diamond-shaped marker
+        Dot:Dot-shaped marker
+        none:No marker
+        Picture:Picture marker
+        Plus:Plus-shaped marker
+        Square:Square-shaped marker
+        Star:Star-shaped marker
+        Triangle:Triangle-shaped marker
+        X:X-shaped marker
+    """
+    UnDefined = -1
+    Circle = 0
+    Dash = 1
+    Diamond = 2
+    Dot = 3
+    none = 4
+    Picture = 5
+    Plus = 6
+    Square = 7
+    Star = 8
+    Triangle = 9
+    X = 10
+