XlsArcShape module

class XlsArcShape.XlsArcShape

Bases: XlsPrstGeomShape, IArcShape

Represents an arc shape in an Excel worksheet.

This class provides properties and methods for manipulating arc shapes in Excel, including appearance settings such as line style, color, arrow styles, and text formatting. It extends XlsPrstGeomShape and implements the IArcShape interface.

property BeginArrowHeadStyle: ShapeArrowStyleType

Gets the style of the arrowhead at the beginning of the arc.

Returns:

An enumeration value representing the arrowhead style.

Return type:

ShapeArrowStyleType

property BeginArrowheadLength: ShapeArrowLengthType

Gets the length of the arrowhead at the beginning of the arc.

Returns:

An enumeration value representing the arrowhead length.

Return type:

ShapeArrowLengthType

property BeginArrowheadWidth: ShapeArrowWidthType

Gets the width of the arrowhead at the beginning of the arc.

Returns:

An enumeration value representing the arrowhead width.

Return type:

ShapeArrowWidthType

property Color: Color

Gets the color of the arc line.

Returns:

A Color object representing the color of the arc line.

Return type:

Color

property DashStyle: ShapeDashLineStyleType

Gets the dash style of the arc line.

Returns:

An enumeration value representing the dash style.

Return type:

ShapeDashLineStyleType

property EndArrowHeadStyle: ShapeArrowStyleType

Gets the style of the arrowhead at the end of the arc.

Returns:

An enumeration value representing the arrowhead style.

Return type:

ShapeArrowStyleType

property EndArrowheadLength: ShapeArrowLengthType

Gets the length of the arrowhead at the end of the arc.

Returns:

An enumeration value representing the arrowhead length.

Return type:

ShapeArrowLengthType

property EndArrowheadWidth: ShapeArrowWidthType

Gets the width of the arrowhead at the end of the arc.

Returns:

An enumeration value representing the arrowhead width.

Return type:

ShapeArrowWidthType

property HAlignment: CommentHAlignType

Gets the horizontal alignment of the text in the arc shape.

Returns:

An enumeration value representing the horizontal alignment.

Return type:

CommentHAlignType

Gets the hyperlink associated with the arc shape.

Returns:

An object representing the hyperlink associated with the arc shape.

Return type:

IHyperLink

property IsTextLocked: bool

Gets a value indicating whether the text in the arc shape is locked.

Returns:

True if the text is locked; otherwise, False.

Return type:

bool

property PrstShapeType: PrstGeomShapeType

Gets the preset shape type of the arc shape.

Returns:

An enumeration value representing the preset shape type.

Return type:

PrstGeomShapeType

property RichText: IRichTextString

Gets the rich text formatting of the text in the arc shape.

Returns:

An object representing the rich text formatting.

Return type:

IRichTextString

property ShapeType: ExcelShapeType

Gets the type of the shape.

Returns:

An enumeration value representing the type of the shape.

Return type:

ExcelShapeType

property Style: ShapeLineStyleType

Gets the line style of the arc.

Returns:

An enumeration value representing the line style.

Return type:

ShapeLineStyleType

property Text: str

Gets the text content of the arc shape.

Returns:

The text content of the arc shape.

Return type:

str

property TextRotation: TextRotationType

Gets the rotation type of the text in the arc shape.

Returns:

An enumeration value representing the text rotation type.

Return type:

TextRotationType

property VAlignment: CommentVAlignType

Gets the vertical alignment of the text in the arc shape.

Returns:

An enumeration value representing the vertical alignment.

Return type:

CommentVAlignType

property Weight: float

Gets the weight (thickness) of the arc line in points.

Returns:

The weight of the arc line in points.

Return type:

float