Interface DwgProxyEntity

See

https://help.autodesk.com/view/OARX/2024/ENU/?guid=GUID-89A690F9-E859-4D57-89EA-750F3FB76C6B

interface DwgProxyEntity {
    applicationEntityClassId: number;
    color?: number;
    colorIndex?: number;
    colorName?: string;
    entityData?: string;
    entityDataSize?: number;
    graphicsData?: string;
    graphicsDataSize?: number;
    handle: string;
    isInPaperSpace?: boolean;
    isVisible?: boolean;
    layer: string;
    lineType?: string;
    lineTypeScale?: number;
    lineweight?: number;
    linkedObjectIds?: string[];
    materialObjectHardId?: string;
    objectDrawingFormat?: number;
    originalDataFormat?: DwgProxyOriginalDataFormat;
    originalDxfName?: string;
    ownerBlockRecordSoftId: string;
    ownerDictionaryHardId?: string | number | boolean;
    ownerDictionarySoftId?: string | number | boolean;
    plotStyleHardId?: string;
    proxyByte?: number;
    proxyEntity?: string;
    proxyEntityClassId: number;
    shadowMode?: number;
    subclassMarker: "AcDbProxyEntity";
    transparency?: number;
    transparencyType: number;
    type: "ACAD_PROXY_ENTITY";
    unknownData?: string;
    unknownDataSize?: number;
    xdata?: DwgXData;
}

Hierarchy (View Summary)

Properties

applicationEntityClassId color? colorIndex? colorName? entityData? entityDataSize? graphicsData? graphicsDataSize? handle isInPaperSpace? isVisible? layer lineType? lineTypeScale? lineweight? linkedObjectIds? materialObjectHardId? objectDrawingFormat? originalDataFormat? originalDxfName? ownerBlockRecordSoftId ownerDictionaryHardId? ownerDictionarySoftId? plotStyleHardId? proxyByte? proxyEntity? proxyEntityClassId shadowMode? subclassMarker transparency? transparencyType type unknownData? unknownDataSize? xdata?

Properties

applicationEntityClassId

applicationEntityClassId: number

Application entity class ID from CLASSES section order (500+)

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.

OptionalentityData

entityData?: string

Binary entity data as hex string

OptionalentityDataSize

entityDataSize?: number

Size of entity data in bits

OptionalgraphicsData

graphicsData?: string

Binary graphics data as hex string

OptionalgraphicsDataSize

graphicsDataSize?: number

Size of graphics data in bytes

handle

handle: string

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.

OptionallinkedObjectIds

linkedObjectIds?: string[]

Linked object IDs from the proxy entity

OptionalmaterialObjectHardId

materialObjectHardId?: string

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

OptionalobjectDrawingFormat

objectDrawingFormat?: number

Object drawing format when it becomes a proxy

OptionaloriginalDataFormat

originalDataFormat?: DwgProxyOriginalDataFormat

Original custom object data format

OptionaloriginalDxfName

originalDxfName?: string

Original DXF entity name (group 1)

ownerBlockRecordSoftId

ownerBlockRecordSoftId: string

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)

proxyEntityClassId

proxyEntityClassId: number

Proxy entity class ID (always 498)

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.

subclassMarker

subclassMarker: "AcDbProxyEntity"

Optionaltransparency

transparency?: number

Transparency value.

transparencyType

transparencyType: number

Transparency type.

  • 0 BYLAYER
  • 1 BYBLOCK
  • 3 alpha

type

type: "ACAD_PROXY_ENTITY"

Entity type

OptionalunknownData

unknownData?: string

Unknown binary data as hex string (group 311)

OptionalunknownDataSize

unknownDataSize?: number

Size of unknown binary data in bytes (R2010+: group 162)

Optionalxdata

xdata?: DwgXData

The extension dictionary attached to the entity (optional).

Settings

Member Visibility

On This Page

Properties