Class AcDbLine

Represents a line entity in AutoCAD.

A line is a 3D geometric object defined by its start point and end point. Lines are fundamental drawing entities that can be used to create straight line segments in 2D or 3D space.

Example

// Create a line from point (0,0,0) to point (10,10,0)
const line = new AcDbLine(
  new AcGePoint3d(0, 0, 0),
  new AcGePoint3d(10, 10, 0)
);

// Access line properties
console.log(`Start point: ${line.startPoint}`);
console.log(`End point: ${line.endPoint}`);
console.log(`Mid point: ${line.midPoint}`);

Hierarchy (View Summary)

Constructors

constructor

Accessors

attrs closed color database endPoint geometricExtents layer lineStyle lineType linetypeScale lineWeight midPoint objectId ownerId rgbColor startPoint transparency type visibility

Methods

close draw getAttr getAttrWithoutException getLayerColor setAttr subGetGripPoints subGetOsnapPoints transformBy triggerModifiedEvent

Constructors

constructor

Accessors

attrs

closed

  • get closed(): boolean

  • Gets whether this line is closed.

    Lines are always open entities, so this always returns false.

    Returns boolean

    Always false for lines

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;

endPoint

geometricExtents

  • get geometricExtents(): AcGeBox3d

  • Gets the geometric extents (bounding box) of this line.

    Returns AcGeBox3d

    The bounding box that encompasses the entire line

    Example

    const extents = line.geometricExtents;
    console.log(`Line bounds: ${extents.minPoint} to ${extents.maxPoint}`);

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;

midPoint

  • get midPoint(): AcGePoint3d

  • Gets the middle point of this line.

    The middle point is calculated as the midpoint between the start and end points.

    Returns AcGePoint3d

    The middle point as a 3D point

    Example

    const midPoint = line.midPoint;
    console.log(`Line midpoint: ${midPoint.x}, ${midPoint.y}, ${midPoint.z}`);

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

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)}`);

startPoint

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

Methods

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

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

  • getLayerColor(): null | AcCmColor

  • Gets the color of the layer this entity belongs to.

    This method retrieves the color from the layer table for the layer this entity belongs to.

    Returns null | AcCmColor

    The layer color, or undefined if the layer doesn't exist

    Example

    const layerColor = entity.getLayerColor();

setAttr

subGetGripPoints

  • subGetGripPoints(): AcGePoint3d[]

  • Gets the grip points for this line.

    Grip points are control points that can be used to modify the line. For a line, the grip points are the midpoint, start point, and end point.

    Returns AcGePoint3d[]

    Array of grip points (midpoint, start point, end point)

    Example

    const gripPoints = line.subGetGripPoints();
    // gripPoints contains: [midPoint, startPoint, endPoint]

subGetOsnapPoints

  • subGetOsnapPoints(
        osnapMode: AcDbOsnapMode,
        _gsSelectionMark: number,
        pickPoint: AcGePoint3d,
        _lastPoint: AcGePoint3d,
        snapPoints: AcGePoint3d[],
    ): void

  • Gets the object snap points for this line.

    Object snap points are precise points that can be used for positioning when drawing or editing. This method provides snap points based on the specified snap mode.

    Parameters

    • osnapMode: AcDbOsnapMode

      The object snap mode (Endpoint, Midpoint, Nearest, Perpendicular, Tangent)

    • _gsSelectionMark: number

      The selection mark (unused)

    • pickPoint: AcGePoint3d

      The point where the user picked

    • _lastPoint: AcGePoint3d

      The last point (unused)

    • snapPoints: AcGePoint3d[]

      Array to populate with snap points

    Returns void

    Example

    const snapPoints: AcGePoint3d[] = [];
    line.subGetOsnapPoints(AcDbOsnapMode.EndPoint, 0, pickPoint, lastPoint, snapPoints);
    // snapPoints now contains the start and end points

transformBy

  • transformBy(matrix: AcGeMatrix3d): AcDbLine

  • Transforms this line by the specified matrix.

    This method applies a geometric transformation to the line, updating both the start and end points according to the transformation matrix.

    Parameters

    Returns AcDbLine

    This line after transformation

    Example

    const translationMatrix = AcGeMatrix3d.translation(10, 0, 0);
    line.transformBy(translationMatrix);
    // Line is now translated 10 units in the X direction

triggerModifiedEvent

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods