Interface DwgMTextEntity

interface DwgMTextEntity {
    attachmentPoint: DwgAttachmentPoint;
    backgroundFill: number;
    backgroundFillColor: number;
    backgroundFillTransparency: number;
    color?: number;
    colorIndex?: number;
    colorName?: string;
    columnAutoHeight: number;
    columnFlowReversed: number;
    columnGutter: number;
    columnHeightCount: number;
    columnHeights: number[];
    columnType: number;
    columnWidth: number;
    direction: DwgPoint3D;
    drawingDirection: DwgMTextDrawingDirection;
    extentsHeight: number;
    extentsWidth: number;
    extrusionDirection?: DwgPoint3D;
    fillBoxScale: number;
    handle: number;
    insertionPoint: DwgPoint3D;
    isInPaperSpace?: boolean;
    isVisible?: boolean;
    layer: string;
    lineSpacing: number;
    lineSpacingStyle: number;
    lineType?: string;
    lineTypeScale?: number;
    lineweight?: number;
    materialObjectHardId?: string;
    ownerBlockRecordSoftId: number;
    ownerDictionaryHardId?: string | number | boolean;
    ownerDictionarySoftId?: string | number | boolean;
    plotStyleHardId?: string;
    proxyByte?: number;
    proxyEntity?: string;
    rectHeight?: number;
    rectWidth: number;
    rotation: number;
    shadowMode?: number;
    styleName: string;
    text: string;
    textHeight: number;
    transparency?: number;
    transparencyType: number;
    type: "MTEXT";
    xdata?: DwgXData;
}

Hierarchy (View Summary)

Properties

attachmentPoint backgroundFill backgroundFillColor backgroundFillTransparency color? colorIndex? colorName? columnAutoHeight columnFlowReversed columnGutter columnHeightCount columnHeights columnType columnWidth direction drawingDirection extentsHeight extentsWidth extrusionDirection? fillBoxScale handle insertionPoint isInPaperSpace? isVisible? layer lineSpacing lineSpacingStyle lineType? lineTypeScale? lineweight? materialObjectHardId? ownerBlockRecordSoftId ownerDictionaryHardId? ownerDictionarySoftId? plotStyleHardId? proxyByte? proxyEntity? rectHeight? rectWidth rotation shadowMode? styleName text textHeight transparency? transparencyType type xdata?

Properties

attachmentPoint

attachmentPoint: DwgAttachmentPoint

Attachment point:

  • 1: Top left
  • 2: Top center
  • 3: Top right
  • 4: Middle left
  • 5: Middle center
  • 6: Middle right
  • 7: Bottom left
  • 8: Bottom center
  • 9: Bottom right

backgroundFill

backgroundFill: number

Background color (if RGB color)

backgroundFillColor

backgroundFillColor: number

Background fill color (optional): Color to use for background fill when 'backgroundFill' is 1.

backgroundFillTransparency

backgroundFillTransparency: number

Transparency of background fill color (not implemented)

Optionalcolor

color?: number

A 24-bit color value that should be dealt with in terms of bytes with values of 0 to 255. The lowest byte is the blue value, the middle byte is the green value, and the third byte is the red value. The top byte is always 0.

OptionalcolorIndex

colorIndex?: number

Color number (present if not BYLAYER); zero indicates the BYBLOCK (floating) color; 256 indicates BYLAYER; a negative value indicates that the layer is turned off (optional)

OptionalcolorName

colorName?: string

Color name.

columnAutoHeight

columnAutoHeight: number

columnFlowReversed

columnFlowReversed: number

columnGutter

columnGutter: number

columnHeightCount

columnHeightCount: number

columnHeights

columnHeights: number[]

columnType

columnType: number

columnWidth

columnWidth: number

direction

direction: DwgPoint3D

X-axis direction vector (in WCS)

drawingDirection

drawingDirection: DwgMTextDrawingDirection

Drawing direction:

  • 1: Left to right
  • 3: Top to bottom
  • 5: By style (the flow direction is inherited from the associated text style)

extentsHeight

extentsHeight: number

Vertical height of the mtext entity (read-only, ignored if supplied)

extentsWidth

extentsWidth: number

Horizontal width of the characters that make up the mtext entity. This value will always be equal to or less than the value of 'rectWidth' (read-only, ignored if supplied)

OptionalextrusionDirection

extrusionDirection?: DwgPoint3D

Extrusion direction (optional; default = 0, 0, 1)

fillBoxScale

fillBoxScale: number

Fill box scale (optional): Determines how much border there is around the text.

handle

handle: number

Handle

insertionPoint

insertionPoint: DwgPoint3D

Insertion point

OptionalisInPaperSpace

isInPaperSpace?: boolean

Absent or zero indicates entity is in model space. 1 indicates entity is in paper space (optional).

OptionalisVisible

isVisible?: boolean

Object visibility (optional):

  • 0: Visible
  • 1: Invisible

layer

layer: string

Layer name

lineSpacing

lineSpacing: number

Mtext line spacing factor (optional): Percentage of default (3-on-5) line spacing to be applied. Valid values range from 0.25 to 4.00

lineSpacingStyle

lineSpacingStyle: number

Mtext line spacing style (optional):

  • 1: At least (taller characters will override)
  • 2: Exact (taller characters will not override)

OptionallineType

lineType?: string

Linetype name (present if not BYLAYER). The special name BYBLOCK indicates a floating linetype (optional)

OptionallineTypeScale

lineTypeScale?: number

Linetype scale (optional)

Optionallineweight

lineweight?: number

Lineweight enum value. Stored and moved around as a 16-bit integer.

OptionalmaterialObjectHardId

materialObjectHardId?: string

Hard-pointer ID/handle to material object (present if not BYLAYER)

ownerBlockRecordSoftId

ownerBlockRecordSoftId: number

Soft-pointer ID/handle to owner BLOCK_RECORD object

OptionalownerDictionaryHardId

ownerDictionaryHardId?: string | number | boolean

Hard-owner ID/handle to owner dictionary (optional)

OptionalownerDictionarySoftId

ownerDictionarySoftId?: string | number | boolean

Soft-pointer ID/handle to owner dictionary (optional)

OptionalplotStyleHardId

plotStyleHardId?: string

Hard-pointer ID/handle to the plot style object

OptionalproxyByte

proxyByte?: number

Number of bytes in the proxy entity graphics represented in the subsequent 310 groups, which are binary chunk records (optional)

OptionalproxyEntity

proxyEntity?: string

Proxy entity graphics data (multiple lines; 256 characters max. per line) (optional)

OptionalrectHeight

rectHeight?: number

Reference rectangle height. No DXF group code

rectWidth

rectWidth: number

Reference rectangle width

rotation

rotation: number

Rotation angle in radians

OptionalshadowMode

shadowMode?: number

Shadow mode

  • 0: Casts and receives shadows
  • 1: Casts shadows
  • 2: Receives shadows
  • 3: Ignores shadows

Note: Starting with AutoCAD 2016-based products, this property is obsolete but still supported for backwards compatibility.

styleName

styleName: string

Text style name (STANDARD if not provided) (optional)

text

text: string

Text string

textHeight

textHeight: number

Nominal (initial) text height

Optionaltransparency

transparency?: number

Transparency value.

transparencyType

transparencyType: number

Transparency type.

  • 0 BYLAYER
  • 1 BYBLOCK
  • 3 alpha

type

type: "MTEXT"

Entity type

Optionalxdata

xdata?: DwgXData

The extension dictionary attached to the entity (optional).

Settings

Member Visibility

On This Page

Properties