Interface DwgOle2FrameEntity

interface DwgOle2FrameEntity {
    binaryData: string;
    color?: number;
    colorIndex?: number;
    colorName?: string;
    dataSize: number;
    handle: number;
    isInPaperSpace?: boolean;
    isVisible?: boolean;
    layer: string;
    leftUpPoint: DwgPoint3D;
    lineType?: string;
    lineTypeScale?: number;
    lineweight?: number;
    lockAspect: number;
    materialObjectHardId?: string;
    oleClient?: string;
    oleObjectType: number;
    oleVersion: number;
    ownerBlockRecordSoftId: number;
    ownerDictionaryHardId?: string | number | boolean;
    ownerDictionarySoftId?: string | number | boolean;
    plotStyleHardId?: string;
    proxyByte?: number;
    proxyEntity?: string;
    rightDownPoint: DwgPoint3D;
    shadowMode?: number;
    tileModeDescriptor: number;
    transparency?: number;
    type: "OLE2FRAME";
    xdata?: DwgXData;
}

Hierarchy (View Summary)

Properties

binaryData color? colorIndex? colorName? dataSize handle isInPaperSpace? isVisible? layer leftUpPoint lineType? lineTypeScale? lineweight? lockAspect materialObjectHardId? oleClient? oleObjectType oleVersion ownerBlockRecordSoftId ownerDictionaryHardId? ownerDictionarySoftId? plotStyleHardId? proxyByte? proxyEntity? rightDownPoint shadowMode? tileModeDescriptor transparency? type xdata?

Properties

binaryData

binaryData: string

Binary data

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

dataSize

dataSize: number

Length of binary data

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

leftUpPoint

leftUpPoint: DwgPoint3D

Upper-left corner (WCS)

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.

lockAspect

lockAspect: number

Flag whether to lock aspect.

  • 0: not locked
  • 1: locked

OptionalmaterialObjectHardId

materialObjectHardId?: string

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

OptionaloleClient

oleClient?: string

OLE or Paintbrush Picture

oleObjectType

oleObjectType: number

OLE object type

  • 1: Link
  • 2: Embedded
  • 3: Static

oleVersion

oleVersion: number

OLE version number

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)

rightDownPoint

rightDownPoint: DwgPoint3D

Lower-right corner (WCS)

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.

tileModeDescriptor

tileModeDescriptor: number

Tile mode descriptor: 0: Object resides in model space 1: Object resides in paper space

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

Entity type

Optionalxdata

xdata?: DwgXData

The extension dictionary attached to the entity (optional).

Settings

Member Visibility

On This Page

Properties