@mlightcad/data-model 1.1.2 → 1.1.3

package/lib/object/AcDbDictionary.js

@@ -16,19 +16,40 @@ var __extends = (this && this.__extends) || (function () {
 import { AcDbObject } from '../base';
 import { AcDbObjectIterator } from '../misc';
 /**
- * A database-resident object dictionary, which maintains a map between text strings and database objects.
+ * A database-resident object dictionary that maintains a map between text strings and database objects.
+ *
  * An instance of this class represents a single object, such as Drawing Symbol Table, to which objects
  * derived from AcDbObject may be added, accessed, and removed. Entries in an AcDbDictionary must be unique.
  * Entries consist of a unique AcDbObject and string, which comprises the entry's key name. The key may be
- * either an text string, or an asterisk ('*') as the first character in the string to signify an anonymous
+ * either a text string, or an asterisk ('*') as the first character in the string to signify an anonymous
  * entry. An anonymous entry's key will be constructed internally by appending an 'A' plus a unique integer
  * value to the asterisk; for example, '*A13'. When an object is placed in a dictionary, the dictionary is
  * established as the object's owner, the lookup key string is associated with the object's object ID, and
  * the dictionary itself is attached to the object as a persistent reactor so that the dictionary is notified
  * when the object is erased.
+ *
+ * @template TObjectType - The type of objects stored in this dictionary
+ *
+ * @example
+ * ```typescript
+ * const dictionary = new AcDbDictionary<AcDbLayout>(database);
+ * const layout = new AcDbLayout();
+ * dictionary.setAt('MyLayout', layout);
+ * const retrievedLayout = dictionary.getAt('MyLayout');
+ * ```
  */
 var AcDbDictionary = /** @class */ (function (_super) {
     __extends(AcDbDictionary, _super);
+    /**
+     * Creates a new AcDbDictionary instance.
+     *
+     * @param db - The database this dictionary belongs to
+     *
+     * @example
+     * ```typescript
+     * const dictionary = new AcDbDictionary(database);
+     * ```
+     */
     function AcDbDictionary(db) {
         var _this = _super.call(this) || this;
         _this.database = db;
@@ -38,7 +59,15 @@ var AcDbDictionary = /** @class */ (function (_super) {
     }
     Object.defineProperty(AcDbDictionary.prototype, "numEntries", {
         /**
-         * The number of entries in the dictionary.
+         * Gets the number of entries in the dictionary.
+         *
+         * @returns The number of entries in the dictionary
+         *
+         * @example
+         * ```typescript
+         * const count = dictionary.numEntries;
+         * console.log(`Dictionary has ${count} entries`);
+         * ```
          */
         get: function () {
             return this._recordsByName.size;
@@ -47,10 +76,19 @@ var AcDbDictionary = /** @class */ (function (_super) {
         configurable: true
     });
     /**
-     * Add a new entry specified by 'value' into the dictionary, if 'key' does not already exist in the
-     * dictionary. If the entry with 'key' already exists, the existing entry is erased.
-     * @param key Input string representing the object's search key name
-     * @param value Input the new object to add to the dictionary
+     * Adds a new entry to the dictionary.
+     *
+     * If an entry with the specified key already exists, the existing entry is erased
+     * and replaced with the new one.
+     *
+     * @param key - String representing the object's search key name
+     * @param value - The new object to add to the dictionary
+     *
+     * @example
+     * ```typescript
+     * const layout = new AcDbLayout();
+     * dictionary.setAt('MyLayout', layout);
+     * ```
      */
     AcDbDictionary.prototype.setAt = function (key, value) {
         value.database = this.database;
@@ -58,10 +96,18 @@ var AcDbDictionary = /** @class */ (function (_super) {
         this._recordsById.set(value.objectId, value);
     };
     /**
-     * Remove the entry specified by 'name' from the dictionary.
-     * @param name Input string representing the entry's key (or name)
-     * @returns If the entry specified by object id exists in the dictionary and remove it correctly, return
-     * true. Otherwise, return false.
+     * Removes the entry specified by name from the dictionary.
+     *
+     * @param name - String representing the entry's key (or name)
+     * @returns True if the entry was found and removed, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const removed = dictionary.remove('MyLayout');
+     * if (removed) {
+     *   console.log('Layout removed successfully');
+     * }
+     * ```
      */
     AcDbDictionary.prototype.remove = function (name) {
         var object = this.getAt(name);
@@ -73,10 +119,15 @@ var AcDbDictionary = /** @class */ (function (_super) {
         return false;
     };
     /**
-     * Remove the entry specified by object id from the dictionary.
-     * @param id Input id of the object to delete
-     * @returns If the entry specified by object id exists in the dictionary and remove it correctly, return
-     * true. Otherwise, return false.
+     * Removes the entry specified by object ID from the dictionary.
+     *
+     * @param id - ID of the object to delete
+     * @returns True if the entry was found and removed, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const removed = dictionary.removeId('some-object-id');
+     * ```
      */
     AcDbDictionary.prototype.removeId = function (id) {
         var _this = this;
@@ -92,48 +143,93 @@ var AcDbDictionary = /** @class */ (function (_super) {
         return false;
     };
     /**
-     * Remove all of records in the dictionary.
+     * Removes all records from the dictionary.
+     *
+     * @example
+     * ```typescript
+     * dictionary.removeAll();
+     * ```
      */
     AcDbDictionary.prototype.removeAll = function () {
         this._recordsByName.clear();
         this._recordsById.clear();
     };
     /**
-     * Return true if the dictionary contains an object with the sepcified name. Otherwise it returns false.
-     * @param name Input name to search for
+     * Checks if the dictionary contains an object with the specified name.
+     *
+     * @param name - Name to search for
+     * @returns True if the dictionary contains an object with the specified name, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (dictionary.has('MyLayout')) {
+     *   console.log('Layout exists');
+     * }
+     * ```
      */
     AcDbDictionary.prototype.has = function (name) {
         return this._recordsByName.has(name.toUpperCase());
     };
     /**
-     * Return true if the dictionary contains an object with the sepcified id. Otherwise it returns false.
-     * @param id Input object id to search for
+     * Checks if the dictionary contains an object with the specified ID.
+     *
+     * @param id - ID to search for
+     * @returns True if the dictionary contains an object with the specified ID, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (dictionary.hasId('some-object-id')) {
+     *   console.log('Object exists');
+     * }
+     * ```
      */
     AcDbDictionary.prototype.hasId = function (id) {
         return this._recordsById.has(id);
     };
     /**
-     * Search the dictionary for the object with the specified name. If found, it return the record.
-     * Otherwise, return undefined.
-     * @param name Input the name to search
-     * @returns If found the object with the specified name, return it. Otherwise, return undefined.
+     * Gets the object with the specified name from the dictionary.
+     *
+     * @param name - Name of the object to retrieve
+     * @returns The object with the specified name, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const layout = dictionary.getAt('MyLayout');
+     * if (layout) {
+     *   console.log('Layout found:', layout);
+     * }
+     * ```
      */
     AcDbDictionary.prototype.getAt = function (name) {
         return this._recordsByName.get(name);
     };
     /**
-     * Search the dictionary for the record with the specified id. If found, it returns the record.
-     * Otherwise, return undefined.
-     * @param id Input the id to search
-     * @returns If found the object with the specified id, return it. Otherwise, return undefined.
+     * Gets the object with the specified ID from the dictionary.
+     *
+     * @param id - ID of the object to retrieve
+     * @returns The object with the specified ID, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const object = dictionary.getIdAt('some-object-id');
+     * ```
      */
     AcDbDictionary.prototype.getIdAt = function (id) {
         return this._recordsById.get(id);
     };
     /**
-     * Create an iterator object that can be used to iterate through the contents of the symbol table.
+     * Creates a new iterator for traversing the dictionary entries.
+     *
+     * @returns A new AcDbObjectIterator for this dictionary
      *
-     * @returns Return an iterator object that can be used to iterate through the contents of the symbol table.
+     * @example
+     * ```typescript
+     * const iterator = dictionary.newIterator();
+     * while (iterator.hasNext()) {
+     *   const object = iterator.next();
+     *   console.log('Object:', object);
+     * }
+     * ```
      */
     AcDbDictionary.prototype.newIterator = function () {
         return new AcDbObjectIterator(this._recordsByName);

package/lib/object/AcDbDictionary.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbDictionary.js","sourceRoot":"","sources":["../../src/object/AcDbDictionary.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAgB,MAAM,SAAS,CAAA;AAElD,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAE5C;;;;;;;;;;;GAWG;AACH;IAEU,kCAAU;IAIlB,wBAAY,EAAgB;QAC1B,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAClB,KAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAuB,CAAA;QACpD,KAAI,CAAC,YAAY,GAAG,IAAI,GAAG,EAAuB,CAAA;;IACpD,CAAC;IAKD,sBAAI,sCAAU;QAHd;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAA;QACjC,CAAC;;;OAAA;IAED;;;;;OAKG;IACH,8BAAK,GAAL,UAAM,GAAW,EAAE,KAAkB;QACnC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACnC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;OAKG;IACH,+BAAM,GAAN,UAAO,IAAY;QACjB,IAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC/B,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;YAC9C,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACvC,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACH,iCAAQ,GAAR,UAAS,EAAU;QAAnB,iBAUC;QATC,IAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC/B,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACvC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,UAAC,KAAK,EAAE,GAAG;gBACrC,IAAI,KAAK,KAAK,MAAM;oBAAE,KAAI,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YACvD,CAAC,CAAC,CAAA;YACF,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;OAEG;IACH,kCAAS,GAAT;QACE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAA;QAC3B,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAA;IAC3B,CAAC;IAED;;;OAGG;IACH,4BAAG,GAAH,UAAI,IAAY;QACd,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;IACpD,CAAC;IAED;;;OAGG;IACH,8BAAK,GAAL,UAAM,EAAU;QACd,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAClC,CAAC;IAED;;;;;OAKG;IACH,8BAAK,GAAL,UAAM,IAAY;QAChB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACtC,CAAC;IAED;;;;;OAKG;IACH,gCAAO,GAAP,UAAQ,EAAgB;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAClC,CAAC;IAED;;;;OAIG;IACH,oCAAW,GAAX;QACE,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACpD,CAAC;IACH,qBAAC;AAAD,CAAC,AAtHD,CAEU,UAAU,GAoHnB"}
+{"version":3,"file":"AcDbDictionary.js","sourceRoot":"","sources":["../../src/object/AcDbDictionary.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAgB,MAAM,SAAS,CAAA;AAElD,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAE5C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH;IAEU,kCAAU;IAMlB;;;;;;;;;OASG;IACH,wBAAY,EAAgB;QAC1B,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAClB,KAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAuB,CAAA;QACpD,KAAI,CAAC,YAAY,GAAG,IAAI,GAAG,EAAuB,CAAA;;IACpD,CAAC;IAaD,sBAAI,sCAAU;QAXd;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAA;QACjC,CAAC;;;OAAA;IAED;;;;;;;;;;;;;;OAcG;IACH,8BAAK,GAAL,UAAM,GAAW,EAAE,KAAkB;QACnC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACnC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,+BAAM,GAAN,UAAO,IAAY;QACjB,IAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC/B,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;YAC9C,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACvC,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;;;;OAUG;IACH,iCAAQ,GAAR,UAAS,EAAU;QAAnB,iBAUC;QATC,IAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC/B,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACvC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,UAAC,KAAK,EAAE,GAAG;gBACrC,IAAI,KAAK,KAAK,MAAM;oBAAE,KAAI,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YACvD,CAAC,CAAC,CAAA;YACF,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;OAOG;IACH,kCAAS,GAAT;QACE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAA;QAC3B,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAA;IAC3B,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,4BAAG,GAAH,UAAI,IAAY;QACd,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;IACpD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,8BAAK,GAAL,UAAM,EAAU;QACd,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,8BAAK,GAAL,UAAM,IAAY;QAChB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACtC,CAAC;IAED;;;;;;;;;;OAUG;IACH,gCAAO,GAAP,UAAQ,EAAgB;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,oCAAW,GAAX;QACE,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACpD,CAAC;IACH,qBAAC;AAAD,CAAC,AA7MD,CAEU,UAAU,GA2MnB"}

package/lib/object/AcDbRasterImageDef.d.ts

@@ -1,25 +1,54 @@
 import { AcDbObject } from '../base';
 /**
  * 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.
+ * (or "image entity") to implement raster images inside AutoCAD.
  *
- * 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.
+ * 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
+ * ```typescript
+ * const imageDef = new AcDbRasterImageDef();
+ * imageDef.sourceFileName = '/path/to/image.jpg';
+ * ```
  */
 export declare class AcDbRasterImageDef extends AcDbObject {
+    /** The path name of the externally referenced image file */
     private _sourceFileName;
     /**
-     * Consturct one instance of this class.
+     * Creates a new AcDbRasterImageDef instance.
+     *
+     * @example
+     * ```typescript
+     * const imageDef = new AcDbRasterImageDef();
+     * ```
      */
     constructor();
     /**
-     * The path name of the externally referenced image file name.
+     * Gets the path name of the externally referenced image file.
+     *
+     * @returns The source file name/path
+     *
+     * @example
+     * ```typescript
+     * const fileName = imageDef.sourceFileName;
+     * console.log('Image file:', fileName);
+     * ```
      */
     get sourceFileName(): string;
+    /**
+     * Sets the path name of the externally referenced image file.
+     *
+     * @param value - The new source file name/path
+     *
+     * @example
+     * ```typescript
+     * imageDef.sourceFileName = '/path/to/image.jpg';
+     * ```
+     */
     set sourceFileName(value: string);
 }
 //# sourceMappingURL=AcDbRasterImageDef.d.ts.map

package/lib/object/AcDbRasterImageDef.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbRasterImageDef.d.ts","sourceRoot":"","sources":["../../src/object/AcDbRasterImageDef.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEpC;;;;;;;;;;GAUG;AACH,qBAAa,kBAAmB,SAAQ,UAAU;IAChD,OAAO,CAAC,eAAe,CAAQ;IAE/B;;OAEG;;IAMH;;OAEG;IACH,IAAI,cAAc,IAGQ,MAAM,CAD/B;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,EAE/B;CACF"}
+{"version":3,"file":"AcDbRasterImageDef.d.ts","sourceRoot":"","sources":["../../src/object/AcDbRasterImageDef.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEpC;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,kBAAmB,SAAQ,UAAU;IAChD,4DAA4D;IAC5D,OAAO,CAAC,eAAe,CAAQ;IAE/B;;;;;;;OAOG;;IAMH;;;;;;;;;;OAUG;IACH,IAAI,cAAc,IAcQ,MAAM,CAZ/B;IAED;;;;;;;;;OASG;IACH,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,EAE/B;CACF"}

package/lib/object/AcDbRasterImageDef.js

@@ -16,19 +16,29 @@ var __extends = (this && this.__extends) || (function () {
 import { AcDbObject } from '../base';
 /**
  * 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.
+ * (or "image entity") to implement raster images inside AutoCAD.
  *
- * 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.
+ * 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
+ * ```typescript
+ * const imageDef = new AcDbRasterImageDef();
+ * imageDef.sourceFileName = '/path/to/image.jpg';
+ * ```
  */
 var AcDbRasterImageDef = /** @class */ (function (_super) {
     __extends(AcDbRasterImageDef, _super);
     /**
-     * Consturct one instance of this class.
+     * Creates a new AcDbRasterImageDef instance.
+     *
+     * @example
+     * ```typescript
+     * const imageDef = new AcDbRasterImageDef();
+     * ```
      */
     function AcDbRasterImageDef() {
         var _this = _super.call(this) || this;
@@ -37,11 +47,29 @@ var AcDbRasterImageDef = /** @class */ (function (_super) {
     }
     Object.defineProperty(AcDbRasterImageDef.prototype, "sourceFileName", {
         /**
-         * The path name of the externally referenced image file name.
+         * Gets the path name of the externally referenced image file.
+         *
+         * @returns The source file name/path
+         *
+         * @example
+         * ```typescript
+         * const fileName = imageDef.sourceFileName;
+         * console.log('Image file:', fileName);
+         * ```
          */
         get: function () {
             return this._sourceFileName;
         },
+        /**
+         * Sets the path name of the externally referenced image file.
+         *
+         * @param value - The new source file name/path
+         *
+         * @example
+         * ```typescript
+         * imageDef.sourceFileName = '/path/to/image.jpg';
+         * ```
+         */
         set: function (value) {
             this._sourceFileName = value;
         },

package/lib/object/AcDbRasterImageDef.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbRasterImageDef.js","sourceRoot":"","sources":["../../src/object/AcDbRasterImageDef.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEpC;;;;;;;;;;GAUG;AACH;IAAwC,sCAAU;IAGhD;;OAEG;IACH;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,eAAe,GAAG,EAAE,CAAA;;IAC3B,CAAC;IAKD,sBAAI,8CAAc;QAHlB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,eAAe,CAAA;QAC7B,CAAC;aACD,UAAmB,KAAa;YAC9B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;QAC9B,CAAC;;;OAHA;IAIH,yBAAC;AAAD,CAAC,AApBD,CAAwC,UAAU,GAoBjD"}
+{"version":3,"file":"AcDbRasterImageDef.js","sourceRoot":"","sources":["../../src/object/AcDbRasterImageDef.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEpC;;;;;;;;;;;;;;;GAeG;AACH;IAAwC,sCAAU;IAIhD;;;;;;;OAOG;IACH;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,eAAe,GAAG,EAAE,CAAA;;IAC3B,CAAC;IAaD,sBAAI,8CAAc;QAXlB;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,eAAe,CAAA;QAC7B,CAAC;QAED;;;;;;;;;WASG;aACH,UAAmB,KAAa;YAC9B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;QAC9B,CAAC;;;OAdA;IAeH,yBAAC;AAAD,CAAC,AA7CD,CAAwC,UAAU,GA6CjD"}

package/lib/object/layout/AcDbLayout.d.ts

@@ -1,51 +1,190 @@
 import { AcGeBox2d, AcGeBox3d } from '@mlightcad/geometry-engine';
 import { AcDbObject } from '../../base';
 /**
- * This class represents object stored characteristics of each paperspace layout. Layout objects are
- * stored in an AcDbDictionary object with an ACAD_LAYOUT key, allowing easy iteration and indexing.
+ * Represents the stored characteristics of each paperspace layout.
+ *
+ * Layout objects are stored in an AcDbDictionary object with an ACAD_LAYOUT key,
+ * allowing easy iteration and indexing. Each layout represents a paperspace
+ * configuration that can be used for printing or plotting.
+ *
+ * @example
+ * ```typescript
+ * const layout = new AcDbLayout();
+ * layout.layoutName = 'A4 Landscape';
+ * layout.tabOrder = 1;
+ * layout.limits = new AcGeBox2d();
+ * ```
  */
 export declare class AcDbLayout extends AcDbObject {
+    /** The user-friendly layout name displayed in the tab control */
     private _layoutName;
+    /** The tab order field controlling the display order */
     private _tabOrder;
+    /** Flag indicating whether the layout tab is selected */
     private _tabSelected;
+    /** The associated block table record ID of this layout */
     private _blockTableRecordId;
+    /** Limits for this layout (defined by LIMMAX while this layout is current) */
     private _limits;
+    /** The current extents setting of the layout */
     private _extents;
+    /**
+     * Creates a new AcDbLayout instance.
+     *
+     * @example
+     * ```typescript
+     * const layout = new AcDbLayout();
+     * ```
+     */
     constructor();
     /**
-     * The user-friendly layout name that is displayed in the tab control. Currently there is no restriction
-     * on the name except that the length of the name is limited to 256 characters.
+     * Gets the user-friendly layout name that is displayed in the tab control.
+     *
+     * Currently there is no restriction on the name except that the length
+     * is limited to 256 characters.
+     *
+     * @returns The layout name
+     *
+     * @example
+     * ```typescript
+     * const name = layout.layoutName;
+     * console.log('Layout name:', name);
+     * ```
      */
     get layoutName(): string;
+    /**
+     * Sets the user-friendly layout name that is displayed in the tab control.
+     *
+     * @param value - The new layout name (limited to 256 characters)
+     *
+     * @example
+     * ```typescript
+     * layout.layoutName = 'A4 Landscape';
+     * ```
+     */
     set layoutName(value: string);
     /**
-     * The tab order field, which controls the order in which the layouts are displayed in the tab control
-     * that is docked to the bottom of the viewport. The tab order should be unique and sequential for each
-     * layout in the database.
+     * Gets the tab order field, which controls the order in which layouts are displayed.
+     *
+     * The tab order should be unique and sequential for each layout in the database.
+     *
+     * @returns The tab order value
+     *
+     * @example
+     * ```typescript
+     * const order = layout.tabOrder;
+     * ```
      */
     get tabOrder(): number;
+    /**
+     * Sets the tab order field, which controls the order in which layouts are displayed.
+     *
+     * @param value - The new tab order value
+     *
+     * @example
+     * ```typescript
+     * layout.tabOrder = 1;
+     * ```
+     */
     set tabOrder(value: number);
     /**
-     * A flag to indicate whether the layout tab is included in the selection set for operations that affect
-     * multiple tabs. The user can perform multiple selection via the user interface using shift-click.
+     * Gets whether the layout tab is included in the selection set for operations.
+     *
+     * This flag indicates whether the layout tab is included in the selection set
+     * for operations that affect multiple tabs. The user can perform multiple
+     * selection via the user interface using shift-click.
+     *
+     * @returns True if the tab is selected, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const isSelected = layout.tabSelected;
+     * ```
      */
     get tabSelected(): boolean;
+    /**
+     * Sets whether the layout tab is included in the selection set for operations.
+     *
+     * @param value - True to select the tab, false to deselect it
+     *
+     * @example
+     * ```typescript
+     * layout.tabSelected = true;
+     * ```
+     */
     set tabSelected(value: boolean);
     /**
-     * The associated block table record id of this layout.
+     * Gets the associated block table record ID of this layout.
+     *
+     * @returns The block table record ID
+     *
+     * @example
+     * ```typescript
+     * const blockId = layout.blockTableRecordId;
+     * ```
      */
     get blockTableRecordId(): string;
+    /**
+     * Sets the associated block table record ID of this layout.
+     *
+     * @param value - The new block table record ID
+     *
+     * @example
+     * ```typescript
+     * layout.blockTableRecordId = 'some-block-id';
+     * ```
+     */
     set blockTableRecordId(value: string);
     /**
-     * Limits for this layout (defined by LIMMAX while this layout is current)
+     * Gets the limits for this layout.
+     *
+     * Limits are defined by LIMMAX while this layout is current.
+     *
+     * @returns The layout limits as a 2D bounding box
+     *
+     * @example
+     * ```typescript
+     * const limits = layout.limits;
+     * console.log('Layout limits:', limits);
+     * ```
      */
     get limits(): AcGeBox2d;
+    /**
+     * Sets the limits for this layout.
+     *
+     * @param value - The new layout limits as a 2D bounding box
+     *
+     * @example
+     * ```typescript
+     * layout.limits = new AcGeBox2d();
+     * ```
+     */
     set limits(value: AcGeBox2d);
     /**
-     * The current extents setting of the layout. This value may not be the actual extents of
-     * the geometry in the layout, it is just the value last saved in the layout.
+     * Gets the current extents setting of the layout.
+     *
+     * This value may not be the actual extents of the geometry in the layout,
+     * it is just the value last saved in the layout.
+     *
+     * @returns The layout extents as a 3D bounding box
+     *
+     * @example
+     * ```typescript
+     * const extents = layout.extents;
+     * console.log('Layout extents:', extents);
+     * ```
      */
     get extents(): AcGeBox3d;
+    /**
+     * Sets the current extents setting of the layout.
+     *
+     * @param value - The new layout extents as a 3D bounding box
+     *
+     * @example
+     * ```typescript
+     * layout.extents = new AcGeBox3d();
+     * ```
+     */
     set extents(value: AcGeBox3d);
 }
 //# sourceMappingURL=AcDbLayout.d.ts.map

package/lib/object/layout/AcDbLayout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbLayout.d.ts","sourceRoot":"","sources":["../../../src/object/layout/AcDbLayout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAEvC;;;GAGG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACxC,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,mBAAmB,CAAQ;IACnC,OAAO,CAAC,OAAO,CAAW;IAC1B,OAAO,CAAC,QAAQ,CAAW;;IAY3B;;;OAGG;IACH,IAAI,UAAU,IAGQ,MAAM,CAD3B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAGQ,MAAM,CADzB;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;;OAGG;IACH,IAAI,WAAW,IAGQ,OAAO,CAD7B;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,OAAO,EAE7B;IAED;;OAEG;IACH,IAAI,kBAAkB,IAGQ,MAAM,CADnC;IACD,IAAI,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAEnC;IAED;;OAEG;IACH,IAAI,MAAM,IAGQ,SAAS,CAD1B;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,SAAS,EAE1B;IAED;;;OAGG;IACH,IAAI,OAAO,IAGQ,SAAS,CAD3B;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,SAAS,EAE3B;CACF"}
+{"version":3,"file":"AcDbLayout.d.ts","sourceRoot":"","sources":["../../../src/object/layout/AcDbLayout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAEvC;;;;;;;;;;;;;;GAcG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACxC,iEAAiE;IACjE,OAAO,CAAC,WAAW,CAAQ;IAC3B,wDAAwD;IACxD,OAAO,CAAC,SAAS,CAAQ;IACzB,yDAAyD;IACzD,OAAO,CAAC,YAAY,CAAS;IAC7B,0DAA0D;IAC1D,OAAO,CAAC,mBAAmB,CAAQ;IACnC,8EAA8E;IAC9E,OAAO,CAAC,OAAO,CAAW;IAC1B,gDAAgD;IAChD,OAAO,CAAC,QAAQ,CAAW;IAE3B;;;;;;;OAOG;;IAWH;;;;;;;;;;;;;OAaG;IACH,IAAI,UAAU,IAcQ,MAAM,CAZ3B;IAED;;;;;;;;;OASG;IACH,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;;;;;;;;;;OAWG;IACH,IAAI,QAAQ,IAcQ,MAAM,CAZzB;IAED;;;;;;;;;OASG;IACH,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,WAAW,IAcQ,OAAO,CAZ7B;IAED;;;;;;;;;OASG;IACH,IAAI,WAAW,CAAC,KAAK,EAAE,OAAO,EAE7B;IAED;;;;;;;;;OASG;IACH,IAAI,kBAAkB,IAcQ,MAAM,CAZnC;IAED;;;;;;;;;OASG;IACH,IAAI,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAEnC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,MAAM,IAcQ,SAAS,CAZ1B;IAED;;;;;;;;;OASG;IACH,IAAI,MAAM,CAAC,KAAK,EAAE,SAAS,EAE1B;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,OAAO,IAcQ,SAAS,CAZ3B;IAED;;;;;;;;;OASG;IACH,IAAI,OAAO,CAAC,KAAK,EAAE,SAAS,EAE3B;CACF"}