@mlightcad/data-model 1.1.2 → 1.1.4

package/lib/database/AcDbLayerTableRecord.d.ts

@@ -1,96 +1,276 @@
 import { AcCmColor } from '@mlightcad/common';
 import { AcDbSymbolTableRecord, AcDbSymbolTableRecordAttrs } from './AcDbSymbolTableRecord';
+/**
+ * Interface defining the attributes for layer table records.
+ *
+ * Extends the base AcDbSymbolTableRecordAttrs interface and adds layer-specific
+ * properties such as color, visibility, linetype, and other layer settings.
+ */
 export interface AcDbLayerTableRecordAttrs extends AcDbSymbolTableRecordAttrs {
+    /** The color of the layer */
     color: AcCmColor;
+    /** Optional description of the layer */
     description?: string;
+    /** Standard flags for layer properties (bit-coded values) */
     standardFlags: number;
+    /** Whether the layer is hidden */
     isHidden?: boolean;
+    /** Whether the layer is in use */
     isInUse?: boolean;
+    /** Whether the layer is turned off */
     isOff: boolean;
+    /** Whether the layer is plottable */
     isPlottable: boolean;
+    /** Transparency level of the layer (0-1) */
     transparency: number;
+    /** The linetype name for the layer */
     linetype: string;
+    /** The line weight for the layer */
     lineWeight: number;
+    /** The material ID associated with the layer */
     materialId?: string;
 }
 /**
- * This class represents records in the layer table. Each of these records contains the information
- * (color, on or off, frozen or thawed, etc.) about a layer in the drawing database.
+ * Represents a record in the layer table.
+ *
+ * This class contains information about a layer in the drawing database,
+ * including color, visibility settings, linetype, and other layer properties.
+ * Layers are used to organize and control the display of entities in the drawing.
+ *
+ * @example
+ * ```typescript
+ * const layer = new AcDbLayerTableRecord({
+ *   name: 'MyLayer',
+ *   color: new AcCmColor(255, 0, 0), // Red
+ *   isOff: false,
+ *   isPlottable: true
+ * });
+ * ```
  */
 export declare class AcDbLayerTableRecord extends AcDbSymbolTableRecord<AcDbLayerTableRecordAttrs> {
     /**
-     * Default constructor.
+     * Creates a new AcDbLayerTableRecord instance.
+     *
+     * @param attrs - Input attribute values for this layer table record
+     * @param defaultAttrs - Default values for attributes of this layer table record
+     *
+     * @example
+     * ```typescript
+     * const layer = new AcDbLayerTableRecord({
+     *   name: 'MyLayer',
+     *   color: new AcCmColor(255, 0, 0)
+     * });
+     * ```
      */
     constructor(attrs?: Partial<AcDbLayerTableRecordAttrs>, defaultAttrs?: Partial<AcDbLayerTableRecordAttrs>);
     /**
-     * The color value of this layer.
+     * Gets or sets the color value of this layer.
+     *
+     * @returns The color of the layer
+     *
+     * @example
+     * ```typescript
+     * const color = layer.color;
+     * layer.color = new AcCmColor(255, 0, 0); // Red
+     * ```
      */
     get color(): AcCmColor;
     set color(value: AcCmColor);
     /**
-     * The description of this layer.
+     * Gets or sets the description of this layer.
+     *
+     * @returns The description of the layer
+     *
+     * @example
+     * ```typescript
+     * const description = layer.description;
+     * layer.description = 'My custom layer';
+     * ```
      */
     get description(): string;
     set description(value: string);
     /**
-     * Standard flags (bit-coded values):
+     * Gets or sets the standard flags for this layer.
+     *
+     * Standard flags are bit-coded values:
      * - 1 = Layer is frozen; otherwise layer is thawed
      * - 2 = Layer is frozen by default in new viewports
      * - 4 = Layer is locked
      * - 16 = If set, table entry is externally dependent on an xref
      * - 32 = If both this bit and bit 16 are set, the externally dependent xref has been successfully resolved
-     * - 64 = If set, the table entry was referenced by at least one entity in the drawing the last time the drawing was edited. (This flag is for the benefit of AutoCAD commands. It can be ignored by most programs that read DXF files and need not be set by programs that write DXF files)
+     * - 64 = If set, the table entry was referenced by at least one entity in the drawing the last time the drawing was edited
+     *
+     * @returns The standard flags value
+     *
+     * @example
+     * ```typescript
+     * const flags = layer.standardFlags;
+     * layer.standardFlags = 1; // Freeze the layer
+     * ```
      */
     get standardFlags(): number;
     set standardFlags(value: number);
     /**
-     * Frozen state of this layer. If it is true, the layer is frozen.
+     * Gets or sets whether this layer is frozen.
+     *
+     * When a layer is frozen, its entities are not displayed and cannot be modified.
+     *
+     * @returns True if the layer is frozen, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (layer.isFrozen) {
+     *   console.log('Layer is frozen');
+     * }
+     * layer.isFrozen = true;
+     * ```
      */
     get isFrozen(): boolean;
     set isFrozen(value: boolean);
     /**
-     * Flag to hide or show this layer. If it is true, the layer isn't shown in the user interface of
-     * host application.
+     * Gets or sets whether this layer is hidden.
+     *
+     * When a layer is hidden, it isn't shown in the user interface of
+     * the host application, but entities on the layer are still displayed.
+     *
+     * @returns True if the layer is hidden, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (layer.isHidden) {
+     *   console.log('Layer is hidden from UI');
+     * }
+     * layer.isHidden = true;
+     * ```
      */
     get isHidden(): boolean;
     set isHidden(value: boolean);
     /**
-     * In-use state of this layer. If it is true, the layer is in use.
+     * Gets or sets whether this layer is in use.
+     *
+     * A layer is considered in use if it contains entities or is referenced
+     * by other objects in the drawing.
+     *
+     * @returns True if the layer is in use, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (layer.isInUse) {
+     *   console.log('Layer contains entities');
+     * }
+     * ```
      */
     get isInUse(): boolean;
     set isInUse(value: boolean);
     /**
-     * Locked state of this layer. If it is true, the layer is locked.
+     * Gets or sets whether this layer is locked.
+     *
+     * When a layer is locked, its entities cannot be modified but are still visible.
+     *
+     * @returns True if the layer is locked, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (layer.isLocked) {
+     *   console.log('Layer is locked');
+     * }
+     * layer.isLocked = true;
+     * ```
      */
     get isLocked(): boolean;
     set isLocked(value: boolean);
     /**
-     * Off state of this layer. If it is true, the layer is off.
+     * Gets or sets whether this layer is turned off.
+     *
+     * When a layer is turned off, its entities are not displayed but can still be modified.
+     *
+     * @returns True if the layer is turned off, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (layer.isOff) {
+     *   console.log('Layer is turned off');
+     * }
+     * layer.isOff = true;
+     * ```
      */
     get isOff(): boolean;
     set isOff(value: boolean);
     /**
-     * Plottable state of this layer. If it is true, the layer is plottable.
+     * Gets or sets whether this layer is plottable.
+     *
+     * When a layer is plottable, its entities will be included when the drawing is plotted or printed.
+     *
+     * @returns True if the layer is plottable, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (layer.isPlottable) {
+     *   console.log('Layer will be included in plots');
+     * }
+     * layer.isPlottable = false;
+     * ```
      */
     get isPlottable(): boolean;
     set isPlottable(value: boolean);
     /**
-     * The transparency value of this layer.
+     * Gets or sets the transparency level of this layer.
+     *
+     * Transparency values range from 0 (opaque) to 1 (fully transparent).
+     *
+     * @returns The transparency level (0-1)
+     *
+     * @example
+     * ```typescript
+     * const transparency = layer.transparency;
+     * layer.transparency = 0.5; // 50% transparent
+     * ```
      */
     get transparency(): number;
     set transparency(value: number);
     /**
-     * Line type name referenced by this layer.
+     * Gets or sets the linetype name for this layer.
+     *
+     * The linetype defines the pattern of dashes, dots, and spaces used
+     * to display lines and curves on this layer.
+     *
+     * @returns The linetype name
+     *
+     * @example
+     * ```typescript
+     * const linetype = layer.linetype;
+     * layer.linetype = 'DASHED';
+     * ```
      */
     get linetype(): string;
     set linetype(value: string);
     /**
-     * Line weight of this layer.
+     * Gets or sets the line weight for this layer.
+     *
+     * Line weight determines the thickness of lines and curves on this layer.
+     *
+     * @returns The line weight value
+     *
+     * @example
+     * ```typescript
+     * const weight = layer.lineWeight;
+     * layer.lineWeight = 2.0; // 2.0mm line weight
+     * ```
      */
     get lineWeight(): number;
     set lineWeight(value: number);
     /**
-     * Id of material assigned to this layer.
+     * Gets or sets the material ID associated with this layer.
+     *
+     * Material IDs are used for rendering and visualization purposes.
+     *
+     * @returns The material ID
+     *
+     * @example
+     * ```typescript
+     * const materialId = layer.materialId;
+     * layer.materialId = 'concrete';
+     * ```
      */
     get materialId(): string;
     set materialId(value: string);

package/lib/database/AcDbLayerTableRecord.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbLayerTableRecord.d.ts","sourceRoot":"","sources":["../../src/database/AcDbLayerTableRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAY,MAAM,mBAAmB,CAAA;AAEvD,OAAO,EACL,qBAAqB,EACrB,0BAA0B,EAC3B,MAAM,yBAAyB,CAAA;AAEhC,MAAM,WAAW,yBAA0B,SAAQ,0BAA0B;IAC3E,KAAK,EAAE,SAAS,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,EAAE,OAAO,CAAA;IACd,WAAW,EAAE,OAAO,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,qBAAqB,CAAC,yBAAyB,CAAC;IACxF;;OAEG;gBAED,KAAK,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,EAC1C,YAAY,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC;IA0BnD;;OAEG;IACH,IAAI,KAAK,IAGQ,SAAS,CADzB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,SAAS,EAEzB;IAED;;OAEG;IACH,IAAI,WAAW,IAGQ,MAAM,CAD5B;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,EAE5B;IAED;;;;;;;;OAQG;IACH,IAAI,aAAa,IAGQ,MAAM,CAD9B;IACD,IAAI,aAAa,CAAC,KAAK,EAAE,MAAM,EAE9B;IAED;;OAEG;IACH,IAAI,QAAQ,IAGQ,OAAO,CAD1B;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAG1B;IAED;;;OAGG;IACH,IAAI,QAAQ,IAGQ,OAAO,CAD1B;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAE1B;IAED;;OAEG;IACH,IAAI,OAAO,IAGQ,OAAO,CADzB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED;;OAEG;IACH,IAAI,QAAQ,IAGQ,OAAO,CAD1B;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAG1B;IAED;;OAEG;IACH,IAAI,KAAK,IAGQ,OAAO,CADvB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,EAEvB;IAED;;OAEG;IACH,IAAI,WAAW,IAGQ,OAAO,CAD7B;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,OAAO,EAE7B;IAED;;OAEG;IACH,IAAI,YAAY,IAGQ,MAAM,CAD7B;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED;;OAEG;IACH,IAAI,QAAQ,IAGQ,MAAM,CADzB;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;OAEG;IACH,IAAI,UAAU,IAGQ,MAAM,CAD3B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;OAEG;IACH,IAAI,UAAU,IAGQ,MAAM,CAD3B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;CACF"}
+{"version":3,"file":"AcDbLayerTableRecord.d.ts","sourceRoot":"","sources":["../../src/database/AcDbLayerTableRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAY,MAAM,mBAAmB,CAAA;AAEvD,OAAO,EACL,qBAAqB,EACrB,0BAA0B,EAC3B,MAAM,yBAAyB,CAAA;AAEhC;;;;;GAKG;AACH,MAAM,WAAW,yBAA0B,SAAQ,0BAA0B;IAC3E,6BAA6B;IAC7B,KAAK,EAAE,SAAS,CAAA;IAChB,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,6DAA6D;IAC7D,aAAa,EAAE,MAAM,CAAA;IACrB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,kCAAkC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,sCAAsC;IACtC,KAAK,EAAE,OAAO,CAAA;IACd,qCAAqC;IACrC,WAAW,EAAE,OAAO,CAAA;IACpB,4CAA4C;IAC5C,YAAY,EAAE,MAAM,CAAA;IACpB,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAA;IAClB,gDAAgD;IAChD,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,oBAAqB,SAAQ,qBAAqB,CAAC,yBAAyB,CAAC;IACxF;;;;;;;;;;;;;OAaG;gBAED,KAAK,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,EAC1C,YAAY,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC;IA0BnD;;;;;;;;;;OAUG;IACH,IAAI,KAAK,IAGQ,SAAS,CADzB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,SAAS,EAEzB;IAED;;;;;;;;;;OAUG;IACH,IAAI,WAAW,IAGQ,MAAM,CAD5B;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,EAE5B;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,aAAa,IAGQ,MAAM,CAD9B;IACD,IAAI,aAAa,CAAC,KAAK,EAAE,MAAM,EAE9B;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,QAAQ,IAGQ,OAAO,CAD1B;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAG1B;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,QAAQ,IAGQ,OAAO,CAD1B;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAE1B;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,OAAO,IAGQ,OAAO,CADzB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,QAAQ,IAGQ,OAAO,CAD1B;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAG1B;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,KAAK,IAGQ,OAAO,CADvB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,EAEvB;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,WAAW,IAGQ,OAAO,CAD7B;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,OAAO,EAE7B;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,YAAY,IAGQ,MAAM,CAD7B;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,QAAQ,IAGQ,MAAM,CADzB;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,UAAU,IAGQ,MAAM,CAD3B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,UAAU,IAGQ,MAAM,CAD3B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;CACF"}

package/lib/database/AcDbLayerTableRecord.js

@@ -16,13 +16,37 @@ var __extends = (this && this.__extends) || (function () {
 import { AcCmColor, defaults } from '@mlightcad/common';
 import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
 /**
- * This class represents records in the layer table. Each of these records contains the information
- * (color, on or off, frozen or thawed, etc.) about a layer in the drawing database.
+ * Represents a record in the layer table.
+ *
+ * This class contains information about a layer in the drawing database,
+ * including color, visibility settings, linetype, and other layer properties.
+ * Layers are used to organize and control the display of entities in the drawing.
+ *
+ * @example
+ * ```typescript
+ * const layer = new AcDbLayerTableRecord({
+ *   name: 'MyLayer',
+ *   color: new AcCmColor(255, 0, 0), // Red
+ *   isOff: false,
+ *   isPlottable: true
+ * });
+ * ```
  */
 var AcDbLayerTableRecord = /** @class */ (function (_super) {
     __extends(AcDbLayerTableRecord, _super);
     /**
-     * Default constructor.
+     * Creates a new AcDbLayerTableRecord instance.
+     *
+     * @param attrs - Input attribute values for this layer table record
+     * @param defaultAttrs - Default values for attributes of this layer table record
+     *
+     * @example
+     * ```typescript
+     * const layer = new AcDbLayerTableRecord({
+     *   name: 'MyLayer',
+     *   color: new AcCmColor(255, 0, 0)
+     * });
+     * ```
      */
     function AcDbLayerTableRecord(attrs, defaultAttrs) {
         var _this = this;
@@ -52,7 +76,15 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     }
     Object.defineProperty(AcDbLayerTableRecord.prototype, "color", {
         /**
-         * The color value of this layer.
+         * Gets or sets the color value of this layer.
+         *
+         * @returns The color of the layer
+         *
+         * @example
+         * ```typescript
+         * const color = layer.color;
+         * layer.color = new AcCmColor(255, 0, 0); // Red
+         * ```
          */
         get: function () {
             return this.getAttr('color');
@@ -65,7 +97,15 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayerTableRecord.prototype, "description", {
         /**
-         * The description of this layer.
+         * Gets or sets the description of this layer.
+         *
+         * @returns The description of the layer
+         *
+         * @example
+         * ```typescript
+         * const description = layer.description;
+         * layer.description = 'My custom layer';
+         * ```
          */
         get: function () {
             return this.getAttr('description');
@@ -78,13 +118,23 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayerTableRecord.prototype, "standardFlags", {
         /**
-         * Standard flags (bit-coded values):
+         * Gets or sets the standard flags for this layer.
+         *
+         * Standard flags are bit-coded values:
          * - 1 = Layer is frozen; otherwise layer is thawed
          * - 2 = Layer is frozen by default in new viewports
          * - 4 = Layer is locked
          * - 16 = If set, table entry is externally dependent on an xref
          * - 32 = If both this bit and bit 16 are set, the externally dependent xref has been successfully resolved
-         * - 64 = If set, the table entry was referenced by at least one entity in the drawing the last time the drawing was edited. (This flag is for the benefit of AutoCAD commands. It can be ignored by most programs that read DXF files and need not be set by programs that write DXF files)
+         * - 64 = If set, the table entry was referenced by at least one entity in the drawing the last time the drawing was edited
+         *
+         * @returns The standard flags value
+         *
+         * @example
+         * ```typescript
+         * const flags = layer.standardFlags;
+         * layer.standardFlags = 1; // Freeze the layer
+         * ```
          */
         get: function () {
             return this.getAttr('standardFlags');
@@ -97,7 +147,19 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayerTableRecord.prototype, "isFrozen", {
         /**
-         * Frozen state of this layer. If it is true, the layer is frozen.
+         * Gets or sets whether this layer is frozen.
+         *
+         * When a layer is frozen, its entities are not displayed and cannot be modified.
+         *
+         * @returns True if the layer is frozen, false otherwise
+         *
+         * @example
+         * ```typescript
+         * if (layer.isFrozen) {
+         *   console.log('Layer is frozen');
+         * }
+         * layer.isFrozen = true;
+         * ```
          */
         get: function () {
             return (this.standardFlags & 0x01) == 1;
@@ -111,8 +173,20 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayerTableRecord.prototype, "isHidden", {
         /**
-         * Flag to hide or show this layer. If it is true, the layer isn't shown in the user interface of
-         * host application.
+         * Gets or sets whether this layer is hidden.
+         *
+         * When a layer is hidden, it isn't shown in the user interface of
+         * the host application, but entities on the layer are still displayed.
+         *
+         * @returns True if the layer is hidden, false otherwise
+         *
+         * @example
+         * ```typescript
+         * if (layer.isHidden) {
+         *   console.log('Layer is hidden from UI');
+         * }
+         * layer.isHidden = true;
+         * ```
          */
         get: function () {
             return this.getAttr('isHidden');
@@ -125,7 +199,19 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayerTableRecord.prototype, "isInUse", {
         /**
-         * In-use state of this layer. If it is true, the layer is in use.
+         * Gets or sets whether this layer is in use.
+         *
+         * A layer is considered in use if it contains entities or is referenced
+         * by other objects in the drawing.
+         *
+         * @returns True if the layer is in use, false otherwise
+         *
+         * @example
+         * ```typescript
+         * if (layer.isInUse) {
+         *   console.log('Layer contains entities');
+         * }
+         * ```
          */
         get: function () {
             return this.getAttr('isInUse');
@@ -138,10 +224,22 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayerTableRecord.prototype, "isLocked", {
         /**
-         * Locked state of this layer. If it is true, the layer is locked.
+         * Gets or sets whether this layer is locked.
+         *
+         * When a layer is locked, its entities cannot be modified but are still visible.
+         *
+         * @returns True if the layer is locked, false otherwise
+         *
+         * @example
+         * ```typescript
+         * if (layer.isLocked) {
+         *   console.log('Layer is locked');
+         * }
+         * layer.isLocked = true;
+         * ```
          */
         get: function () {
-            return (this.standardFlags & 0x04) == 1;
+            return (this.standardFlags & 0x04) == 4;
         },
         set: function (value) {
             var flag = value ? 4 : 0;
@@ -152,7 +250,19 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayerTableRecord.prototype, "isOff", {
         /**
-         * Off state of this layer. If it is true, the layer is off.
+         * Gets or sets whether this layer is turned off.
+         *
+         * When a layer is turned off, its entities are not displayed but can still be modified.
+         *
+         * @returns True if the layer is turned off, false otherwise
+         *
+         * @example
+         * ```typescript
+         * if (layer.isOff) {
+         *   console.log('Layer is turned off');
+         * }
+         * layer.isOff = true;
+         * ```
          */
         get: function () {
             return this.getAttr('isOff');
@@ -165,7 +275,19 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayerTableRecord.prototype, "isPlottable", {
         /**
-         * Plottable state of this layer. If it is true, the layer is plottable.
+         * Gets or sets whether this layer is plottable.
+         *
+         * When a layer is plottable, its entities will be included when the drawing is plotted or printed.
+         *
+         * @returns True if the layer is plottable, false otherwise
+         *
+         * @example
+         * ```typescript
+         * if (layer.isPlottable) {
+         *   console.log('Layer will be included in plots');
+         * }
+         * layer.isPlottable = false;
+         * ```
          */
         get: function () {
             return this.getAttr('isPlottable');
@@ -178,7 +300,17 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayerTableRecord.prototype, "transparency", {
         /**
-         * The transparency value of this layer.
+         * Gets or sets the transparency level of this layer.
+         *
+         * Transparency values range from 0 (opaque) to 1 (fully transparent).
+         *
+         * @returns The transparency level (0-1)
+         *
+         * @example
+         * ```typescript
+         * const transparency = layer.transparency;
+         * layer.transparency = 0.5; // 50% transparent
+         * ```
          */
         get: function () {
             return this.getAttr('transparency');
@@ -191,7 +323,18 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayerTableRecord.prototype, "linetype", {
         /**
-         * Line type name referenced by this layer.
+         * Gets or sets the linetype name for this layer.
+         *
+         * The linetype defines the pattern of dashes, dots, and spaces used
+         * to display lines and curves on this layer.
+         *
+         * @returns The linetype name
+         *
+         * @example
+         * ```typescript
+         * const linetype = layer.linetype;
+         * layer.linetype = 'DASHED';
+         * ```
          */
         get: function () {
             return this.getAttr('linetype');
@@ -204,7 +347,17 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayerTableRecord.prototype, "lineWeight", {
         /**
-         * Line weight of this layer.
+         * Gets or sets the line weight for this layer.
+         *
+         * Line weight determines the thickness of lines and curves on this layer.
+         *
+         * @returns The line weight value
+         *
+         * @example
+         * ```typescript
+         * const weight = layer.lineWeight;
+         * layer.lineWeight = 2.0; // 2.0mm line weight
+         * ```
          */
         get: function () {
             return this.getAttr('lineWeight');
@@ -217,7 +370,17 @@ var AcDbLayerTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLayerTableRecord.prototype, "materialId", {
         /**
-         * Id of material assigned to this layer.
+         * Gets or sets the material ID associated with this layer.
+         *
+         * Material IDs are used for rendering and visualization purposes.
+         *
+         * @returns The material ID
+         *
+         * @example
+         * ```typescript
+         * const materialId = layer.materialId;
+         * layer.materialId = 'concrete';
+         * ```
          */
         get: function () {
             return this.getAttr('materialId');

package/lib/database/AcDbLayerTableRecord.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbLayerTableRecord.js","sourceRoot":"","sources":["../../src/database/AcDbLayerTableRecord.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAEvD,OAAO,EACL,qBAAqB,EAEtB,MAAM,yBAAyB,CAAA;AAgBhC;;;GAGG;AACH;IAA0C,wCAAgD;IACxF;;OAEG;IACH,8BACE,KAA0C,EAC1C,YAAiD;QAFnD,iBA0BC;QAtBC,KAAK,GAAG,KAAK,IAAI,EAAE,CAAA;QACnB,QAAQ,CAAC,KAAK,EAAE;YACd,KAAK,EAAE,IAAI,SAAS,EAAE;YACtB,WAAW,EAAE,EAAE;YACf,aAAa,EAAE,CAAC;YAChB,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,IAAI;YACjB,YAAY,EAAE,CAAC;YACf,QAAQ,EAAE,EAAE;YACZ,UAAU,EAAE,CAAC;YACb,UAAU,EAAE,CAAC,CAAC;SACf,CAAC,CAAA;QACF,QAAA,MAAK,YAAC,KAAK,EAAE,YAAY,CAAC,SAAA;QAC1B,KAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAA,IAAI;YACjD,KAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC;gBAC1C,QAAQ,EAAE,KAAI,CAAC,QAAQ;gBACvB,KAAK,EAAE,KAAI;gBACX,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;aACzC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;;IACJ,CAAC;IAKD,sBAAI,uCAAK;QAHT;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC9B,CAAC;aACD,UAAU,KAAgB;YACxB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAA;QACtC,CAAC;;;OAHA;IAQD,sBAAI,6CAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QACpC,CAAC;aACD,UAAgB,KAAa;YAC3B,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,CAAA;QACpC,CAAC;;;OAHA;IAcD,sBAAI,+CAAa;QATjB;;;;;;;;WAQG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;QACtC,CAAC;aACD,UAAkB,KAAa;YAC7B,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,CAAA;QACtC,CAAC;;;OAHA;IAQD,sBAAI,0CAAQ;QAHZ;;WAEG;aACH;YACE,OAAO,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,CAAA;QACzC,CAAC;aACD,UAAa,KAAc;YACzB,IAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;QAChD,CAAC;;;OAJA;IAUD,sBAAI,0CAAQ;QAJZ;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QACjC,CAAC;aACD,UAAa,KAAc;YACzB,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACjC,CAAC;;;OAHA;IAQD,sBAAI,yCAAO;QAHX;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;QAChC,CAAC;aACD,UAAY,KAAc;YACxB,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QAChC,CAAC;;;OAHA;IAQD,sBAAI,0CAAQ;QAHZ;;WAEG;aACH;YACE,OAAO,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,CAAA;QACzC,CAAC;aACD,UAAa,KAAc;YACzB,IAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;QAChD,CAAC;;;OAJA;IASD,sBAAI,uCAAK;QAHT;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC9B,CAAC;aACD,UAAU,KAAc;YACtB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC9B,CAAC;;;OAHA;IAQD,sBAAI,6CAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QACpC,CAAC;aACD,UAAgB,KAAc;YAC5B,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,CAAA;QACpC,CAAC;;;OAHA;IAQD,sBAAI,8CAAY;QAHhB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;QACrC,CAAC;aACD,UAAiB,KAAa;YAC5B,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,CAAA;QACrC,CAAC;;;OAHA;IAQD,sBAAI,0CAAQ;QAHZ;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QACjC,CAAC;aACD,UAAa,KAAa;YACxB,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACjC,CAAC;;;OAHA;IAQD,sBAAI,4CAAU;QAHd;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QACnC,CAAC;aACD,UAAe,KAAa;YAC1B,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA;QACnC,CAAC;;;OAHA;IAQD,sBAAI,4CAAU;QAHd;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QACnC,CAAC;aACD,UAAe,KAAa;YAC1B,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA;QACnC,CAAC;;;OAHA;IAIH,2BAAC;AAAD,CAAC,AA1KD,CAA0C,qBAAqB,GA0K9D"}
+{"version":3,"file":"AcDbLayerTableRecord.js","sourceRoot":"","sources":["../../src/database/AcDbLayerTableRecord.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAEvD,OAAO,EACL,qBAAqB,EAEtB,MAAM,yBAAyB,CAAA;AAiChC;;;;;;;;;;;;;;;;GAgBG;AACH;IAA0C,wCAAgD;IACxF;;;;;;;;;;;;;OAaG;IACH,8BACE,KAA0C,EAC1C,YAAiD;QAFnD,iBA0BC;QAtBC,KAAK,GAAG,KAAK,IAAI,EAAE,CAAA;QACnB,QAAQ,CAAC,KAAK,EAAE;YACd,KAAK,EAAE,IAAI,SAAS,EAAE;YACtB,WAAW,EAAE,EAAE;YACf,aAAa,EAAE,CAAC;YAChB,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,IAAI;YACjB,YAAY,EAAE,CAAC;YACf,QAAQ,EAAE,EAAE;YACZ,UAAU,EAAE,CAAC;YACb,UAAU,EAAE,CAAC,CAAC;SACf,CAAC,CAAA;QACF,QAAA,MAAK,YAAC,KAAK,EAAE,YAAY,CAAC,SAAA;QAC1B,KAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAA,IAAI;YACjD,KAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC;gBAC1C,QAAQ,EAAE,KAAI,CAAC,QAAQ;gBACvB,KAAK,EAAE,KAAI;gBACX,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;aACzC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;;IACJ,CAAC;IAaD,sBAAI,uCAAK;QAXT;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC9B,CAAC;aACD,UAAU,KAAgB;YACxB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAA;QACtC,CAAC;;;OAHA;IAgBD,sBAAI,6CAAW;QAXf;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QACpC,CAAC;aACD,UAAgB,KAAa;YAC3B,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,CAAA;QACpC,CAAC;;;OAHA;IAwBD,sBAAI,+CAAa;QAnBjB;;;;;;;;;;;;;;;;;;WAkBG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA;QACtC,CAAC;aACD,UAAkB,KAAa;YAC7B,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,CAAA;QACtC,CAAC;;;OAHA;IAoBD,sBAAI,0CAAQ;QAfZ;;;;;;;;;;;;;;WAcG;aACH;YACE,OAAO,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,CAAA;QACzC,CAAC;aACD,UAAa,KAAc;YACzB,IAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;QAChD,CAAC;;;OAJA;IAsBD,sBAAI,0CAAQ;QAhBZ;;;;;;;;;;;;;;;WAeG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QACjC,CAAC;aACD,UAAa,KAAc;YACzB,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACjC,CAAC;;;OAHA;IAoBD,sBAAI,yCAAO;QAfX;;;;;;;;;;;;;;WAcG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;QAChC,CAAC;aACD,UAAY,KAAc;YACxB,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QAChC,CAAC;;;OAHA;IAoBD,sBAAI,0CAAQ;QAfZ;;;;;;;;;;;;;;WAcG;aACH;YACE,OAAO,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,CAAA;QACzC,CAAC;aACD,UAAa,KAAc;YACzB,IAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;QAChD,CAAC;;;OAJA;IAqBD,sBAAI,uCAAK;QAfT;;;;;;;;;;;;;;WAcG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC9B,CAAC;aACD,UAAU,KAAc;YACtB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC9B,CAAC;;;OAHA;IAoBD,sBAAI,6CAAW;QAff;;;;;;;;;;;;;;WAcG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QACpC,CAAC;aACD,UAAgB,KAAc;YAC5B,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,CAAA;QACpC,CAAC;;;OAHA;IAkBD,sBAAI,8CAAY;QAbhB;;;;;;;;;;;;WAYG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;QACrC,CAAC;aACD,UAAiB,KAAa;YAC5B,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,CAAA;QACrC,CAAC;;;OAHA;IAmBD,sBAAI,0CAAQ;QAdZ;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QACjC,CAAC;aACD,UAAa,KAAa;YACxB,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACjC,CAAC;;;OAHA;IAkBD,sBAAI,4CAAU;QAbd;;;;;;;;;;;;WAYG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QACnC,CAAC;aACD,UAAe,KAAa;YAC1B,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA;QACnC,CAAC;;;OAHA;IAkBD,sBAAI,4CAAU;QAbd;;;;;;;;;;;;WAYG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QACnC,CAAC;aACD,UAAe,KAAa;YAC1B,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA;QACnC,CAAC;;;OAHA;IAIH,2BAAC;AAAD,CAAC,AAhUD,CAA0C,qBAAqB,GAgU9D"}

package/lib/database/AcDbLinetypeTable.d.ts

@@ -2,10 +2,29 @@ import { AcDbDatabase } from './AcDbDatabase';
 import { AcDbLinetypeTableRecord } from './AcDbLinetypeTableRecord';
 import { AcDbSymbolTable } from './AcDbSymbolTable';
 /**
- * This class is the symbol table for line type table records. It represents the line types within a
- * drawing database.
+ * Symbol table for linetype table records.
+ *
+ * This class manages linetype table records which represent line types within a
+ * drawing database. Line types define the pattern of dashes, dots, and spaces
+ * used to display lines and curves in the drawing.
+ *
+ * @example
+ * ```typescript
+ * const linetypeTable = new AcDbLinetypeTable(database);
+ * const linetype = linetypeTable.getAt('Continuous');
+ * ```
  */
 export declare class AcDbLinetypeTable extends AcDbSymbolTable<AcDbLinetypeTableRecord> {
+    /**
+     * Creates a new AcDbLinetypeTable instance.
+     *
+     * @param db - The database this linetype table belongs to
+     *
+     * @example
+     * ```typescript
+     * const linetypeTable = new AcDbLinetypeTable(database);
+     * ```
+     */
     constructor(db: AcDbDatabase);
 }
 //# sourceMappingURL=AcDbLinetypeTable.d.ts.map

package/lib/database/AcDbLinetypeTable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbLinetypeTable.d.ts","sourceRoot":"","sources":["../../src/database/AcDbLinetypeTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,eAAe,CAAC,uBAAuB,CAAC;gBACjE,EAAE,EAAE,YAAY;CAG7B"}
+{"version":3,"file":"AcDbLinetypeTable.d.ts","sourceRoot":"","sources":["../../src/database/AcDbLinetypeTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;;;;;;;;;;;GAYG;AACH,qBAAa,iBAAkB,SAAQ,eAAe,CAAC,uBAAuB,CAAC;IAC7E;;;;;;;;;OASG;gBACS,EAAE,EAAE,YAAY;CAG7B"}