Class AcDbMLeaderStyle

Represents the nongraphical MLEADERSTYLE object.

This class mirrors the core ObjectARX AcDbMLeaderStyle get/set API by exposing equivalent TypeScript properties.

Hierarchy (View Summary)

Constructors

constructor

Accessors

alignSpace annotative arrowheadId arrowheadSize arrowSize arrowSymbolId attrs bitFlags blockColor blockConnectionType blockContentColor blockContentConnectionType blockContentId blockContentRotation blockContentRotationEnabled blockContentScale blockContentScaleEnabled blockId blockRotation blockScale bottomTextAttachmentDirection bottomTextAttachmentType breakGapSize breakSize contentType database defaultMText defaultMTextContents description doglegEnabled doglegLength drawLeaderOrderType drawMLeaderOrderType enableBlockRotation enableBlockScale enableDogleg enableFrameText enableLanding extendLeaderToText extensionDictionary firstSegmentAngleConstraint isTemp landingEnabled landingGap leaderLineColor leaderLineType leaderLineTypeId leaderLineWeight maxLeaderSegmentPoints maxLeaderSegmentsPoints objectId overwritePropChanged overwritePropertyValue ownerId scale scaleFactor secondSegmentAngleConstraint textAlignAlwaysLeft textAlignmentType textAngleType textAttachmentDirection textColor textFrameEnabled textHeight textLeftAttachmentType textRightAttachmentType textString textStyle textStyleId topTextAttachmentDirection topTextAttachmentType unknown1 unknown2

Methods

clone close createExtensionDictionary dxfOut dxfOutFields getAttr getAttrWithoutException getXData removeXData setAttr setXData

Constructors

constructor

Accessors

alignSpace

annotative

arrowheadId

arrowheadSize

arrowSize

arrowSymbolId

attrs

bitFlags

blockColor

blockConnectionType

blockContentColor

blockContentConnectionType

blockContentId

blockContentRotation

blockContentRotationEnabled

blockContentScale

blockContentScaleEnabled

blockId

blockRotation

blockScale

bottomTextAttachmentDirection

bottomTextAttachmentType

breakGapSize

breakSize

contentType

database

  • get database(): AcDbDatabase

  • Gets the database in which this object is resident.

    When an object isn't added to a database, this property returns the current working database. After it is added to a database, it will be set automatically. You should never set this value manually.

    Returns AcDbDatabase

    The database this object belongs to

    Example

    const db = obj.database;
  • set database(db: AcDbDatabase): void

  • Sets the database for this object.

    This is typically set automatically when the object is added to a database. Manual setting should be avoided unless you know what you're doing.

    Parameters

    Returns void

    Example

    obj.database = myDatabase;

defaultMText

defaultMTextContents

description

doglegEnabled

doglegLength

drawLeaderOrderType

drawMLeaderOrderType

enableBlockRotation

enableBlockScale

enableDogleg

enableFrameText

enableLanding

extendLeaderToText

extensionDictionary

  • get extensionDictionary(): undefined | string

  • Gets the objectId of the extension dictionary owned by this object.

    If the object does not have an extension dictionary, this returns undefined.

    In ObjectARX terms, this is equivalent to AcDbObject::extensionDictionary().

    Returns undefined | string

    The extension dictionary objectId, or undefined

    Example

    const dictId = obj.extensionDictionary
    if (dictId) {
      console.log('Has extension dictionary:', dictId)
    }
  • set extensionDictionary(value: undefined | string): void

  • Sets the objectId of the extension dictionary owned by this object.

    This does not create or delete the dictionary object itself — it only establishes or clears the ownership relationship.

    Passing undefined removes the association.

    Parameters

    • value: undefined | string

      The extension dictionary objectId, or undefined

    Returns void

    Example

    obj.extensionDictionary = dict.objectId

firstSegmentAngleConstraint

isTemp

  • get isTemp(): any

  • Returns true if this object is temporary and not yet committed to the database.

    A temporary object is identified by its objectId starting with the TEMP prefix.

    Returns any

landingEnabled

landingGap

leaderLineColor

leaderLineType

leaderLineTypeId

leaderLineWeight

maxLeaderSegmentPoints

maxLeaderSegmentsPoints

objectId

  • get objectId(): string

  • Gets the object ID.

    AutoCAD uses 64-bit integers to represent handles, which exceed the maximum integer value of JavaScript. Therefore, strings are used to represent object handles.

    Returns string

    The object ID as a string

    Example

    const id = obj.objectId;
    console.log(`Object ID: ${id}`);
  • set objectId(value: string): void

  • Sets the object ID.

    Parameters

    • value: string

      The new object ID

    Returns void

    Example

    obj.objectId = 'new-object-id';

overwritePropChanged

overwritePropertyValue

ownerId

  • get ownerId(): string

  • Gets the object ID of the owner of this object.

    Returns string

    The owner object ID

    Example

    const ownerId = obj.ownerId;
  • set ownerId(value: string): void

  • Sets the object ID of the owner of this object.

    Parameters

    • value: string

      The new owner object ID

    Returns void

    Example

    obj.ownerId = 'parent-object-id';

scale

scaleFactor

secondSegmentAngleConstraint

textAlignAlwaysLeft

textAlignmentType

textAngleType

textAttachmentDirection

textColor

textFrameEnabled

textHeight

textLeftAttachmentType

textRightAttachmentType

textString

textStyle

textStyleId

topTextAttachmentDirection

topTextAttachmentType

unknown1

unknown2

Methods

clone

  • clone(): this

  • Creates a deep clone of this object.

    The cloned object is a detached in-memory object:

    • It has a new temporary objectId
    • It is not attached to any database instance

    Returns this

close

  • close(): void

  • Closes the object.

    All changes made to the object since it was opened are committed to the database, and a "closed" notification is sent. This method can be overridden by subclasses to provide specific cleanup behavior.

    Returns void

    Example

    obj.close();

createExtensionDictionary

  • createExtensionDictionary(): undefined | string

  • Creates the extension dictionary for this object if it does not already exist.

    This method closely mirrors the behavior of AcDbObject::createExtensionDictionary() in ObjectARX.

    • If the object already owns an extension dictionary, no new dictionary is created and the existing dictionary's objectId is returned.
    • Otherwise, a new AcDbDictionary is created, added to the same database, owned by this object, and its objectId is stored on this object.

    Returns undefined | string

    The objectId of the extension dictionary

    Example

    const dictId = obj.createExtensionDictionary()

dxfOut

dxfOutFields

getAttr

  • getAttr(attrName: string): any

  • Gets the value of the specified attribute.

    This method will throw an exception if the specified attribute doesn't exist. Use getAttrWithoutException() if you want to handle missing attributes gracefully.

    Parameters

    • attrName: string

      The name of the attribute to retrieve

    Returns any

    The value of the specified attribute

    Throws

    When the specified attribute doesn't exist

    Example

    try {
      const value = obj.getAttr('objectId');
    } catch (error) {
      console.error('Attribute not found');
    }

getAttrWithoutException

  • getAttrWithoutException(attrName: string): any

  • Gets the value of the specified attribute without throwing an exception.

    This method returns undefined if the specified attribute doesn't exist, making it safer for optional attributes.

    Parameters

    • attrName: string

      The name of the attribute to retrieve

    Returns any

    The value of the specified attribute, or undefined if it doesn't exist

    Example

    const value = obj.getAttrWithoutException('optionalAttribute');
    if (value !== undefined) {
      // Use the value
    }

getXData

  • getXData(appId: string): undefined | AcDbResultBuffer

  • Retrieves the XData associated with this object for a given application ID.

    Extended Entity Data (XData) allows applications to attach arbitrary, application-specific data to an AcDbObject. Each XData entry is identified by a registered application name (AppId) and stored as an AcDbResultBuffer.

    This method is conceptually equivalent to AcDbObject::xData() in ObjectARX, but simplified to return the entire result buffer for the specified AppId.

    Parameters

    • appId: string

      The application ID (registered AppId name) that owns the XData

    Returns undefined | AcDbResultBuffer

    The AcDbResultBuffer associated with the AppId, or undefined if no XData exists for that AppId

    Example

    const xdata = obj.getXData('MY_APP')
    if (xdata) {
      // Read values from the result buffer
    }

removeXData

  • removeXData(appId: string): void

  • Removes the XData associated with the specified application ID.

    After removal, calls to getXData() for the same AppId will return undefined. If no XData exists for the given AppId, this method has no effect.

    This mirrors the behavior of clearing XData for a specific application in ObjectARX rather than removing all XData from the object.

    Parameters

    • appId: string

      The application ID whose XData should be removed

    Returns void

    Example

    obj.removeXData('MY_APP')

setAttr

setXData

  • setXData(resbuf: AcDbResultBuffer): void

  • Attaches or replaces XData for this object.

    If XData already exists for the given AppId, it is replaced by the provided AcDbResultBuffer. The caller is responsible for ensuring that:

    • The AppId is registered in the database's AppId table
    • The result buffer follows valid DXF/XData conventions (e.g. starts with a 1001 group code for the AppId)

    This method is conceptually similar to AcDbObject::setXData() in ObjectARX.

    Parameters

    Returns void

    Example

    const rb = new AcDbResultBuffer([
      { code: AcDbDxfCode.ExtendedDataRegAppName, value: 'MY_APP' },
      { code: AcDbDxfCode.ExtendedDataAsciiString, value: 'custom value' }
    ])

    obj.setXData('MY_APP', rb)

Settings

Member Visibility

On This Page

Constructors
Accessors
alignSpaceannotativearrowheadIdarrowheadSizearrowSizearrowSymbolIdattrsbitFlagsblockColorblockConnectionTypeblockContentColorblockContentConnectionTypeblockContentIdblockContentRotationblockContentRotationEnabledblockContentScaleblockContentScaleEnabledblockIdblockRotationblockScalebottomTextAttachmentDirectionbottomTextAttachmentTypebreakGapSizebreakSizecontentTypedatabasedefaultMTextdefaultMTextContentsdescriptiondoglegEnableddoglegLengthdrawLeaderOrderTypedrawMLeaderOrderTypeenableBlockRotationenableBlockScaleenableDoglegenableFrameTextenableLandingextendLeaderToTextextensionDictionaryfirstSegmentAngleConstraintisTemplandingEnabledlandingGapleaderLineColorleaderLineTypeleaderLineTypeIdleaderLineWeightmaxLeaderSegmentPointsmaxLeaderSegmentsPointsobjectIdoverwritePropChangedoverwritePropertyValueownerIdscalescaleFactorsecondSegmentAngleConstrainttextAlignAlwaysLefttextAlignmentTypetextAngleTypetextAttachmentDirectiontextColortextFrameEnabledtextHeighttextLeftAttachmentTypetextRightAttachmentTypetextStringtextStyletextStyleIdtopTextAttachmentDirectiontopTextAttachmentTypeunknown1unknown2
Methods