TextLeaderElement

Canonical path: NemAll_Python_BasisElements.TextLeaderElement

Bases: BasisElement, AllplanElement

Implementation of the Text Leader element

Methods:

• GetEndSymbolProperties –

  Get the end symbol properties for the leader

• GetLine –

  Get the leader line geometry

• SetEndSymbolProperties –

  Set the end symbol properties for the leader

• SetLine –

  Set the leader line geometry

• SetTextRefPointIndex –

  Set the text reference point index

• __init__ –

  Overloaded function. See individual overloads.

• __repr__ –

  Convert to string

Attributes:

• EndSymbolProperties (EndSymbolsProperties) –

  Get the end symbol properties for the leader

• Line (Polyline2D) –

  Get the leader line geometry

EndSymbolProperties property writable

EndSymbolProperties: EndSymbolsProperties

Get the end symbol properties for the leader

Line property writable

Line: Polyline2D

Get the leader line geometry

GetEndSymbolProperties

GetEndSymbolProperties() -> EndSymbolsProperties

Get the end symbol properties for the leader

Returns:

• EndSymbolsProperties –

  Reference to the properties for the leader end symbol (arrow, etc.)

GetLine

GetLine() -> Polyline2D

Get the leader line geometry

Returns:

• Polyline2D –

  Reference to the Polyline2D defining the text leader line

SetEndSymbolProperties

SetEndSymbolProperties(endSymbolProps: EndSymbolsProperties)

Set the end symbol properties for the leader

Parameters:

• endSymbolProps (EndSymbolsProperties) –

  Properties for the leader end symbol (arrow, etc.)

SetLine

SetLine(line: Polyline2D)

Set the leader line geometry

Parameters:

• line (Polyline2D) –

  Polyline2D defining the text leader line

SetTextRefPointIndex

SetTextRefPointIndex(textRefPointIndex: TextRefPointIndex)

Set the text reference point index

Parameters:

• textRefPointIndex (TextRefPointIndex) –

  Index specifying which point of the text element the leader should connect to (LeftTop, MiddleLeft, etc.):

__init__ overloaded

__init__()

Initialize

__init__(textElement: BaseElementAdapter)

Constructor

Parameters:

• textElement (BaseElementAdapter) –

  Text element to associate with the leader

__init__(element: TextLeaderElement)

Copy constructor

Parameters:

• element (TextLeaderElement) –

  Element to copy

__repr__

__repr__() -> str

Convert to string

Placeholder