@mlightcad/data-model 1.1.1 → 1.1.3

package/lib/object/layout/AcDbLayout.js

@@ -16,11 +16,30 @@ var __extends = (this && this.__extends) || (function () {
 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();
+ * ```
  */
 var AcDbLayout = /** @class */ (function (_super) {
     __extends(AcDbLayout, _super);
+    /**
+     * Creates a new AcDbLayout instance.
+     *
+     * @example
+     * ```typescript
+     * const layout = new AcDbLayout();
+     * ```
+     */
     function AcDbLayout() {
         var _this = _super.call(this) || this;
         _this._tabOrder = -1;
@@ -33,12 +52,32 @@ var AcDbLayout = /** @class */ (function (_super) {
     }
     Object.defineProperty(AcDbLayout.prototype, "layoutName", {
         /**
-         * 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: function () {
             return this._layoutName;
         },
+        /**
+         * 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: function (value) {
             this._layoutName = value.length > 256 ? value.slice(0, 256) : value;
         },
@@ -47,13 +86,30 @@ var AcDbLayout = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayout.prototype, "tabOrder", {
         /**
-         * 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: function () {
             return this._tabOrder;
         },
+        /**
+         * 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: function (value) {
             this._tabOrder = value;
         },
@@ -62,12 +118,32 @@ var AcDbLayout = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayout.prototype, "tabSelected", {
         /**
-         * 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: function () {
             return this._tabSelected;
         },
+        /**
+         * 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: function (value) {
             this._tabSelected = value;
         },
@@ -76,11 +152,28 @@ var AcDbLayout = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayout.prototype, "blockTableRecordId", {
         /**
-         * 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: function () {
             return this._blockTableRecordId;
         },
+        /**
+         * 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: function (value) {
             this._blockTableRecordId = value;
         },
@@ -89,11 +182,31 @@ var AcDbLayout = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayout.prototype, "limits", {
         /**
-         * 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: function () {
             return this._limits;
         },
+        /**
+         * Sets the limits for this layout.
+         *
+         * @param value - The new layout limits as a 2D bounding box
+         *
+         * @example
+         * ```typescript
+         * layout.limits = new AcGeBox2d();
+         * ```
+         */
         set: function (value) {
             this._limits.copy(value);
         },
@@ -102,12 +215,32 @@ var AcDbLayout = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayout.prototype, "extents", {
         /**
-         * 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: function () {
             return this._extents;
         },
+        /**
+         * 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: function (value) {
             this._extents.copy(value);
         },

package/lib/object/layout/AcDbLayout.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbLayout.js","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;IAAgC,8BAAU;IAQxC;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAA;QACnB,KAAI,CAAC,YAAY,GAAG,KAAK,CAAA;QACzB,KAAI,CAAC,mBAAmB,GAAG,EAAE,CAAA;QAC7B,KAAI,CAAC,WAAW,GAAG,EAAE,CAAA;QACrB,KAAI,CAAC,OAAO,GAAG,IAAI,SAAS,EAAE,CAAA;QAC9B,KAAI,CAAC,QAAQ,GAAG,IAAI,SAAS,EAAE,CAAA;;IACjC,CAAC;IAMD,sBAAI,kCAAU;QAJd;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,WAAW,CAAA;QACzB,CAAC;aACD,UAAe,KAAa;YAC1B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;QACrE,CAAC;;;OAHA;IAUD,sBAAI,gCAAQ;QALZ;;;;WAIG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;aACD,UAAa,KAAa;YACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACxB,CAAC;;;OAHA;IASD,sBAAI,mCAAW;QAJf;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAgB,KAAc;YAC5B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;QAC3B,CAAC;;;OAHA;IAQD,sBAAI,0CAAkB;QAHtB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,mBAAmB,CAAA;QACjC,CAAC;aACD,UAAuB,KAAa;YAClC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAA;QAClC,CAAC;;;OAHA;IAQD,sBAAI,8BAAM;QAHV;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAA;QACrB,CAAC;aACD,UAAW,KAAgB;YACzB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC1B,CAAC;;;OAHA;IASD,sBAAI,+BAAO;QAJX;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAA;QACtB,CAAC;aACD,UAAY,KAAgB;YAC1B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;;;OAHA;IAIH,iBAAC;AAAD,CAAC,AAlFD,CAAgC,UAAU,GAkFzC"}
+{"version":3,"file":"AcDbLayout.js","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;IAAgC,8BAAU;IAcxC;;;;;;;OAOG;IACH;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAA;QACnB,KAAI,CAAC,YAAY,GAAG,KAAK,CAAA;QACzB,KAAI,CAAC,mBAAmB,GAAG,EAAE,CAAA;QAC7B,KAAI,CAAC,WAAW,GAAG,EAAE,CAAA;QACrB,KAAI,CAAC,OAAO,GAAG,IAAI,SAAS,EAAE,CAAA;QAC9B,KAAI,CAAC,QAAQ,GAAG,IAAI,SAAS,EAAE,CAAA;;IACjC,CAAC;IAgBD,sBAAI,kCAAU;QAdd;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,WAAW,CAAA;QACzB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAe,KAAa;YAC1B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;QACrE,CAAC;;;OAdA;IA4BD,sBAAI,gCAAQ;QAZZ;;;;;;;;;;;WAWG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAa,KAAa;YACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACxB,CAAC;;;OAdA;IA8BD,sBAAI,mCAAW;QAdf;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;QAED;;;;;;;;;WASG;aACH,UAAgB,KAAc;YAC5B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;QAC3B,CAAC;;;OAdA;IA0BD,sBAAI,0CAAkB;QAVtB;;;;;;;;;WASG;aACH;YACE,OAAO,IAAI,CAAC,mBAAmB,CAAA;QACjC,CAAC;QAED;;;;;;;;;WASG;aACH,UAAuB,KAAa;YAClC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAA;QAClC,CAAC;;;OAdA;IA6BD,sBAAI,8BAAM;QAbV;;;;;;;;;;;;WAYG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAA;QACrB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAW,KAAgB;YACzB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC1B,CAAC;;;OAdA;IA8BD,sBAAI,+BAAO;QAdX;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAA;QACtB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAY,KAAgB;YAC1B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;;;OAdA;IAeH,iBAAC;AAAD,CAAC,AAxND,CAAgC,UAAU,GAwNzC"}

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

@@ -1,18 +1,46 @@
 import { AcDbObjectId } from '../../base';
 import { AcDbDictionary } from '../AcDbDictionary';
 import { AcDbLayout } from './AcDbLayout';
+/**
+ * Dictionary for storing and managing AcDbLayout objects.
+ *
+ * This class extends AcDbDictionary to provide specialized functionality
+ * for managing layout objects, including searching by block table record ID
+ * and tracking the maximum tab order.
+ *
+ * @example
+ * ```typescript
+ * const layoutDict = new AcDbLayoutDictionary(database);
+ * const layout = layoutDict.getBtrIdAt('some-block-id');
+ * const maxOrder = layoutDict.maxTabOrder;
+ * ```
+ */
 export declare class AcDbLayoutDictionary extends AcDbDictionary<AcDbLayout> {
     /**
-     * Search the dictionary for the record with the specified block table record id. If found
-     * one layout associated with the block table record with the specified id, it returns the record.
-     * Otherwise, return undefined.
-     * @param id Input the id to search
-     * @returns If found one layout associated with the block table record with the specified id,
-     * it returns the record. Otherwise, return undefined.
+     * Searches the dictionary for a layout associated with the specified block table record ID.
+     *
+     * @param id - The block table record ID to search for
+     * @returns The layout associated with the block table record ID, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const layout = layoutDict.getBtrIdAt('some-block-id');
+     * if (layout) {
+     *   console.log('Found layout:', layout.layoutName);
+     * }
+     * ```
      */
     getBtrIdAt(id: AcDbObjectId): AcDbLayout | undefined;
     /**
-     * The maximum tabOrder value of layouts in layout dictionary.
+     * Gets the maximum tab order value of layouts in the layout dictionary.
+     *
+     * @returns The maximum tab order value, or -1 if no layouts exist
+     *
+     * @example
+     * ```typescript
+     * const maxOrder = layoutDict.maxTabOrder;
+     * console.log('Maximum tab order:', maxOrder);
+     * ```
      */
     get maxTabOrder(): number;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"AcDbLayoutDictionary.d.ts","sourceRoot":"","sources":["../../../src/object/layout/AcDbLayoutDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,qBAAa,oBAAqB,SAAQ,cAAc,CAAC,UAAU,CAAC;IAClE;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,EAAE,YAAY;IAO3B;;OAEG;IACH,IAAI,WAAW,WAQd;CACF"}
+{"version":3,"file":"AcDbLayoutDictionary.d.ts","sourceRoot":"","sources":["../../../src/object/layout/AcDbLayoutDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC;;;;;;;;;;;;;GAaG;AACH,qBAAa,oBAAqB,SAAQ,cAAc,CAAC,UAAU,CAAC;IAClE;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,EAAE,YAAY;IAO3B;;;;;;;;;;OAUG;IACH,IAAI,WAAW,WAQd;CACF"}

package/lib/object/layout/AcDbLayoutDictionary.js

@@ -41,18 +41,38 @@ var __read = (this && this.__read) || function (o, n) {
     return ar;
 };
 import { AcDbDictionary } from '../AcDbDictionary';
+/**
+ * Dictionary for storing and managing AcDbLayout objects.
+ *
+ * This class extends AcDbDictionary to provide specialized functionality
+ * for managing layout objects, including searching by block table record ID
+ * and tracking the maximum tab order.
+ *
+ * @example
+ * ```typescript
+ * const layoutDict = new AcDbLayoutDictionary(database);
+ * const layout = layoutDict.getBtrIdAt('some-block-id');
+ * const maxOrder = layoutDict.maxTabOrder;
+ * ```
+ */
 var AcDbLayoutDictionary = /** @class */ (function (_super) {
     __extends(AcDbLayoutDictionary, _super);
     function AcDbLayoutDictionary() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * Search the dictionary for the record with the specified block table record id. If found
-     * one layout associated with the block table record with the specified id, it returns the record.
-     * Otherwise, return undefined.
-     * @param id Input the id to search
-     * @returns If found one layout associated with the block table record with the specified id,
-     * it returns the record. Otherwise, return undefined.
+     * Searches the dictionary for a layout associated with the specified block table record ID.
+     *
+     * @param id - The block table record ID to search for
+     * @returns The layout associated with the block table record ID, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const layout = layoutDict.getBtrIdAt('some-block-id');
+     * if (layout) {
+     *   console.log('Found layout:', layout.layoutName);
+     * }
+     * ```
      */
     AcDbLayoutDictionary.prototype.getBtrIdAt = function (id) {
         var e_1, _a;
@@ -74,7 +94,15 @@ var AcDbLayoutDictionary = /** @class */ (function (_super) {
     };
     Object.defineProperty(AcDbLayoutDictionary.prototype, "maxTabOrder", {
         /**
-         * The maximum tabOrder value of layouts in layout dictionary.
+         * Gets the maximum tab order value of layouts in the layout dictionary.
+         *
+         * @returns The maximum tab order value, or -1 if no layouts exist
+         *
+         * @example
+         * ```typescript
+         * const maxOrder = layoutDict.maxTabOrder;
+         * console.log('Maximum tab order:', maxOrder);
+         * ```
          */
         get: function () {
             var maxValue = -1;

package/lib/object/layout/AcDbLayoutDictionary.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbLayoutDictionary.js","sourceRoot":"","sources":["../../../src/object/layout/AcDbLayoutDictionary.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAGlD;IAA0C,wCAA0B;IAApE;;IA4BA,CAAC;IA3BC;;;;;;;OAOG;IACH,yCAAU,GAAV,UAAW,EAAgB;;;YACzB,KAA0B,IAAA,KAAA,SAAA,IAAI,CAAC,cAAc,CAAA,gBAAA,4BAAE,CAAC;gBAArC,IAAA,KAAA,mBAAW,EAAV,CAAC,QAAA,EAAE,MAAM,QAAA;gBACnB,IAAI,MAAM,CAAC,kBAAkB,IAAI,EAAE;oBAAE,OAAO,MAAM,CAAA;YACpD,CAAC;;;;;;;;;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAKD,sBAAI,6CAAW;QAHf;;WAEG;aACH;YACE,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAA;YACjB,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,UAAA,MAAM;gBAChC,IAAI,MAAM,CAAC,QAAQ,GAAG,QAAQ,EAAE,CAAC;oBAC/B,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;gBAC5B,CAAC;YACH,CAAC,CAAC,CAAA;YACF,OAAO,QAAQ,CAAA;QACjB,CAAC;;;OAAA;IACH,2BAAC;AAAD,CAAC,AA5BD,CAA0C,cAAc,GA4BvD"}
+{"version":3,"file":"AcDbLayoutDictionary.js","sourceRoot":"","sources":["../../../src/object/layout/AcDbLayoutDictionary.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAGlD;;;;;;;;;;;;;GAaG;AACH;IAA0C,wCAA0B;IAApE;;IA0CA,CAAC;IAzCC;;;;;;;;;;;;;OAaG;IACH,yCAAU,GAAV,UAAW,EAAgB;;;YACzB,KAA0B,IAAA,KAAA,SAAA,IAAI,CAAC,cAAc,CAAA,gBAAA,4BAAE,CAAC;gBAArC,IAAA,KAAA,mBAAW,EAAV,CAAC,QAAA,EAAE,MAAM,QAAA;gBACnB,IAAI,MAAM,CAAC,kBAAkB,IAAI,EAAE;oBAAE,OAAO,MAAM,CAAA;YACpD,CAAC;;;;;;;;;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAaD,sBAAI,6CAAW;QAXf;;;;;;;;;;WAUG;aACH;YACE,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAA;YACjB,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,UAAA,MAAM;gBAChC,IAAI,MAAM,CAAC,QAAQ,GAAG,QAAQ,EAAE,CAAC;oBAC/B,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;gBAC5B,CAAC;YACH,CAAC,CAAC,CAAA;YACF,OAAO,QAAQ,CAAA;QACjB,CAAC;;;OAAA;IACH,2BAAC;AAAD,CAAC,AA1CD,CAA0C,cAAc,GA0CvD"}

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

@@ -2,64 +2,136 @@ import { AcCmEventManager } from '@mlightcad/common';
 import { AcDbObjectId } from '../../base';
 import { AcDbBlockTableRecord, AcDbDatabase } from '../../database';
 import { AcDbLayout } from './AcDbLayout';
+/**
+ * Event arguments for layout-related events.
+ */
 export interface AcDbLayoutEventArgs {
+    /** The previous layout */
     oldLayout: AcDbLayout;
+    /** The new layout */
     newLayout: AcDbLayout;
 }
+/**
+ * Manages layout objects in a drawing database.
+ *
+ * This class provides functionality for managing layouts, including creating,
+ * finding, renaming, and switching between layouts. It also provides event
+ * notifications when layouts are switched.
+ *
+ * @example
+ * ```typescript
+ * const layoutManager = new AcDbLayoutManager();
+ * const layoutCount = layoutManager.countLayouts();
+ * const activeLayout = layoutManager.findActiveLayout();
+ * ```
+ */
 export declare class AcDbLayoutManager {
+    /**
+     * Events that can be triggered by the layout manager.
+     *
+     * These events allow applications to respond to layout changes.
+     */
     readonly events: {
+        /** Fired when the layout is switched */
         layoutSwitched: AcCmEventManager<AcDbLayoutEventArgs>;
     };
     /**
-     * Return the number of items in the layout dictionary which should represent the number of
-     * AcDbLayout objects in the drawing. This includes the Model tab, which is always present.
-     * @param db Input drawing database to use. Default is the current database.
-     * @returns Return the number of items in the layout dictionary.
+     * Gets the number of layouts in the layout dictionary.
+     *
+     * This includes the Model tab, which is always present.
+     *
+     * @param db - Drawing database to use (defaults to the current database)
+     * @returns The number of layouts in the dictionary
+     *
+     * @example
+     * ```typescript
+     * const count = layoutManager.countLayouts();
+     * console.log(`Number of layouts: ${count}`);
+     * ```
      */
     countLayouts(db?: AcDbDatabase): number;
     /**
-     * Find the layout "name" in the database 'db' (or the workingDatabase if 'db' isn't provided)
-     * and return the layout object or undefined if no layout with that name is found.
-     * @param name Input name of layout to find.
-     * @param db Input drawing database to use. Default is the current database.
-     * @returns Return the layout object or undefined if no layout with that name is found.
+     * Finds a layout by name in the database.
+     *
+     * @param name - Name of the layout to find
+     * @param db - Drawing database to use (defaults to the current database)
+     * @returns The layout object, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const layout = layoutManager.findLayoutNamed('A4 Landscape');
+     * if (layout) {
+     *   console.log('Found layout:', layout.layoutName);
+     * }
+     * ```
      */
     findLayoutNamed(name: string, db?: AcDbDatabase): AcDbLayout | undefined;
     /**
-     * Return the name of the active layout in the database 'db' (or the workingDatabase if
-     * 'db' isn't provided).
+     * Gets the name of the active layout in the database.
+     *
+     * @returns The name of the active layout, or 'Model' if no layout is active
+     *
+     * @example
+     * ```typescript
+     * const activeLayoutName = layoutManager.findActiveLayout();
+     * console.log('Active layout:', activeLayoutName);
+     * ```
      */
     findActiveLayout(): string;
     /**
-     * Make the layout object associated with the given object id the current layout
-     * in the active database.
-     * @param id Input object id for the layout object to make current
-     * @param db Input drawing database to use. Default is the current database.
-     * @returns Return true if setting current layout correctly. Otherwise, return false.
+     * Makes the layout object associated with the given object ID the current layout.
+     *
+     * @param id - Object ID for the layout object to make current
+     * @param db - Drawing database to use (defaults to the current database)
+     * @returns True if setting the current layout was successful, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const success = layoutManager.setCurrentLayoutId('some-layout-id');
+     * if (success) {
+     *   console.log('Layout switched successfully');
+     * }
+     * ```
      */
     setCurrentLayoutId(id: AcDbObjectId, db?: AcDbDatabase): boolean;
     /**
-     * Make the layout object associated with the given block table record id the current layout
-     * in the active database.
-     * @param id Input object for the layout object to make current
-     * @param db Input drawing database to use. Default is the current database.
-     * @returns Return true if setting current layout correctly. Otherwise, return false.
+     * Makes the layout object associated with the given block table record ID the current layout.
+     *
+     * @param id - Block table record ID for the layout object to make current
+     * @param db - Drawing database to use (defaults to the current database)
+     * @returns True if setting the current layout was successful, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const success = layoutManager.setCurrentLayoutBtrId('some-block-id');
+     * ```
      */
     setCurrentLayoutBtrId(id: AcDbObjectId, db?: AcDbDatabase): boolean;
     /**
-     * Set the layout named 'name' as the current layout in the database 'db' (or the
-     * workingDatabase if 'db' isn't provided).
-     * @param name Input the layout named 'name' as the current layout in the database.
-     * @param db Input drawing database to use. Default is the current database.
-     * @returns Return true if setting current layout correctly. Otherwise, return false.
+     * Sets the layout named 'name' as the current layout in the database.
+     *
+     * @param name - Name of the layout to make current
+     * @param db - Drawing database to use (defaults to the current database)
+     * @returns True if setting the current layout was successful, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const success = layoutManager.setCurrentLayout('A4 Landscape');
+     * ```
      */
     setCurrentLayout(name: string, db?: AcDbDatabase): boolean;
     /**
-     * Rename the layout named "oldName" to the new name "newName" in the database 'db'
-     * (or the workingDatabase if 'db' isn't provided).
-     * @param oldName Input name of layout to rename.
-     * @param newName Input new name for layout.
-     * @param db Input drawing database to use. Default is the current database.
+     * Renames a layout in the database.
+     *
+     * @param oldName - Current name of the layout to rename
+     * @param newName - New name for the layout
+     * @param db - Drawing database to use (defaults to the current database)
+     * @returns True if the layout was renamed successfully, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const success = layoutManager.renameLayout('Old Name', 'New Name');
+     * ```
      */
     renameLayout(oldName: string, newName: string, db?: AcDbDatabase): boolean;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"AcDbLayoutManager.d.ts","sourceRoot":"","sources":["../../../src/object/layout/AcDbLayoutManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAEpD,OAAO,EAA+B,YAAY,EAAE,MAAM,YAAY,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,UAAU,CAAA;IACrB,SAAS,EAAE,UAAU,CAAA;CACtB;AAED,qBAAa,iBAAiB;IAC5B,SAAgB,MAAM;;MAErB;IACD;;;;;OAKG;IACH,YAAY,CAAC,EAAE,CAAC,EAAE,YAAY;IAI9B;;;;;;OAMG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,YAAY;IAI/C;;;OAGG;IACH,gBAAgB;IAKhB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,YAAY;IAMtD;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,YAAY;IAMzD;;;;;;OAMG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,YAAY;IAMhD;;;;;;OAMG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,YAAY;IAUhE;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,YAAY;IAI5C;;;;;;OAMG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,YAAY;IAI5C;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,YAAY;;;;IAgB5C;;;;OAIG;IACH,eAAe,CAAC,EAAE,CAAC,EAAE,YAAY;IAKjC,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,wBAAwB;CAcjC"}
+{"version":3,"file":"AcDbLayoutManager.d.ts","sourceRoot":"","sources":["../../../src/object/layout/AcDbLayoutManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAEpD,OAAO,EAA+B,YAAY,EAAE,MAAM,YAAY,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,0BAA0B;IAC1B,SAAS,EAAE,UAAU,CAAA;IACrB,qBAAqB;IACrB,SAAS,EAAE,UAAU,CAAA;CACtB;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,iBAAiB;IAC5B;;;;OAIG;IACH,SAAgB,MAAM;QACpB,wCAAwC;;MAEzC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,CAAC,EAAE,YAAY;IAI9B;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,YAAY;IAI/C;;;;;;;;;;OAUG;IACH,gBAAgB;IAKhB;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAAC,EAAE,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,YAAY;IAMtD;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,EAAE,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,YAAY;IAMzD;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,YAAY;IAMhD;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,YAAY;IAUhE;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,YAAY;IAI5C;;;;;;OAMG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,YAAY;IAI5C;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,YAAY;;;;IAgB5C;;;;OAIG;IACH,eAAe,CAAC,EAAE,CAAC,EAAE,YAAY;IAKjC,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,wBAAwB;CAcjC"}