@mlightcad/data-model 1.1.2 → 1.1.3

package/lib/object/layout/AcDbLayoutManager.js

@@ -2,45 +2,96 @@ import { AcCmEventManager } from '@mlightcad/common';
 import { acdbHostApplicationServices } from '../../base';
 import { AcDbBlockTableRecord } from '../../database';
 import { AcDbLayout } from './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();
+ * ```
+ */
 var AcDbLayoutManager = /** @class */ (function () {
     function AcDbLayoutManager() {
+        /**
+         * Events that can be triggered by the layout manager.
+         *
+         * These events allow applications to respond to layout changes.
+         */
         this.events = {
+            /** Fired when the layout is switched */
             layoutSwitched: new AcCmEventManager()
         };
     }
     /**
-     * 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}`);
+     * ```
      */
     AcDbLayoutManager.prototype.countLayouts = function (db) {
         return this.getWorkingDatabase(db).dictionaries.layouts.numEntries;
     };
     /**
-     * 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);
+     * }
+     * ```
      */
     AcDbLayoutManager.prototype.findLayoutNamed = function (name, db) {
         return this.getWorkingDatabase(db).dictionaries.layouts.getAt(name);
     };
     /**
-     * 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);
+     * ```
      */
     AcDbLayoutManager.prototype.findActiveLayout = function () {
         var layout = this.getActiveLayout();
         return layout ? layout.layoutName : 'Model';
     };
     /**
-     * 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');
+     * }
+     * ```
      */
     AcDbLayoutManager.prototype.setCurrentLayoutId = function (id, db) {
         var currentDb = this.getWorkingDatabase(db);
@@ -48,11 +99,16 @@ var AcDbLayoutManager = /** @class */ (function () {
         return this.setCurrentLayoutInternal(layout, currentDb);
     };
     /**
-     * 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');
+     * ```
      */
     AcDbLayoutManager.prototype.setCurrentLayoutBtrId = function (id, db) {
         var currentDb = this.getWorkingDatabase(db);
@@ -60,11 +116,16 @@ var AcDbLayoutManager = /** @class */ (function () {
         return this.setCurrentLayoutInternal(layout, currentDb);
     };
     /**
-     * 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');
+     * ```
      */
     AcDbLayoutManager.prototype.setCurrentLayout = function (name, db) {
         var currentDb = this.getWorkingDatabase(db);
@@ -72,11 +133,17 @@ var AcDbLayoutManager = /** @class */ (function () {
         return this.setCurrentLayoutInternal(layout, currentDb);
     };
     /**
-     * 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');
+     * ```
      */
     AcDbLayoutManager.prototype.renameLayout = function (oldName, newName, db) {
         var currentDb = this.getWorkingDatabase(db);

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

@@ -1 +1 @@
-{"version":3,"file":"AcDbLayoutManager.js","sourceRoot":"","sources":["../../../src/object/layout/AcDbLayoutManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAEpD,OAAO,EAAE,2BAA2B,EAAgB,MAAM,YAAY,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAgB,MAAM,gBAAgB,CAAA;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAOzC;IAAA;QACkB,WAAM,GAAG;YACvB,cAAc,EAAE,IAAI,gBAAgB,EAAuB;SAC5D,CAAA;IAgKH,CAAC;IA/JC;;;;;OAKG;IACH,wCAAY,GAAZ,UAAa,EAAiB;QAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAA;IACpE,CAAC;IAED;;;;;;OAMG;IACH,2CAAe,GAAf,UAAgB,IAAY,EAAE,EAAiB;QAC7C,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACrE,CAAC;IAED;;;OAGG;IACH,4CAAgB,GAAhB;QACE,IAAM,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAA;QACrC,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAA;IAC7C,CAAC;IAED;;;;;;OAMG;IACH,8CAAkB,GAAlB,UAAmB,EAAgB,EAAE,EAAiB;QACpD,IAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAC7C,IAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACzD,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACzD,CAAC;IAED;;;;;;OAMG;IACH,iDAAqB,GAArB,UAAsB,EAAgB,EAAE,EAAiB;QACvD,IAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAC7C,IAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;QAC5D,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACzD,CAAC;IAED;;;;;;OAMG;IACH,4CAAgB,GAAhB,UAAiB,IAAY,EAAE,EAAiB;QAC9C,IAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAC7C,IAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACzD,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACzD,CAAC;IAED;;;;;;OAMG;IACH,wCAAY,GAAZ,UAAa,OAAe,EAAE,OAAe,EAAE,EAAiB;QAC9D,IAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAC7C,IAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAC5D,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,UAAU,GAAG,OAAO,CAAA;YAC3B,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;OAOG;IACH,wCAAY,GAAZ,UAAa,IAAY,EAAE,EAAiB;QAC1C,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACnE,CAAC;IAED;;;;;;OAMG;IACH,wCAAY,GAAZ,UAAa,IAAY,EAAE,EAAiB;QAC1C,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACtE,CAAC;IAED;;;;;OAKG;IACH,wCAAY,GAAZ,UAAa,IAAY,EAAE,EAAiB;QAC1C,IAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAE7C,IAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAA;QAC/B,MAAM,CAAC,UAAU,GAAG,IAAI,CAAA;QACxB,MAAM,CAAC,QAAQ,GAAG,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,WAAW,CAAA;QAE5D,IAAM,GAAG,GAAG,IAAI,oBAAoB,EAAE,CAAA;QACtC,GAAG,CAAC,IAAI,GAAG,sBAAe,MAAM,CAAC,QAAQ,CAAE,CAAA;QAC3C,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEpC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAElD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;IACrC,CAAC;IAED;;;;OAIG;IACH,2CAAe,GAAf,UAAgB,EAAiB;QAC/B,IAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAC7C,OAAO,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA;IAC5E,CAAC;IAEO,8CAAkB,GAA1B,UAA2B,EAAiB;QAC1C,OAAO,EAAE,IAAI,2BAA2B,EAAE,CAAC,eAAe,CAAA;IAC5D,CAAC;IAEO,oDAAwB,GAAhC,UACE,MAA8B,EAC9B,SAAuB;QAEvB,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC;gBAClC,SAAS,EAAE,IAAI,CAAC,eAAe,EAAG;gBAClC,SAAS,EAAE,MAAM;aAClB,CAAC,CAAA;YACF,SAAS,CAAC,cAAc,GAAG,MAAM,CAAC,kBAAkB,CAAA;YACpD,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IACH,wBAAC;AAAD,CAAC,AAnKD,IAmKC"}
+{"version":3,"file":"AcDbLayoutManager.js","sourceRoot":"","sources":["../../../src/object/layout/AcDbLayoutManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAEpD,OAAO,EAAE,2BAA2B,EAAgB,MAAM,YAAY,CAAA;AACtE,OAAO,EAAE,oBAAoB,EAAgB,MAAM,gBAAgB,CAAA;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAYzC;;;;;;;;;;;;;GAaG;AACH;IAAA;QACE;;;;WAIG;QACa,WAAM,GAAG;YACvB,wCAAwC;YACxC,cAAc,EAAE,IAAI,gBAAgB,EAAuB;SAC5D,CAAA;IAgNH,CAAC;IA9MC;;;;;;;;;;;;;OAaG;IACH,wCAAY,GAAZ,UAAa,EAAiB;QAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAA;IACpE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,2CAAe,GAAf,UAAgB,IAAY,EAAE,EAAiB;QAC7C,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACrE,CAAC;IAED;;;;;;;;;;OAUG;IACH,4CAAgB,GAAhB;QACE,IAAM,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAA;QACrC,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAA;IAC7C,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,8CAAkB,GAAlB,UAAmB,EAAgB,EAAE,EAAiB;QACpD,IAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAC7C,IAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACzD,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACzD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iDAAqB,GAArB,UAAsB,EAAgB,EAAE,EAAiB;QACvD,IAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAC7C,IAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;QAC5D,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACzD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,4CAAgB,GAAhB,UAAiB,IAAY,EAAE,EAAiB;QAC9C,IAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAC7C,IAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACzD,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACzD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,wCAAY,GAAZ,UAAa,OAAe,EAAE,OAAe,EAAE,EAAiB;QAC9D,IAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAC7C,IAAM,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAC5D,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,UAAU,GAAG,OAAO,CAAA;YAC3B,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;OAOG;IACH,wCAAY,GAAZ,UAAa,IAAY,EAAE,EAAiB;QAC1C,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACnE,CAAC;IAED;;;;;;OAMG;IACH,wCAAY,GAAZ,UAAa,IAAY,EAAE,EAAiB;QAC1C,OAAO,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACtE,CAAC;IAED;;;;;OAKG;IACH,wCAAY,GAAZ,UAAa,IAAY,EAAE,EAAiB;QAC1C,IAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAE7C,IAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAA;QAC/B,MAAM,CAAC,UAAU,GAAG,IAAI,CAAA;QACxB,MAAM,CAAC,QAAQ,GAAG,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,WAAW,CAAA;QAE5D,IAAM,GAAG,GAAG,IAAI,oBAAoB,EAAE,CAAA;QACtC,GAAG,CAAC,IAAI,GAAG,sBAAe,MAAM,CAAC,QAAQ,CAAE,CAAA;QAC3C,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEpC,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAElD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;IACrC,CAAC;IAED;;;;OAIG;IACH,2CAAe,GAAf,UAAgB,EAAiB;QAC/B,IAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAA;QAC7C,OAAO,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA;IAC5E,CAAC;IAEO,8CAAkB,GAA1B,UAA2B,EAAiB;QAC1C,OAAO,EAAE,IAAI,2BAA2B,EAAE,CAAC,eAAe,CAAA;IAC5D,CAAC;IAEO,oDAAwB,GAAhC,UACE,MAA8B,EAC9B,SAAuB;QAEvB,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC;gBAClC,SAAS,EAAE,IAAI,CAAC,eAAe,EAAG;gBAClC,SAAS,EAAE,MAAM;aAClB,CAAC,CAAA;YACF,SAAS,CAAC,cAAc,GAAG,MAAM,CAAC,kBAAkB,CAAA;YACpD,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IACH,wBAAC;AAAD,CAAC,AAzND,IAyNC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mlightcad/data-model",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "license": "MIT",
   "type": "module",
   "repository": {
@@ -36,9 +36,9 @@
     "uid": "^2.0.2"
   },
   "devDependencies": {
-    "@mlightcad/common": "1.1.1",
-    "@mlightcad/geometry-engine": "2.0.2",
-    "@mlightcad/graphic-interface": "2.0.2"
+    "@mlightcad/common": "1.1.2",
+    "@mlightcad/geometry-engine": "2.0.3",
+    "@mlightcad/graphic-interface": "2.0.3"
   },
   "scripts": {
     "analyze": "vite build --mode analyze",