Class AcDbRasterImageDef

The AcDbRasterImageDef object (or "image definition object") works with the AcDbRasterImage entity (or "image entity") to implement raster images inside AutoCAD.

The relationship between these two classes is much like the relationship between an AutoCAD block definition object and a block insert entity. The image definition object plays a behind-the-scenes role like the block definition, maintaining links to the source image file and managing low-level image processing operations required to display and plot images. Image definition objects are stored in a special AcDbDictionary named ISM_RASTER_IMAGE_DICT.

Example

const imageDef = new AcDbRasterImageDef();
imageDef.sourceFileName = '/path/to/image.jpg';

Hierarchy (View Summary)

Constructors

constructor

Accessors

attrs database objectId ownerId sourceFileName

Methods

close getAttr getAttrWithoutException setAttr

Constructors

constructor

Accessors

attrs

database

  • get database(): AcDbDatabase

  • Gets the database in which this object is resident.

    When an object isn't added to a database, this property returns the current working database. After it is added to a database, it will be set automatically. You should never set this value manually.

    Returns AcDbDatabase

    The database this object belongs to

    Example

    const db = obj.database;
  • set database(db: AcDbDatabase): void

  • Sets the database for this object.

    This is typically set automatically when the object is added to a database. Manual setting should be avoided unless you know what you're doing.

    Parameters

    Returns void

    Example

    obj.database = myDatabase;

objectId

  • get objectId(): string

  • Gets the object ID.

    AutoCAD uses 64-bit integers to represent handles, which exceed the maximum integer value of JavaScript. Therefore, strings are used to represent object handles.

    Returns string

    The object ID as a string

    Example

    const id = obj.objectId;
    console.log(`Object ID: ${id}`);
  • set objectId(value: string): void

  • Sets the object ID.

    Parameters

    • value: string

      The new object ID

    Returns void

    Example

    obj.objectId = 'new-object-id';

ownerId

  • get ownerId(): string

  • Gets the object ID of the owner of this object.

    Returns string

    The owner object ID

    Example

    const ownerId = obj.ownerId;
  • set ownerId(value: string): void

  • Sets the object ID of the owner of this object.

    Parameters

    • value: string

      The new owner object ID

    Returns void

    Example

    obj.ownerId = 'parent-object-id';

sourceFileName

  • get sourceFileName(): string

  • Gets the path name of the externally referenced image file.

    Returns string

    The source file name/path

    Example

    const fileName = imageDef.sourceFileName;
    console.log('Image file:', fileName);
  • set sourceFileName(value: string): void

  • Sets the path name of the externally referenced image file.

    Parameters

    • value: string

      The new source file name/path

    Returns void

    Example

    imageDef.sourceFileName = '/path/to/image.jpg';

Methods

close

  • close(): void

  • Closes the object.

    All changes made to the object since it was opened are committed to the database, and a "closed" notification is sent. This method can be overridden by subclasses to provide specific cleanup behavior.

    Returns void

    Example

    obj.close();

getAttr

  • getAttr(attrName: string): any

  • Gets the value of the specified attribute.

    This method will throw an exception if the specified attribute doesn't exist. Use getAttrWithoutException() if you want to handle missing attributes gracefully.

    Parameters

    • attrName: string

      The name of the attribute to retrieve

    Returns any

    The value of the specified attribute

    Throws

    When the specified attribute doesn't exist

    Example

    try {
      const value = obj.getAttr('objectId');
    } catch (error) {
      console.error('Attribute not found');
    }

getAttrWithoutException

  • getAttrWithoutException(attrName: string): any

  • Gets the value of the specified attribute without throwing an exception.

    This method returns undefined if the specified attribute doesn't exist, making it safer for optional attributes.

    Parameters

    • attrName: string

      The name of the attribute to retrieve

    Returns any

    The value of the specified attribute, or undefined if it doesn't exist

    Example

    const value = obj.getAttrWithoutException('optionalAttribute');
    if (value !== undefined) {
      // Use the value
    }

setAttr

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods