Class AcDbAlignedDimension

Represents an aligned dimension entity in AutoCAD.

An aligned dimension measures the distance between two points located anywhere in space. The dimension's normal vector must be perpendicular to the line between the two points. The two selected points are also used as the definition points for the start of the two dimension extension lines.

Aligned dimensions are commonly used to measure distances that are not parallel to the X or Y axes, providing accurate measurements regardless of the orientation.

Example

// Create an aligned dimension
const alignedDim = new AcDbAlignedDimension(
  new AcGePoint3d(0, 0, 0),    // First extension line point
  new AcGePoint3d(10, 5, 0),   // Second extension line point
  new AcGePoint3d(5, 2.5, 0),  // Dimension line point
  "10.0",                      // Dimension text
  "Standard"                   // Dimension style
);

// Access dimension properties
console.log(`Dimension line point: ${alignedDim.dimLinePoint}`);
console.log(`Extension line 1 point: ${alignedDim.xLine1Point}`);
console.log(`Extension line 2 point: ${alignedDim.xLine2Point}`);

Hierarchy (View Summary)

Constructors

constructor

Accessors

arrowLineCount arrowScaleFactor attrs color database dimBlockId dimensionStyle dimensionStyleName dimensionText dimLinePoint firstArrowStyle firstArrowType firstArrowTypeBtrId geometricExtents isAppendArrow layer lineStyle lineType linetypeScale lineWeight measurement objectId oblique ownerId rgbColor rotation secondArrowStyle secondArrowType secondArrowTypeBtrId textLineSpacingFactor textLineSpacingStyle textPosition textRotation transparency type visibility xLine1Point xLine2Point

Methods

adjustExtensionLine calculateLines close draw drawFirstArrow drawSecondArrow findPointOnLine1 findPointOnLine2 getAttr getAttrWithoutException getLayerColor getLineArrowStyle setAttr subGetGripPoints subGetOsnapPoints transformBy triggerModifiedEvent

Constructors

constructor

  • new AcDbAlignedDimension(
        xLine1Point: AcGeVectorLike,
        xLine2Point: AcGeVectorLike,
        dimLinePoint: AcGeVectorLike,
        dimText?: null | string,
        dimStyle?: null | string,
    ): AcDbAlignedDimension

  • Creates a new aligned dimension entity.

    This constructor initializes an aligned dimension using the specified points. The extension line obliquing angle is set to 0.0 by default.

    Parameters

    • xLine1Point: AcGeVectorLike

      Start point (in WCS coordinates) of first extension line

    • xLine2Point: AcGeVectorLike

      Start point (in WCS coordinates) of second extension line

    • dimLinePoint: AcGeVectorLike

      Point (in WCS coordinates) on dimension line itself

    • dimText: null | string = null

      Text string to use as the dimension annotation (optional)

    • dimStyle: null | string = null

      String name of dimension style table record to use (optional)

    Returns AcDbAlignedDimension

    Example

    // Create an aligned dimension with default text and style
    const alignedDim = new AcDbAlignedDimension(
      new AcGePoint3d(0, 0, 0),
      new AcGePoint3d(10, 5, 0),
      new AcGePoint3d(5, 2.5, 0)
    );

    // Create an aligned dimension with custom text and style
    const alignedDim2 = new AcDbAlignedDimension(
      new AcGePoint3d(0, 0, 0),
      new AcGePoint3d(15, 10, 0),
      new AcGePoint3d(7.5, 5, 0),
      "15.0",
      "Architectural"
    );

Accessors

ProtectedarrowLineCount

ProtectedarrowScaleFactor

attrs

color

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;

dimBlockId

  • get dimBlockId(): null | string

  • Gets the block table record ID containing the entities that this dimension displays.

    Returns null | string

    The block table record ID, or null if not set

    Example

    const blockId = dimension.dimBlockId;
    console.log(`Dimension block ID: ${blockId}`);
  • set dimBlockId(value: null | string): void

  • Sets the block table record ID for this dimension.

    Parameters

    • value: null | string

      The block table record ID, or null to clear

    Returns void

    Example

    dimension.dimBlockId = "MyDimensionBlock";

dimensionStyle

  • get dimensionStyle(): AcDbDimStyleTableRecord

  • Gets the dimension style used by this dimension.

    This method returns the dimension style record associated with this dimension. If no style is specified, it returns the default dimension style.

    Returns AcDbDimStyleTableRecord

    The dimension style record

    Example

    const style = dimension.dimensionStyle;
    console.log(`Style name: ${style.name}`);

dimensionStyleName

  • get dimensionStyleName(): null | string

  • Gets the dimension style name used by this dimension.

    Returns null | string

    The dimension style name, or null if not set

    Example

    const styleName = dimension.dimensionStyleName;
    console.log(`Dimension style: ${styleName}`);
  • set dimensionStyleName(value: null | string): void

  • Sets the dimension style name for this dimension.

    Parameters

    • value: null | string

      The dimension style name, or null to use default

    Returns void

    Example

    dimension.dimensionStyleName = "Standard";

dimensionText

  • get dimensionText(): null | string

  • Gets the user-supplied dimension annotation text string.

    This string can contain multiline text formatting characters. The text can be:

    • Empty string ('') for default text only
    • Text with angle brackets for mixed default and user text (e.g., 'This is the default text <>')
    • Period ('.') for no text
    • User-defined text only

    Returns null | string

    The dimension text string

    Example

    const text = dimension.dimensionText;
    console.log(`Dimension text: ${text}`);
  • set dimensionText(value: null | string): void

  • Parameters

    • value: null | string

    Returns void

dimLinePoint

  • get dimLinePoint(): AcGePoint3d

  • Gets the definition point that specifies where the dimension line will be.

    This point will be somewhere on the dimension line and determines the position of the dimension text and arrows.

    Returns AcGePoint3d

    The dimension line point in WCS coordinates

    Example

    const dimLinePoint = alignedDim.dimLinePoint;
    console.log(`Dimension line point: ${dimLinePoint.x}, ${dimLinePoint.y}, ${dimLinePoint.z}`);
  • set dimLinePoint(value: AcGePoint3d): void

  • Sets the definition point that specifies where the dimension line will be.

    Parameters

    Returns void

    Example

    alignedDim.dimLinePoint = new AcGePoint3d(5, 2.5, 0);

ProtectedfirstArrowStyle

ProtectedfirstArrowType

ProtectedfirstArrowTypeBtrId

geometricExtents

  • get geometricExtents(): AcGeBox3d

  • Gets the geometric extents of this entity.

    This method should be implemented by subclasses to return the bounding box that encompasses the entire entity.

    Returns AcGeBox3d

    The geometric extents as a 3D bounding box

    Example

    const extents = entity.geometricExtents;
    console.log(`Min: ${extents.minPoint}, Max: ${extents.maxPoint}`);

ProtectedisAppendArrow

  • get isAppendArrow(): boolean

  • The flag to determinate how to attach arrow to endpoint of the line.

    • true: append arrow to endpoint of the line
    • false: overlap arrow with endpoint of the line

    Returns boolean

layer

  • get layer(): string

  • Gets the name of the layer referenced by this entity.

    Returns string

    The layer name

    Example

    const layerName = entity.layer;
  • set layer(value: string): void

  • Sets the name of the layer for this entity.

    Parameters

    • value: string

      The new layer name

    Returns void

    Example

    entity.layer = 'MyLayer';

ProtectedlineStyle

  • get lineStyle(): AcGiLineStyle

  • Gets the line style for this entity.

    This method returns the line style based on the entity's linetype and other properties.

    Returns AcGiLineStyle

    The line style object

    Example

    const lineStyle = entity.lineStyle;

lineType

  • get lineType(): string

  • Gets the name of the line type referenced by this entity.

    Returns string

    The linetype name

    Example

    const lineType = entity.lineType;
  • set lineType(value: string): void

  • Sets the name of the line type for this entity.

    Parameters

    • value: string

      The new linetype name

    Returns void

    Example

    entity.lineType = 'DASHED';

linetypeScale

  • get linetypeScale(): number

  • Gets the line type scale factor of this entity.

    When an entity is first instantiated, its line type scale is initialized to an invalid value. When the entity is added to the database, if a linetype scale has not been specified for the entity, it is set to the database's current line type scale value.

    Returns number

    The linetype scale factor

    Example

    const scale = entity.linetypeScale;
  • set linetypeScale(value: number): void

  • Sets the line type scale factor for this entity.

    Parameters

    • value: number

      The new linetype scale factor

    Returns void

    Example

    entity.linetypeScale = 2.0;

lineWeight

  • get lineWeight(): number

  • Gets the line weight used by this entity.

    Returns number

    The line weight value

    Example

    const weight = entity.lineWeight;
  • set lineWeight(value: number): void

  • Sets the line weight for this entity.

    Parameters

    • value: number

      The new line weight value

    Returns void

    Example

    entity.lineWeight = 2;

measurement

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';

oblique

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';

rgbColor

  • get rgbColor(): number

  • Gets the RGB color of this entity after converting color index.

    This method handles the conversion of color indices (including ByLayer and ByBlock) to actual RGB colors. It resolves layer colors and block colors as needed.

    Returns number

    The RGB color value as a number

    Example

    const rgbColor = entity.rgbColor;
    console.log(`RGB: ${rgbColor.toString(16)}`);

rotation

ProtectedsecondArrowStyle

ProtectedsecondArrowType

ProtectedsecondArrowTypeBtrId

textLineSpacingFactor

textLineSpacingStyle

textPosition

textRotation

  • get textRotation(): number

  • The rotation angle (in radians) of the dimension's annotation text. This is the angle from the dimension's horizontal axis to the horizontal axis used by the text. The angle is in the dimension's OCS X-Y plane with positive angles going counterclockwise when looking down the OCS Z axis towards the OCS origin. The value obtained from: (2 * pi) + the dimension's text rotation angle--the dimension's horizontal rotation angle

    Returns number

  • set textRotation(value: number): void

  • Parameters

    • value: number

    Returns void

transparency

  • get transparency(): number

  • Gets the transparency level of this entity.

    Returns number

    The transparency value (0-1, where 0 is opaque and 1 is fully transparent)

    Example

    const transparency = entity.transparency;
  • set transparency(value: number): void

  • Sets the transparency level of this entity.

    Parameters

    • value: number

      The transparency value (0-1, where 0 is opaque and 1 is fully transparent)

    Returns void

    Example

    entity.transparency = 0.5; // 50% transparent

type

  • get type(): string

  • Gets the type name of this entity.

    This method returns the entity type by removing the "AcDb" prefix from the constructor name.

    Returns string

    The entity type name

    Example

    const entity = new AcDbLine();
    console.log(entity.type); // "Line"

visibility

  • get visibility(): boolean

  • Gets whether this entity is visible.

    Returns boolean

    True if the entity is visible, false otherwise

    Example

    const isVisible = entity.visibility;
  • set visibility(value: boolean): void

  • Sets whether this entity is visible.

    Parameters

    • value: boolean

      True to make the entity visible, false to hide it

    Returns void

    Example

    entity.visibility = false; // Hide the entity

xLine1Point

xLine2Point

Methods

ProtectedadjustExtensionLine

ProtectedcalculateLines

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();

draw

ProtecteddrawFirstArrow

ProtecteddrawSecondArrow

ProtectedfindPointOnLine1

ProtectedfindPointOnLine2

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
    }

ProtectedgetLayerColor

ProtectedgetLineArrowStyle

setAttr

subGetGripPoints

subGetOsnapPoints

  • subGetOsnapPoints(
        osnapMode: AcDbOsnapMode,
        gsSelectionMark: number,
        pickPoint: AcGePoint3d,
        lastPoint: AcGePoint3d,
        snapPoints: AcGePoint3d[],
    ): void

  • Gets the object snap points for this entity.

    Object snap points are the points that can be used for precise positioning when drawing or editing. This method should be overridden by subclasses to provide entity-specific snap points.

    Parameters

    Returns void

    Example

    const snapPoints: AcGePoint3d[] = [];
    entity.subGetOsnapPoints(AcDbOsnapMode.Endpoint, 0, pickPoint, lastPoint, snapPoints);

transformBy

  • transformBy(matrix: AcGeMatrix3d): this

  • Transforms this entity by the specified matrix.

    This method applies a geometric transformation to the entity. Subclasses should override this method to provide entity-specific transformation behavior.

    Parameters

    Returns this

    This entity after transformation

    Example

    const matrix = AcGeMatrix3d.translation(10, 0, 0);
    entity.transformBy(matrix);

triggerModifiedEvent

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods