Skip to main content
View as Markdown

IPCB_LeaderDimension interface

A leader dimension on a PCB document, which labels an object, point or area with a text connected to it by a leader line ending in an arrow or a dot.

public interface IPCB_LeaderDimension : IPCB_Dimension

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Inherits: IPCB_Primitive → IPCB_Group → IPCB_Dimension

Remarks​

The leader runs through the dimension's reference points: it starts at the first reference point, where the arrow or the dot is drawn, and ends at the last one, where the text is placed. The label text can be enclosed in a circle or a square (Shape), and the leader can end in an arrow or a dot of a definable size (Dot, DotSize).

A new leader dimension has two references. When the dimension is updated, every reference after the first is detached from the object it refers to, so only the first reference can stay attached to an object.

The text, arcs and tracks that draw the leader are returned by Text, Dot_Arc, Circle_Arc, Arrow_Track1, Arrow_Track2, Square_Track1 to Square_Track4 and Line_Track.

Properties​

PropertyTypeAccessDescription
Dotboolget; setWhether the leader ends in a dot instead of an arrowhead at its first reference point.
DotSizeintget; setThe diameter of the dot drawn when Dot is true, in internal units (10,000 per mil).
ShapeTShapeget; setThe enclosure drawn around the leader text.

Dot​

Whether the leader ends in a dot instead of an arrowhead at its first reference point.

bool GetState_Dot();
void SetState_Dot(bool argValue);

Type: bool · Access: read/write

The default is false (an arrowhead). The size of the dot is DotSize.

DotSize​

The diameter of the dot drawn when Dot is true, in internal units (10,000 per mil).

int GetState_DotSize();
void SetState_DotSize(int argValue);

Type: int · Access: read/write

The default is 40 mil.

Shape​

The enclosure drawn around the leader text.

TShape GetState_Shape();
void SetState_Shape(TShape argValue);

Type: TShape · Access: read/write

The accessors are extension methods of IPCB_LeaderDimensionHelper (using PCB;).

TShape.eNoShape (the default) does not enclose the text, TShape.eRounded encloses it in a circle and TShape.eRectangular in a square. The diameter of the circle and the side of the square are Size. With any value other than TShape.eNoShape the text is centered in the enclosure.

Methods​

MethodReturnsDescription
Arrow_Track1IPCB_TrackReturns the first of the two tracks that draw the arrowhead at the leader's first reference point.
Arrow_Track2IPCB_TrackReturns the second of the two tracks that draw the arrowhead at the leader's first reference point.
Circle_ArcIPCB_ArcReturns the arc that draws the circle around the text when Shape is TShape.eRounded.
Dot_ArcIPCB_ArcReturns the arc that draws the dot at the leader's first reference point when Dot is true.
Line_TrackIPCB_TrackReturns a line of the leader.
Square_Track1IPCB_TrackReturns the first of the four tracks that draw the square around the text when Shape is TShape.eRectangular.
Square_Track2IPCB_TrackReturns the second of the four tracks that draw the square around the text when Shape is TShape.eRectangular.
Square_Track3IPCB_TrackReturns the third of the four tracks that draw the square around the text when Shape is TShape.eRectangular.
Square_Track4IPCB_TrackReturns the fourth of the four tracks that draw the square around the text when Shape is TShape.eRectangular.
TextIPCB_TextReturns the text of the leader dimension.

Arrow_Track1​

Returns the first of the two tracks that draw the arrowhead at the leader's first reference point.

IPCB_Track Arrow_Track1();

Returns: IPCB_Track

Extension method of IPCB_LeaderDimensionHelper (using PCB;).

When Dot is true, no arrowhead is drawn and both arrow tracks lie along the first line of the leader.

Arrow_Track2​

Returns the second of the two tracks that draw the arrowhead at the leader's first reference point.

IPCB_Track Arrow_Track2();

Returns: IPCB_Track

Extension method of IPCB_LeaderDimensionHelper (using PCB;).

When Dot is true, no arrowhead is drawn and both arrow tracks lie along the first line of the leader.

Circle_Arc​

Returns the arc that draws the circle around the text when Shape is TShape.eRounded.

IPCB_Arc Circle_Arc();

Returns: IPCB_Arc

Extension method of IPCB_LeaderDimensionHelper (using PCB;).

For any other Shape the arc has a radius of 0.

Dot_Arc​

Returns the arc that draws the dot at the leader's first reference point when Dot is true.

IPCB_Arc Dot_Arc();

Returns: IPCB_Arc

Extension method of IPCB_LeaderDimensionHelper (using PCB;).

The arc is a full circle with a radius of 0 whose line width is DotSize.

Line_Track​

Returns a line of the leader.

IPCB_Track Line_Track(int argI);
ParameterTypePassingDescription
argIintvalueThe zero-based index of the line, from 0 to References_Count - 2.

Returns: IPCB_Track

Extension method of IPCB_LeaderDimensionHelper (using PCB;).

A leader dimension has one line for each reference after the first. Line 0 starts at the first reference point and line i joins reference points i and i + 1.

Square_Track1​

Returns the first of the four tracks that draw the square around the text when Shape is TShape.eRectangular.

IPCB_Track Square_Track1();

Returns: IPCB_Track

Extension method of IPCB_LeaderDimensionHelper (using PCB;).

Square_Track2​

Returns the second of the four tracks that draw the square around the text when Shape is TShape.eRectangular.

IPCB_Track Square_Track2();

Returns: IPCB_Track

Extension method of IPCB_LeaderDimensionHelper (using PCB;).

Square_Track3​

Returns the third of the four tracks that draw the square around the text when Shape is TShape.eRectangular.

IPCB_Track Square_Track3();

Returns: IPCB_Track

Extension method of IPCB_LeaderDimensionHelper (using PCB;).

Square_Track4​

Returns the fourth of the four tracks that draw the square around the text when Shape is TShape.eRectangular.

IPCB_Track Square_Track4();

Returns: IPCB_Track

Extension method of IPCB_LeaderDimensionHelper (using PCB;).

Text​

Returns the text of the leader dimension.

IPCB_Text Text();

Returns: IPCB_Text

Extension method of IPCB_LeaderDimensionHelper (using PCB;).

The text shows the dimension's TextFormat string. Unless TextPosition is TDimensionTextPosition.eTextManual, it is placed next to the leader's last reference point, or centered in the enclosure when Shape is not TShape.eNoShape.

Inherited members​