Interface DwgAttribEntity

interface DwgAttribEntity {
    alignmentPoint: DwgPoint3D;
    annotationScale: number;
    attrTag: string;
    color?: number;
    colorIndex?: number;
    colorName?: string;
    duplicateRecordCloningFlag: boolean;
    fieldLength: number;
    flags: number;
    handle: number;
    isInPaperSpace?: boolean;
    isReallyLocked: boolean;
    isVisible?: boolean;
    layer: string;
    lineType?: string;
    lineTypeScale?: number;
    lineweight?: number;
    lockPositionFlag: boolean;
    materialObjectHardId?: string;
    mtext: DwgEmbeddedMText;
    mtextFlag: number;
    numberOfSecondaryAttrs: number;
    ownerBlockRecordSoftId: number;
    ownerDictionaryHardId?: string | number | boolean;
    ownerDictionarySoftId?: string | number | boolean;
    plotStyleHardId?: string;
    proxyByte?: number;
    proxyEntity?: string;
    secondaryAttrsHardId: number;
    shadowMode?: number;
    tag: string;
    text: DwgTextBase;
    transparency?: number;
    type: "ATTRIB";
    xdata?: DwgXData;
}

Hierarchy (View Summary)

Properties

alignmentPoint annotationScale attrTag color? colorIndex? colorName? duplicateRecordCloningFlag fieldLength flags handle isInPaperSpace? isReallyLocked isVisible? layer lineType? lineTypeScale? lineweight? lockPositionFlag materialObjectHardId? mtext mtextFlag numberOfSecondaryAttrs ownerBlockRecordSoftId ownerDictionaryHardId? ownerDictionarySoftId? plotStyleHardId? proxyByte? proxyEntity? secondaryAttrsHardId shadowMode? tag text transparency? type xdata?

Properties

alignmentPoint

alignmentPoint: DwgPoint3D

Alignment point of attribute or attribute definition.

annotationScale

annotationScale: number

current annotation scale

attrTag

attrTag: string

attribute or attribute definition tag string

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. The group code cannot be used by custom entities for their own data because the group code is reserved for AcDbEntity, class-level color data and AcDbEntity, class-level transparency data

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. The group code cannot be used by custom entities for their own data because the group code is reserved for AcDbEntity, class-level color data and AcDbEntity, class-level transparency data

duplicateRecordCloningFlag

duplicateRecordCloningFlag: boolean

Duplicate record cloning flag (determines how to merge duplicate entries):

  • 1: Keep existing

fieldLength

fieldLength: number

Field length (optional; default = 0) (not currently used)

flags

flags: number

Attribute flags:

  • 1: Attribute is invisible (does not appear)
  • 2: This is a constant attribute
  • 4: Verification is required on input of this attribute
  • 8: Attribute is preset (no prompt during insertion)

handle

handle: number

Handle

OptionalisInPaperSpace

isInPaperSpace?: boolean

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

isReallyLocked

isReallyLocked: boolean

isReallyLocked flag:

  • 0: unlocked
  • 1: locked

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.

lockPositionFlag

lockPositionFlag: boolean

Lock position flag. Locks the position of the attribute within the block reference.

OptionalmaterialObjectHardId

materialObjectHardId?: string

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

mtext

mtext: DwgEmbeddedMText

MText attributes

mtextFlag

mtextFlag: number

MText flag:

  • 2: multiline attribute
  • 4: constant multiline attribute definition

numberOfSecondaryAttrs

numberOfSecondaryAttrs: number

Number of secondary attributes or attribute definitions

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)

secondaryAttrsHardId

secondaryAttrsHardId: number

hard-pointer id of secondary attribute(s) or attribute definition(s)

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.

tag

tag: string

Tag string (cannot contain spaces)

text

text: DwgTextBase

Text attributes

Optionaltransparency

transparency?: number

Transparency value. The group code cannot be used by custom entities for their own data because the group code is reserved for AcDbEntity, class-level color data and AcDbEntity, class-level transparency data

type

type: "ATTRIB"

Entity type

Optionalxdata

xdata?: DwgXData

The extension dictionary attached to the entity (optional).

Settings

Member Visibility

On This Page

Properties