Interface DwgInsertEntity

interface DwgInsertEntity {
    color?: number;
    colorIndex?: number;
    colorName?: string;
    columnCount: number;
    columnSpacing: number;
    extrusionDirection: DwgPoint3D;
    handle: number;
    insertionPoint: DwgPoint3D;
    isInPaperSpace?: boolean;
    isVariableAttributes?: boolean;
    isVisible?: boolean;
    layer: string;
    lineType?: string;
    lineTypeScale?: number;
    lineweight?: number;
    materialObjectHardId?: string;
    name: string;
    ownerBlockRecordSoftId: number;
    ownerDictionaryHardId?: string | number | boolean;
    ownerDictionarySoftId?: string | number | boolean;
    plotStyleHardId?: string;
    proxyByte?: number;
    proxyEntity?: string;
    rotation: number;
    rowCount: number;
    rowSpacing: number;
    shadowMode?: number;
    transparency?: number;
    type: "INSERT";
    xdata?: DwgXData;
    xScale: number;
    yScale: number;
    zScale: number;
}

Hierarchy (View Summary)

Properties

color? colorIndex? colorName? columnCount columnSpacing extrusionDirection handle insertionPoint isInPaperSpace? isVariableAttributes? isVisible? layer lineType? lineTypeScale? lineweight? materialObjectHardId? name ownerBlockRecordSoftId ownerDictionaryHardId? ownerDictionarySoftId? plotStyleHardId? proxyByte? proxyEntity? rotation rowCount rowSpacing shadowMode? transparency? type xdata? xScale yScale zScale

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

columnCount

columnCount: number

Column count (optional; default = 1)

columnSpacing

columnSpacing: number

Column spacing (optional; default = 0)

extrusionDirection

extrusionDirection: DwgPoint3D

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

handle

handle: number

Handle

insertionPoint

insertionPoint: DwgPoint3D

Insertion point (in OCS)

OptionalisInPaperSpace

isInPaperSpace?: boolean

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

OptionalisVariableAttributes

isVariableAttributes?: boolean

Variable attributes-follow flag (optional; default = 0); if the value of attributes-follow flag is 1, a series of attribute entities is expected to follow the insert, terminated by a seqend entity

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)

name

name: string

Block name

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

Rotation angle (optional; default = 0)

rowCount

rowCount: number

Row count (optional; default = 1)

rowSpacing

rowSpacing: number

Row spacing (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.

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: "INSERT"

Entity type

Optionalxdata

xdata?: DwgXData

The extension dictionary attached to the entity (optional).

xScale

xScale: number

X scale factor (optional; default = 1)

yScale

yScale: number

Y scale factor (optional; default = 1)

zScale

zScale: number

Z scale factor (optional; default = 1)

Settings

Member Visibility

On This Page

Properties