Class AcDbText

Represents a text entity in AutoCAD.

A text entity is a 2D geometric object that displays text strings in drawings. Text entities can have various properties including position, height, rotation, alignment, and style. Text is always drawn in the plane defined by its normal vector.

Example

// Create a text entity
const text = new AcDbText();
text.textString = "Hello, World!";
text.position = new AcGePoint3d(0, 0, 0);
text.height = 2.5;
text.horizontalMode = AcDbTextHorizontalMode.CENTER;
text.verticalMode = AcDbTextVerticalMode.BASELINE;

// Access text properties
console.log(`Text: ${text.textString}`);
console.log(`Position: ${text.position}`);
console.log(`Height: ${text.height}`);

Hierarchy (View Summary)

Constructors

constructor

Accessors

attrs color database geometricExtents height horizontalMode layer lineStyle lineType linetypeScale lineWeight objectId oblique ownerId position rgbColor rotation styleName textString thickness transparency type verticalMode visibility widthFactor

Methods

close draw getAttr getAttrWithoutException getLayerColor setAttr subGetGripPoints subGetOsnapPoints transformBy triggerModifiedEvent

Constructors

constructor

  • new AcDbText(): AcDbText

  • Creates a new text entity.

    This constructor initializes a text entity with default values. The text string is empty, height is 0, and position is at the origin.

    Returns AcDbText

    Example

    const text = new AcDbText();
    text.textString = "Sample Text";
    text.position = new AcGePoint3d(10, 20, 0);
    text.height = 3.0;

Accessors

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;

geometricExtents

  • get geometricExtents(): AcGeBox3d

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

    Returns AcGeBox3d

    The bounding box that encompasses the text

    Example

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

height

  • get height(): number

  • Gets the height of the text.

    The height value is used as a scale factor for both height and width of the text.

    Returns number

    The height value

    Example

    const height = text.height;
    console.log(`Text height: ${height}`);
  • set height(value: number): void

  • Sets the height of the text.

    Parameters

    • value: number

      The new height value

    Returns void

    Example

    text.height = 5.0;

horizontalMode

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;

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

  • get oblique(): number

  • Gets the oblique angle of the text.

    The oblique angle is the angle from the text's vertical; that is, the top of the text "slants" relative to the bottom, similar to italic text. Positive angles slant characters forward at their tops.

    Returns number

    The oblique angle in radians

    Example

    const oblique = text.oblique;
    console.log(`Text oblique angle: ${oblique} radians`);
  • set oblique(value: number): void

  • Sets the oblique angle of the text.

    Parameters

    • value: number

      The new oblique angle in radians

    Returns void

    Example

    text.oblique = Math.PI / 6; // 30 degrees

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

position

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

  • get rotation(): number

  • Gets the rotation angle of the text.

    The rotation angle is relative to the X axis of the text's OCS, with positive angles going counterclockwise when looking down the Z axis toward the origin.

    Returns number

    The rotation angle in radians

    Example

    const rotation = text.rotation;
    console.log(`Text rotation: ${rotation} radians (${rotation * 180 / Math.PI} degrees)`);
  • set rotation(value: number): void

  • Sets the rotation angle of the text.

    Parameters

    • value: number

      The new rotation angle in radians

    Returns void

    Example

    text.rotation = Math.PI / 4; // 45 degrees

styleName

  • get styleName(): string

  • Gets the style name used by this text entity.

    Returns string

    The text style name

    Example

    const styleName = text.styleName;
    console.log(`Text style: ${styleName}`);
  • set styleName(value: string): void

  • Sets the style name for this text entity.

    Parameters

    • value: string

      The new text style name

    Returns void

    Example

    text.styleName = "Standard";

textString

  • get textString(): string

  • Gets the text string content of this entity.

    Returns string

    The text string

    Example

    const content = text.textString;
    console.log(`Text content: ${content}`);
  • set textString(value: string): void

  • Sets the text string content of this entity.

    Parameters

    • value: string

      The new text string

    Returns void

    Example

    text.textString = "New text content";

thickness

  • get thickness(): number

  • Gets the thickness of the text.

    The thickness is the text's dimension along its normal vector direction (sometimes called the extrusion direction).

    Returns number

    The thickness value

    Example

    const thickness = text.thickness;
    console.log(`Text thickness: ${thickness}`);
  • set thickness(value: number): void

  • Sets the thickness of the text.

    Parameters

    • value: number

      The new thickness value

    Returns void

    Example

    text.thickness = 2.0;

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"

verticalMode

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

widthFactor

  • get widthFactor(): number

  • Gets the width factor of the text.

    The width factor is applied to the text's width to allow the width to be adjusted independently of the height. For example, if the widthFactor value is 0.8, then the text is drawn with a width that is 80% of its normal width.

    Returns number

    The width factor value

    Example

    const widthFactor = text.widthFactor;
    console.log(`Width factor: ${widthFactor}`);
  • set widthFactor(value: number): void

  • Sets the width factor of the text.

    Parameters

    • value: number

      The new width factor value

    Returns void

    Example

    text.widthFactor = 0.8; // 80% width

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 entity.

    Grip points are the control points that can be used to modify the entity. This method should be overridden by subclasses to provide entity-specific grip points.

    Returns AcGePoint3d[]

    Array of grip points as 3D points

    Example

    const gripPoints = entity.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