Interface DwgLeaderEntity

interface DwgLeaderEntity {
    associatedAnnotation?: string;
    byBlockColor?: number;
    color?: number;
    colorIndex?: number;
    colorName?: string;
    handle: number;
    horizontalDirection?: DwgPoint3D;
    isArrowheadEnabled: boolean;
    isHooklineExists: boolean;
    isHooklineSameDirection: boolean;
    isInPaperSpace?: boolean;
    isSpline: boolean;
    isVisible?: boolean;
    layer: string;
    leaderCreationFlag: DwgLeaderCreationFlag;
    lineType?: string;
    lineTypeScale?: number;
    lineweight?: number;
    materialObjectHardId?: string;
    normal?: DwgPoint3D;
    numberOfVertices?: number;
    offsetFromAnnotation?: DwgPoint3D;
    offsetFromBlock?: DwgPoint3D;
    ownerBlockRecordSoftId: number;
    ownerDictionaryHardId?: string | number | boolean;
    ownerDictionarySoftId?: string | number | boolean;
    plotStyleHardId?: string;
    proxyByte?: number;
    proxyEntity?: string;
    shadowMode?: number;
    styleName: string;
    textHeight?: number;
    textWidth?: number;
    transparency?: number;
    transparencyType: number;
    type: "LEADER";
    vertices: DwgPoint3D[];
    xdata?: DwgXData;
}

Hierarchy (View Summary)

Properties

associatedAnnotation? byBlockColor? color? colorIndex? colorName? handle horizontalDirection? isArrowheadEnabled isHooklineExists isHooklineSameDirection isInPaperSpace? isSpline isVisible? layer leaderCreationFlag lineType? lineTypeScale? lineweight? materialObjectHardId? normal? numberOfVertices? offsetFromAnnotation? offsetFromBlock? ownerBlockRecordSoftId ownerDictionaryHardId? ownerDictionarySoftId? plotStyleHardId? proxyByte? proxyEntity? shadowMode? styleName textHeight? textWidth? transparency? transparencyType type vertices xdata?

Properties

OptionalassociatedAnnotation

associatedAnnotation?: string

Hard reference to associated annotation (mtext, tolerance, or insert entity)

OptionalbyBlockColor

byBlockColor?: number

Color to use if leader's DIMCLRD = BYBLOCK

Optionalcolor

color?: number

A 24-bit color value that should be dealt with in terms of bytes with values of 0 to 255. The lowest byte is the blue value, the middle byte is the green value, and the third byte is the red value. The top byte is always 0.

OptionalcolorIndex

colorIndex?: number

Color number (present if not BYLAYER); zero indicates the BYBLOCK (floating) color; 256 indicates BYLAYER; a negative value indicates that the layer is turned off (optional)

OptionalcolorName

colorName?: string

Color name.

handle

handle: number

Handle

OptionalhorizontalDirection

horizontalDirection?: DwgPoint3D

Horizontal direction for leader

isArrowheadEnabled

isArrowheadEnabled: boolean

Arrowhead flag:

  • 0: Disabled
  • 1: Enabled

isHooklineExists

isHooklineExists: boolean

Hookline flag:

  • 0: No hookline
  • 1: Has a hookline

isHooklineSameDirection

isHooklineSameDirection: boolean

Hookline direction flag:

  • 0: Hookline (or end of tangent for a splined leader) is the opposite direction from the horizontal vector
  • 1: Hookline (or end of tangent for a splined leader) is the same direction as horizontal vector (see code 75)

OptionalisInPaperSpace

isInPaperSpace?: boolean

Absent or zero indicates entity is in model space. 1 indicates entity is in paper space (optional).

isSpline

isSpline: boolean

Leader path type:

  • 0: Straight line segments
  • 1: Spline

OptionalisVisible

isVisible?: boolean

Object visibility (optional):

  • 0: Visible
  • 1: Invisible

layer

layer: string

Layer name

leaderCreationFlag

leaderCreationFlag: DwgLeaderCreationFlag

Leader creation flag (default = 3):

  • 0: Created with text annotation
  • 1: Created with tolerance annotation
  • 2: Created with block reference annotation
  • 3: Created without any annotation

OptionallineType

lineType?: string

Linetype name (present if not BYLAYER). The special name BYBLOCK indicates a floating linetype (optional)

OptionallineTypeScale

lineTypeScale?: number

Linetype scale (optional)

Optionallineweight

lineweight?: number

Lineweight enum value. Stored and moved around as a 16-bit integer.

OptionalmaterialObjectHardId

materialObjectHardId?: string

Hard-pointer ID/handle to material object (present if not BYLAYER)

Optionalnormal

normal?: DwgPoint3D

Normal vector

OptionalnumberOfVertices

numberOfVertices?: number

Number of vertices in leader (ignored for OPEN)

OptionaloffsetFromAnnotation

offsetFromAnnotation?: DwgPoint3D

Offset of last leader vertex from annotation placement point

OptionaloffsetFromBlock

offsetFromBlock?: DwgPoint3D

Offset of last leader vertex from block reference insertion point

ownerBlockRecordSoftId

ownerBlockRecordSoftId: number

Soft-pointer ID/handle to owner BLOCK_RECORD object

OptionalownerDictionaryHardId

ownerDictionaryHardId?: string | number | boolean

Hard-owner ID/handle to owner dictionary (optional)

OptionalownerDictionarySoftId

ownerDictionarySoftId?: string | number | boolean

Soft-pointer ID/handle to owner dictionary (optional)

OptionalplotStyleHardId

plotStyleHardId?: string

Hard-pointer ID/handle to the plot style object

OptionalproxyByte

proxyByte?: number

Number of bytes in the proxy entity graphics represented in the subsequent 310 groups, which are binary chunk records (optional)

OptionalproxyEntity

proxyEntity?: string

Proxy entity graphics data (multiple lines; 256 characters max. per line) (optional)

OptionalshadowMode

shadowMode?: number

Shadow mode

  • 0: Casts and receives shadows
  • 1: Casts shadows
  • 2: Receives shadows
  • 3: Ignores shadows

Note: Starting with AutoCAD 2016-based products, this property is obsolete but still supported for backwards compatibility.

styleName

styleName: string

Dimension style name

OptionaltextHeight

textHeight?: number

Text annotation height

OptionaltextWidth

textWidth?: number

Text annotation width

Optionaltransparency

transparency?: number

Transparency value.

transparencyType

transparencyType: number

Transparency type.

  • 0 BYLAYER
  • 1 BYBLOCK
  • 3 alpha

type

type: "LEADER"

Entity type

vertices

vertices: DwgPoint3D[]

Vertex coordinates (one entry for each vertex)

Optionalxdata

xdata?: DwgXData

The extension dictionary attached to the entity (optional).

Settings

Member Visibility

On This Page

Properties