The attachment point value which determines how the text will be oriented around the insertion point of the mtext object. For example, if the attachment point is AcGiAttachmentPoint.MiddleCenter, then the text body will be displayed such that the insertion point appears at the geometric center of the text body.
Gets the attributes object for this AcDbObject.
The AcCmObject instance containing all attributes
Toggle the background fill on or off. If it is true, background color is turned off, and no background fill color has been specified, this function sets the background fill color to an RGB value of 200,200,200.
The background fill color. This property is valid only if background fill is enable.
The background fill transparency. This property is valid only if background fill is enable.
The background scale factor.
Gets the contents of the mtext object.
This returns a string that contains the contents of the mtext object. Formatting data used for word wrap calculations is removed.
The text contents
Sets the contents of the mtext object.
The new text contents
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.
The database this object belongs to
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.
The database to associate with this object
Represent the X axis ("horizontal") for the text. This direction vector is used to determine the text flow direction.
Gets the height of the text.
The text height
Sets the height of the text.
The new text height
Gets the name of the layer referenced by this entity.
The layer name
Sets the name of the layer for this entity.
The new layer name
The line spacing factor (a value between 0.25 and 4.00).
The line spacing style.
Protected
lineGets the line style for this entity.
This method returns the line style based on the entity's linetype and other properties.
The line style object
Gets the name of the line type referenced by this entity.
The linetype name
Sets the name of the line type for this entity.
The new linetype name
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.
The linetype scale factor
Sets the line type scale factor for this entity.
The new linetype scale factor
Gets the line weight used by this entity.
The line weight value
Sets the line weight for this entity.
The new line weight value
The insertion point of this mtext entity.
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.
The object ID as a string
Sets the object ID.
The new object ID
Gets the object ID of the owner of this object.
The owner object ID
Sets the object ID of the owner of this object.
The new owner object ID
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.
The RGB color value as a 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.
The rotation angle in radians
The style name stored in text ttyle table record and used by this text entity
Gets the transparency level of this entity.
The transparency value (0-1, where 0 is opaque and 1 is fully transparent)
Sets the transparency level of this entity.
The transparency value (0-1, where 0 is opaque and 1 is fully transparent)
Gets the type name of this entity.
This method returns the entity type by removing the "AcDb" prefix from the constructor name.
The entity type name
Gets whether this entity is visible.
True if the entity is visible, false otherwise
Sets whether this entity is visible.
True to make the entity visible, false to hide it
Gets the maximum width setting used by the MText object for word wrap formatting.
It is possible that none of the lines resulting from word wrap formatting will reach this width value. Words which exceed this width value will not be broken, but will extend beyond the given width.
The maximum width for word wrap
Sets the maximum width setting used by the MText object for word wrap formatting.
The new maximum width for word wrap
Draws this entity using the specified renderer.
This method should be implemented by subclasses to provide entity-specific drawing behavior.
The renderer to use for drawing
The rendered entity, or undefined if drawing failed
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.
The name of the attribute to retrieve
The value of the specified attribute
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.
The name of the attribute to retrieve
The value of the specified attribute, or undefined if it doesn't exist
Protected
getSets the value of an attribute.
The name of the attribute to set
Optional
val: AcDbObjectAttrs[A]The value to assign to the attribute
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.
Array of grip points as 3D points
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.
The object snap mode
The selection mark
The pick point
The last point
Array to populate with snap points
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.
The transformation matrix to apply
This entity after transformation
Represents a multiline text (mtext) entity in AutoCAD.
A multiline text entity is a 2D geometric object that displays formatted text with support for multiple lines, word wrapping, and rich text formatting. MText entities are more advanced than regular text entities and support features like background fills, line spacing, and attachment points.
Example