Class AcDbDynBlockReference

ObjectARX-style helper for working with dynamic block references.

This is not a database-resident object. Construct it from an AcDbBlockReference (or its object id) and query the anonymous / dynamic definition relationship used for correct display.

Example

const dyn = new AcDbDynBlockReference(blockRef)
if (dyn.isDynamicBlock()) {
  const anonId = dyn.anonymousBlockTableRecord()
  const defId = dyn.dynamicBlockTableRecord()
}

Index

Constructors

constructor

Methods

anonymousBlockTableRecord blockId dynamicBlockTableRecord isDynamicBlock drawableBlockTableRecord isDynamicBlock

Constructors

constructor

new AcDbDynBlockReference(
blockRefOrId: string | AcDbBlockReference,
): AcDbDynBlockReference
Parameters
- blockRefOrId: string | AcDbBlockReference
Returns AcDbDynBlockReference
- Defined in packages/data-model/src/object/AcDbDynBlockReference.ts:36

Methods

anonymousBlockTableRecord

anonymousBlockTableRecord(db?: AcDbDatabase): undefined | string
Object id of the anonymous block table record used to draw this reference, or undefined when the reference does not use an anonymous representation.

Matches ObjectARX AcDbDynBlockReference::anonymousBlockTableRecord().
Parameters
- Optionaldb: AcDbDatabase
Returns undefined | string
- Defined in packages/data-model/src/object/AcDbDynBlockReference.ts:109

blockId

blockId(): string
Object id of the wrapped block reference.

Returns string
- Defined in packages/data-model/src/object/AcDbDynBlockReference.ts:78

dynamicBlockTableRecord

dynamicBlockTableRecord(db?: AcDbDatabase): undefined | string
Object id of the original dynamic block definition, or undefined when this is not a dynamic block reference.

Matches ObjectARX AcDbDynBlockReference::dynamicBlockTableRecord().
Parameters
- Optionaldb: AcDbDatabase
Returns undefined | string
- Defined in packages/data-model/src/object/AcDbDynBlockReference.ts:134

isDynamicBlock

isDynamicBlock(db?: AcDbDatabase): boolean
Returns true when this reference is (or points at) a dynamic block.
Parameters
- Optionaldb: AcDbDatabase
Returns boolean
- Defined in packages/data-model/src/object/AcDbDynBlockReference.ts:85

`Static`drawableBlockTableRecord

drawableBlockTableRecord(
blockRef: AcDbBlockReference,
): undefined | AcDbBlockTableRecord
Returns the block table record that should be used to draw blockRef.

Prefer the anonymous representation when this is a dynamic block instance; otherwise return AcDbBlockReference.blockTableRecord.
Parameters
- blockRef: AcDbBlockReference
Returns undefined | AcDbBlockTableRecord
- Defined in packages/data-model/src/object/AcDbDynBlockReference.ts:59

`Static`isDynamicBlock

isDynamicBlock(blockRefId: string, db?: AcDbDatabase): boolean
Returns true when the given block-reference object id is a dynamic block.
Parameters
- blockRefId: string
- Optionaldb: AcDbDatabase
Returns boolean
- Defined in packages/data-model/src/object/AcDbDynBlockReference.ts:49

Class AcDbDynBlockReference

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AcDbDynBlockReference

Methods

anonymousBlockTableRecord

Parameters

Returns undefined | string

blockId

Returns string

dynamicBlockTableRecord

Parameters

Returns undefined | string

isDynamicBlock

Parameters

Returns boolean

`Static`drawableBlockTableRecord

Parameters

Returns undefined | AcDbBlockTableRecord

`Static`isDynamicBlock

Parameters

Returns boolean

Settings

On This Page

Class AcDbDynBlockReference

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AcDbDynBlockReference

Methods

anonymousBlockTableRecord

Parameters

Returns undefined | string

blockId

Returns string

dynamicBlockTableRecord

Parameters

Returns undefined | string

isDynamicBlock

Parameters

Returns boolean

StaticdrawableBlockTableRecord

Parameters

Returns undefined | AcDbBlockTableRecord

StaticisDynamicBlock

Parameters

Returns boolean

Settings

On This Page

`Static`drawableBlockTableRecord

`Static`isDynamicBlock