XlsLineShape module
- class XlsLineShape.XlsLineShape
Bases:
XlsPrstGeomShape,ILineShapeRepresents a line shape in an Excel worksheet.
This class provides properties and methods for manipulating line shapes in Excel, including appearance settings such as line style, color, weight, arrow styles, and positioning. It extends XlsPrstGeomShape and implements the ILineShape interface.
- property BeginArrowHeadStyle: ShapeArrowStyleType
Gets or sets the style of the arrowhead at the beginning of the line.
- Returns:
An enumeration value representing the style of the beginning arrowhead.
- Return type:
ShapeArrowStyleType
- property BeginArrowheadLength: ShapeArrowLengthType
Gets or sets the length of the arrowhead at the beginning of the line.
- Returns:
An enumeration value representing the length of the beginning arrowhead.
- Return type:
ShapeArrowLengthType
- property BeginArrowheadWidth: ShapeArrowWidthType
Gets or sets the width of the arrowhead at the beginning of the line.
- Returns:
An enumeration value representing the width of the beginning arrowhead.
- Return type:
ShapeArrowWidthType
- property Color: Color
Gets or sets the color of the line.
- Returns:
A Color object representing the color of the line.
- Return type:
Color
- property DashStyle: ShapeDashLineStyleType
Gets or sets the dash style of the line.
- Returns:
An enumeration value representing the dash style of the line.
- Return type:
ShapeDashLineStyleType
- property EndArrowHeadStyle: ShapeArrowStyleType
Gets or sets the style of the arrowhead at the end of the line.
- Returns:
An enumeration value representing the style of the ending arrowhead.
- Return type:
ShapeArrowStyleType
- property EndArrowheadLength: ShapeArrowLengthType
Gets or sets the length of the arrowhead at the end of the line.
- Returns:
An enumeration value representing the length of the ending arrowhead.
- Return type:
ShapeArrowLengthType
- property EndArrowheadWidth: ShapeArrowWidthType
Gets or sets the width of the arrowhead at the end of the line.
- Returns:
An enumeration value representing the width of the ending arrowhead.
- Return type:
ShapeArrowWidthType
- property EndPoint: Point
Gets or sets the end point of the line.
- Returns:
A Point object representing the end point of the line.
- Return type:
Point
- property FlipH: bool
Gets or sets whether the line is flipped horizontally.
- Returns:
True if the line is flipped horizontally, False otherwise.
- Return type:
bool
- property FlipV: bool
Gets or sets whether the line is flipped vertically.
- Returns:
True if the line is flipped vertically, False otherwise.
- Return type:
bool
- property HyLink: IHyperLink
Gets or sets the hyperlink for the line.
- Returns:
An IHyperLink object representing the hyperlink for the line.
- Return type:
IHyperLink
- property LineShapeType: LineShapeType
Gets or sets the type of the line shape.
- Returns:
An enumeration value representing the type of the line shape.
- Return type:
LineShapeType
- property MiddleOffset: int
Gets or sets the middle offset of the line.
- Returns:
The middle offset of the line.
- Return type:
int
- property MiddleOffsetPercent: float
Gets or sets the middle offset of the line as a percentage.
- Returns:
The middle offset percentage of the line.
- Return type:
float
- property PrstShapeType: PrstGeomShapeType
Gets or sets the shape type of the line.
- Returns:
An enumeration value representing the shape type of the line.
- Return type:
PrstGeomShapeType
- property ShapeType: ExcelShapeType
Gets or sets the shape type of the line.
- Returns:
An enumeration value representing the shape type of the line.
- Return type:
ExcelShapeType
- property StartPoint: Point
Gets or sets the start point of the line.
- Returns:
A Point object representing the start point of the line.
- Return type:
Point
- property Style: ShapeLineStyleType
Gets or sets the style of the line.
- Returns:
An enumeration value representing the style of the line.
- Return type:
ShapeLineStyleType
- property Transparency: float
Gets or sets the transparency of the line.
- Returns:
The transparency value of the line (0.0 to 1.0).
- Return type:
float
- property Weight: float
Gets or sets the weight (thickness) of the line in points.
- Returns:
The weight of the line in points.
- Return type:
float