Interface DwgTextEntity

interface DwgTextEntity {
    color?: number;
    colorIndex?: number;
    colorName?: string;
    endPoint: DwgPoint2D;
    extrusionDirection: DwgPoint3D;
    generationFlag: DwgTextGenerationFlag;
    halign: DwgTextHorizontalAlign;
    handle: number;
    isInPaperSpace?: boolean;
    isVisible?: boolean;
    layer: string;
    lineType?: string;
    lineTypeScale?: number;
    lineweight?: number;
    materialObjectHardId?: string;
    obliqueAngle: number;
    ownerBlockRecordSoftId: number;
    ownerDictionaryHardId?: string | number | boolean;
    ownerDictionarySoftId?: string | number | boolean;
    plotStyleHardId?: string;
    proxyByte?: number;
    proxyEntity?: string;
    rotation: number;
    shadowMode?: number;
    startPoint: DwgPoint2D;
    styleName: string;
    text: string;
    textHeight: number;
    thickness: number;
    transparency?: number;
    transparencyType: number;
    type: "TEXT";
    valign: DwgTextVerticalAlign;
    xdata?: DwgXData;
    xScale: number;
}

Hierarchy (View Summary)

Properties

color? colorIndex? colorName? endPoint extrusionDirection generationFlag halign handle isInPaperSpace? isVisible? layer lineType? lineTypeScale? lineweight? materialObjectHardId? obliqueAngle ownerBlockRecordSoftId ownerDictionaryHardId? ownerDictionarySoftId? plotStyleHardId? proxyByte? proxyEntity? rotation shadowMode? startPoint styleName text textHeight thickness transparency? transparencyType type valign xdata? xScale

Properties

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.

endPoint

endPoint: DwgPoint2D

Second alignment point (in OCS) (optional) This value is meaningful only if the justification is anything other than baseline/left

extrusionDirection

extrusionDirection: DwgPoint3D

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

generationFlag

generationFlag: DwgTextGenerationFlag

Text generation flags (optional, default = 0):

  • 2: Text is backward (mirrored in X)
  • 4: Text is upside down (mirrored in Y)

halign

halign: DwgTextHorizontalAlign

Horizontal text justification type (optional, default = 0) integer codes (not bit-coded):

  • 0: Left
  • 1: Center
  • 2: Right
  • 3: Aligned (if vertical alignment = 0)
  • 4: Middle (if vertical alignment = 0)
  • 5: Fit (if vertical alignment = 0)

handle

handle: number

Handle

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

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)

obliqueAngle

obliqueAngle: number

Oblique angle (optional; default = 0)

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)

rotation

rotation: number

Text rotation (optional; default = 0)

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.

startPoint

startPoint: DwgPoint2D

First alignment point (in OCS)

styleName

styleName: string

Text style name (optional, default = STANDARD)

text

text: string

Text value

textHeight

textHeight: number

Text height

thickness

thickness: number

Thickness (optional; default = 0)

Optionaltransparency

transparency?: number

Transparency value.

transparencyType

transparencyType: number

Transparency type.

  • 0 BYLAYER
  • 1 BYBLOCK
  • 3 alpha

type

type: "TEXT"

Entity type

valign

valign: DwgTextVerticalAlign

Vertical text justification type (optional, default = 0): integer codes (not bit-coded):

  • 0: Baseline
  • 1: Bottom
  • 2: Middle
  • 3: Top

Optionalxdata

xdata?: DwgXData

The extension dictionary attached to the entity (optional).

xScale

xScale: number

Relative X scale factor—width (optional; default = 1) This value is also adjusted when fit-type text is used

Settings

Member Visibility

On This Page

Properties