@mlightcad/libredwg-web 0.7.4 → 0.7.6

package/lib/converter/index.d.ts

@@ -1,2 +1,3 @@
 export * from './converter';
+export * from './dwgColorToMLeaderRawColor';
 //# sourceMappingURL=index.d.ts.map

package/lib/converter/index.js

@@ -1,2 +1,3 @@
 export * from './converter';
+export * from './dwgColorToMLeaderRawColor';
 //# sourceMappingURL=index.js.map

package/lib/database/database.d.ts

@@ -1,7 +1,7 @@
 import { DwgClass } from './classes';
 import { DwgEntity } from './entities';
 import { DwgHeader } from './header';
-import { DwgDictionaryObject, DwgImageDefObject, DwgLayoutObject, DwgSpatialFilterObject } from './objects';
+import { DwgDictionaryObject, DwgImageDefObject, DwgLayoutObject, DwgMLeaderStyleObject, DwgSpatialFilterObject } from './objects';
 import { DwgAppIdEntry, DwgBlockRecordTableEntry, DwgDimStyleTableEntry, DwgLayerTableEntry, DwgLTypeTableEntry, DwgStyleTableEntry, DwgTable, DwgVPortTableEntry } from './tables';
 export interface DwgDatabase {
     tables: {
@@ -17,6 +17,7 @@ export interface DwgDatabase {
         DICTIONARY: DwgDictionaryObject[];
         IMAGEDEF: DwgImageDefObject[];
         LAYOUT: DwgLayoutObject[];
+        MLEADERSTYLE: DwgMLeaderStyleObject[];
         SPATIAL_FILTER: DwgSpatialFilterObject[];
     };
     header: DwgHeader;

package/lib/database/entities/index.d.ts

@@ -13,6 +13,7 @@ export * from './leader';
 export * from './line';
 export * from './lwpolyline';
 export * from './mline';
+export * from './multileader';
 export * from './mtext';
 export * from './oleframe';
 export * from './ole2frame';
@@ -21,6 +22,7 @@ export * from './polyline';
 export * from './proxy';
 export * from './ray';
 export * from './section';
+export * from './shape';
 export * from './solid';
 export * from './spline';
 export * from './table';

package/lib/database/entities/index.js

@@ -13,6 +13,7 @@ export * from './leader';
 export * from './line';
 export * from './lwpolyline';
 export * from './mline';
+export * from './multileader';
 export * from './mtext';
 export * from './oleframe';
 export * from './ole2frame';
@@ -21,6 +22,7 @@ export * from './polyline';
 export * from './proxy';
 export * from './ray';
 export * from './section';
+export * from './shape';
 export * from './solid';
 export * from './spline';
 export * from './table';

package/lib/database/entities/multileader.d.ts

@@ -0,0 +1,190 @@
+import { DwgPoint3D } from '../common';
+import { DwgEntity } from './entity';
+/**
+ * MULTILEADER entity fields mapped from AutoCAD DXF MLEADER group codes.
+ *
+ * References:
+ * - https://help.autodesk.com/cloudhelp/2023/ENU/AutoCAD-DXF/files/GUID-69B9139A-48B4-48A5-B3CF-A3233ABFBE49.htm
+ * - https://github.com/mlightcad/dxf-json/blob/main/src/parser/entities/multileader/types.ts
+ */
+export interface DwgMultiLeaderEntity extends DwgEntity {
+    type: 'MULTILEADER';
+    subclassMarker?: 'AcDbMLeader';
+    /** Group code 270: MLeader version. */
+    version?: number;
+    /** Group code 340: leader style ID (handle reference). */
+    leaderStyleId?: string;
+    /** Group code 90: property override bit flags. */
+    propertyOverrideFlag?: number;
+    /** Group code 170: leader line type. */
+    leaderLineType?: number;
+    /** Group code 91: leader line color (DXF raw int32). */
+    leaderLineColor?: number;
+    /** Group code 341: leader line type ID (handle reference to linetype). */
+    leaderLineTypeId?: string;
+    /** Group code 171: leader line weight. */
+    leaderLineWeight?: number;
+    /** Group code 290: enable landing. */
+    landingEnabled?: boolean;
+    /** Group code 291: enable dogleg. */
+    doglegEnabled?: boolean;
+    /** Group code 41: dogleg length. */
+    doglegLength?: number;
+    /** Group code 342: arrowhead ID (handle reference). */
+    arrowheadId?: string;
+    /** Group code 42: arrowhead size. */
+    arrowheadSize?: number;
+    /** Group code 172: content type (none / MText / block). */
+    contentType?: number;
+    /** Group code 343: text style ID (handle reference). */
+    textStyleId?: string;
+    /** Group code 173: text left attachment type. */
+    textLeftAttachmentType?: number;
+    /** Group code 95: text right attachment type. */
+    textRightAttachmentType?: number;
+    /** Group code 174: text angle type. */
+    textAngleType?: number;
+    /** Group code 175: text alignment type. */
+    textAlignmentType?: number;
+    /** Group code 92: text color in common MLeader data (DXF raw int32). */
+    textColor?: number;
+    /** Group code 292: enable text frame. */
+    textFrameEnabled?: boolean;
+    /** Group code 145 in CONTEXT_DATA: landing gap. */
+    landingGap?: number;
+    /** Group code 171 in CONTEXT_DATA: text attachment mode. */
+    textAttachment?: number;
+    /** Group code 172 in CONTEXT_DATA: text flow direction. */
+    textFlowDirection?: number;
+    /** Group code 344 (common) / 341 (CONTEXT_DATA): block content ID. */
+    blockContentId?: string;
+    /** Group code 93: block content color (DXF raw int32). */
+    blockContentColor?: number;
+    /** Group code 10: block content scale. */
+    blockContentScale?: DwgPoint3D;
+    /** Group code 43: block content rotation. */
+    blockContentRotation?: number;
+    /** Group code 176: block content connection type. */
+    blockContentConnectionType?: number;
+    /** Group code 293: enable annotation scale. */
+    annotativeScaleEnabled?: boolean;
+    /** Group code pair 94 + 345 (repeated). */
+    arrowheadOverrides?: DwgMultiLeaderIndexedHandle[];
+    /** Repeated block attribute override entries. */
+    blockAttributes?: DwgMultiLeaderBlockAttribute[];
+    /** Group code 294: text direction negative flag. */
+    textDirectionNegative?: boolean;
+    /** Group code 178: text align in IPE flag/value. */
+    textAlignInIPE?: number;
+    /** Group code 179: text attachment point. */
+    textAttachmentPoint?: number;
+    /** Group code 271: text attachment direction for MText content. */
+    textAttachmentDirection?: number;
+    /** Group code 273: bottom text attachment direction. */
+    bottomTextAttachmentDirection?: number;
+    /** Group code 272: top text attachment direction. */
+    topTextAttachmentDirection?: number;
+    /** CONTEXT_DATA group code 40: content scale. */
+    contentScale?: number;
+    /** CONTEXT_DATA group codes 10/20/30: content base position. */
+    contentBasePosition?: DwgPoint3D;
+    /** CONTEXT_DATA group codes 11/21/31: text normal direction vector. */
+    normal?: DwgPoint3D;
+    /** CONTEXT_DATA group codes 41 and 44: text height. */
+    textHeight?: number;
+    /** CONTEXT_DATA group code 42: text rotation. */
+    textRotation?: number;
+    /** CONTEXT_DATA group code 43: text width. */
+    textWidth?: number;
+    /** CONTEXT_DATA group code 45: text line spacing factor. */
+    textLineSpacingFactor?: number;
+    /** CONTEXT_DATA group code 170: text line spacing style. */
+    textLineSpacingStyle?: number;
+    /** CONTEXT_DATA group codes 12/22/32: text location (anchor point). */
+    textAnchor?: DwgPoint3D;
+    /** CONTEXT_DATA group codes 13/23/33: text direction vector. */
+    textDirection?: DwgPoint3D;
+    /** CONTEXT_DATA group code 91: text background color (DXF raw int32). */
+    textBackgroundColor?: number;
+    /** CONTEXT_DATA group code 141: text background scale factor. */
+    textBackgroundScaleFactor?: number;
+    /** CONTEXT_DATA group code 92: text background transparency. */
+    textBackgroundTransparency?: number;
+    /** CONTEXT_DATA group code 291: text background color on/off. */
+    textBackgroundColorOn?: boolean;
+    /** CONTEXT_DATA group code 292: text background fill on/off. */
+    textFillOn?: boolean;
+    /** CONTEXT_DATA group code 173: text column type. */
+    textColumnType?: number;
+    /** CONTEXT_DATA group code 293: use text auto height. */
+    textUseAutoHeight?: boolean;
+    /** CONTEXT_DATA group code 142: text column width. */
+    textColumnWidth?: number;
+    /** CONTEXT_DATA group code 143: text column gutter width. */
+    textColumnGutterWidth?: number;
+    /** CONTEXT_DATA group code 294: text column flow reversed. */
+    textColumnFlowReversed?: boolean;
+    /** CONTEXT_DATA group code 144: text column height. */
+    textColumnHeight?: number;
+    /** CONTEXT_DATA group code 295: use word break for text columns. */
+    textUseWordBreak?: boolean;
+    /** CONTEXT_DATA group code 304: default/actual text content. */
+    textContent?: string;
+    /** CONTEXT_DATA group code 290: has MText content flag. */
+    hasMText?: boolean;
+    /** CONTEXT_DATA group code 296: has block content flag. */
+    hasBlock?: boolean;
+    /** CONTEXT_DATA block content bundle. */
+    blockContent?: DwgMultiLeaderBlockContent;
+    /** CONTEXT_DATA group codes 110/120/130: MLeader plane origin point. */
+    planeOrigin?: DwgPoint3D;
+    /** CONTEXT_DATA group codes 111/121/131: MLeader plane X-axis direction. */
+    planeXAxisDirection?: DwgPoint3D;
+    /** CONTEXT_DATA group codes 112/122/132: MLeader plane Y-axis direction. */
+    planeYAxisDirection?: DwgPoint3D;
+    /** CONTEXT_DATA group code 297: plane normal reversed flag. */
+    planeNormalReversed?: boolean;
+    /** CONTEXT_DATA nested LEADER sections. */
+    leaderSections?: DwgMultiLeaderLeaderSection[];
+}
+export interface DwgMultiLeaderLeaderSection {
+    lastLeaderLinePoint?: DwgPoint3D;
+    lastLeaderLinePointSet?: boolean;
+    doglegVector?: DwgPoint3D;
+    doglegVectorSet?: boolean;
+    doglegLength?: number;
+    breaks?: DwgMultiLeaderBreak[];
+    leaderBranchIndex?: number;
+    leaderLines: DwgMultiLeaderLeaderLine[];
+}
+export interface DwgMultiLeaderLeaderLine {
+    vertices: DwgPoint3D[];
+    breakPointIndexes?: number[];
+    leaderLineIndex?: number;
+    breaks?: DwgMultiLeaderBreak[];
+}
+export interface DwgMultiLeaderBreak {
+    index?: number;
+    start: DwgPoint3D;
+    end: DwgPoint3D;
+}
+export interface DwgMultiLeaderIndexedHandle {
+    index: number;
+    handle: string;
+}
+export interface DwgMultiLeaderBlockAttribute {
+    id?: string;
+    index?: number;
+    width?: number;
+    text?: string;
+}
+export interface DwgMultiLeaderBlockContent {
+    blockContentId?: string;
+    normal?: DwgPoint3D;
+    position?: DwgPoint3D;
+    scale?: DwgPoint3D;
+    rotation?: number;
+    color?: number;
+    transformationMatrix?: number[];
+}
+//# sourceMappingURL=multileader.d.ts.map

package/lib/database/entities/multileader.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=multileader.js.map

package/lib/database/entities/shape.d.ts

@@ -0,0 +1,50 @@
+import { DwgPoint3D } from '../common';
+import { DwgEntity } from './entity';
+export interface DwgShapeEntity extends DwgEntity {
+    /**
+     * Entity type
+     */
+    type: 'SHAPE';
+    /**
+     * DXF subclass marker
+     */
+    subclassMarker: 'AcDbShape';
+    /**
+     * Thickness (optional; default = 0)
+     */
+    thickness: number;
+    /**
+     * Insertion point (in OCS)
+     */
+    insertionPoint: DwgPoint3D;
+    /**
+     * Size
+     */
+    size: number;
+    /**
+     * Shape number (DXF group 2): index of the shape within the shape file, not
+     * the shape file or text style name.
+     */
+    shapeNumber: number;
+    /**
+     * The text style name that references the SHX font for this shape.
+     */
+    styleName: string;
+    /**
+     * Rotation angle (optional; default = 0)
+     */
+    rotation: number;
+    /**
+     * Relative X scale factor (optional; default = 1)
+     */
+    xScale: number;
+    /**
+     * Oblique angle (optional; default = 0)
+     */
+    obliqueAngle: number;
+    /**
+     * Extrusion direction (optional; default = 0, 0, 1)
+     */
+    extrusionDirection: DwgPoint3D;
+}
+//# sourceMappingURL=shape.d.ts.map

package/lib/database/entities/shape.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=shape.js.map

package/lib/database/objects/index.d.ts

@@ -2,6 +2,7 @@ export * from './common';
 export * from './dictionary';
 export * from './imageDef';
 export * from './layout';
+export * from './mleaderStyle';
 export * from './plotSetting';
 export * from './spatialFilter';
 //# sourceMappingURL=index.d.ts.map

package/lib/database/objects/index.js

@@ -2,6 +2,7 @@ export * from './common';
 export * from './dictionary';
 export * from './imageDef';
 export * from './layout';
+export * from './mleaderStyle';
 export * from './plotSetting';
 export * from './spatialFilter';
 //# sourceMappingURL=index.js.map

package/lib/database/objects/mleaderStyle.d.ts

@@ -0,0 +1,101 @@
+import { DwgPoint3D } from '../common';
+import { DwgCommonObject } from './common';
+/**
+ * MLEADERSTYLE object fields mapped from AutoCAD DXF group codes.
+ *
+ * Reference:
+ * - https://help.autodesk.com/cloudhelp/2016/ENU/AutoCAD-DXF/files/GUID-0E489B69-17A4-4439-8505-9DCE032100B4.htm
+ * - https://github.com/mlightcad/dxf-json/blob/main/src/parser/objects/mleaderStyle/types.ts
+ */
+export interface DwgMLeaderStyleObject extends DwgCommonObject {
+    subclassMarker: 'AcDbMLeaderStyle';
+    /** Group code 179: undocumented value observed in AutoCAD-generated objects. */
+    unknown1?: number;
+    /** Group code 170: content type used by this MLeader style. */
+    contentType?: number;
+    /** Group code 171: draw MLeader order type. */
+    drawMLeaderOrderType?: number;
+    /** Group code 172: draw leader order type. */
+    drawLeaderOrderType?: number;
+    /** Group code 90: max leader segment points. */
+    maxLeaderSegmentPoints?: number;
+    /** Group code 40: first segment angle constraint. */
+    firstSegmentAngleConstraint?: number;
+    /** Group code 41: second segment angle constraint. */
+    secondSegmentAngleConstraint?: number;
+    /** Group code 173: leader line type. */
+    leaderLineType?: number;
+    /** Group code 91: leader line color (DXF raw int32). */
+    leaderLineColor?: number;
+    /** Group code 340: leader line type ID (handle reference). */
+    leaderLineTypeId?: string;
+    /** Group code 92: leader line weight. */
+    leaderLineWeight?: number;
+    /** Group code 290: enable landing. */
+    landingEnabled?: boolean;
+    /** Group code 42: landing gap. */
+    landingGap?: number;
+    /** Group code 291: enable dogleg. */
+    doglegEnabled?: boolean;
+    /** Group code 43: dogleg length. */
+    doglegLength?: number;
+    /** Group code 3: MLeader style description. */
+    description?: string;
+    /** Group code 341: arrowhead ID (handle reference). */
+    arrowheadId?: string;
+    /** Group code 44: arrowhead size. */
+    arrowheadSize?: number;
+    /** Group code 300: default MText contents. */
+    defaultMTextContents?: string;
+    /** Group code 342: MText style ID (handle reference). */
+    textStyleId?: string;
+    /** Group code 174: text left attachment type. */
+    textLeftAttachmentType?: number;
+    /** Group code 175: text angle type. */
+    textAngleType?: number;
+    /** Group code 176: text alignment type. */
+    textAlignmentType?: number;
+    /** Group code 178: text right attachment type. */
+    textRightAttachmentType?: number;
+    /** Group code 93: text color (DXF raw int32). */
+    textColor?: number;
+    /** Group code 45: text height. */
+    textHeight?: number;
+    /** Group code 292: enable frame text. */
+    textFrameEnabled?: boolean;
+    /** Group code 297: text align always left. */
+    textAlignAlwaysLeft?: boolean;
+    /** Group code 46: align space. */
+    alignSpace?: number;
+    /** Group code 343: block content ID (handle reference). */
+    blockContentId?: string;
+    /** Group code 94: block content color (DXF raw int32). */
+    blockContentColor?: number;
+    /** Group codes 47/49/140: block content scale on X/Y/Z axes. */
+    blockContentScale?: DwgPoint3D;
+    /** Group code 293: enable block content scale. */
+    blockContentScaleEnabled?: boolean;
+    /** Group code 141: block content rotation. */
+    blockContentRotation?: number;
+    /** Group code 294: enable block content rotation. */
+    blockContentRotationEnabled?: boolean;
+    /** Group code 177: block content connection type. */
+    blockContentConnectionType?: number;
+    /** Group code 142: scale. */
+    scale?: number;
+    /** Group code 295: overwrite property value flag. */
+    overwritePropertyValue?: boolean;
+    /** Group code 296: annotative flag. */
+    annotative?: boolean;
+    /** Group code 143: break gap size. */
+    breakGapSize?: number;
+    /** Group code 271: text attachment direction for MText content. */
+    textAttachmentDirection?: number;
+    /** Group code 272: bottom text attachment direction. */
+    bottomTextAttachmentDirection?: number;
+    /** Group code 273: top text attachment direction. */
+    topTextAttachmentDirection?: number;
+    /** Group code 298: undocumented flag observed in AutoCAD-generated objects. */
+    unknown2?: boolean;
+}
+//# sourceMappingURL=mleaderStyle.d.ts.map

package/lib/database/objects/mleaderStyle.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=mleaderStyle.js.map

package/lib/libredwg.d.ts

@@ -143,6 +143,35 @@ export declare class LibreDwg {
      * @returns Returns 1 if set absref value correctly. Otherwise, return 0.
      */
     dwg_resolve_handleref(ref_ptr: Dwg_Object_Ref_Ptr, obj_ptr: Dwg_Object_Ptr): number;
+    /**
+     * Returns the absolute handle reference of one Dwg_Object_Ref instance.
+     * @group Handle Conversion Methods
+     * @returns Returns null when the reference or absolute_ref is absent.
+     */
+    dwg_ref_get_absref(ref_ptr: Dwg_Object_Ref_Ptr): number | null;
+    /**
+     * Returns the handle value of one Dwg_Object_Ref instance.
+     * @group Handle Conversion Methods
+     * @returns Returns null when the reference or handle value is absent.
+     */
+    dwg_ref_get_handle_value(ref_ptr: Dwg_Object_Ref_Ptr): bigint | null;
+    /**
+     * Returns the absolute_ref of one Dwg_Object_Ref instance as bigint.
+     * @group Handle Conversion Methods
+     * @returns Returns null when the reference or absolute_ref is absent.
+     */
+    dwg_ref_get_handle_absolute_ref(ref_ptr: Dwg_Object_Ref_Ptr): bigint | null;
+    /**
+     * Returns the handle value of one Dwg_Object instance.
+     * @group Handle Conversion Methods
+     * @returns Returns null when the object or handle value is absent.
+     */
+    dwg_obj_get_handle_value(obj_ptr: Dwg_Object_Ptr): bigint | null;
+    /**
+     * Returns the absolute_ref of one Dwg_Object_Ref as uppercase hex handle id.
+     * @group Handle Conversion Methods
+     */
+    dwg_ref_get_id(ref_ptr: Dwg_Object_Ref_Ptr): string | undefined;
     /**
      * Returns object (such as line type, layer name, dimension style, and etc.) name by its handle.
      * @group Handle Conversion Methods
@@ -504,6 +533,11 @@ export declare class LibreDwg {
      * @returns Returns the field value of one object or entity.
      */
     dwg_dynapi_entity_value(obj: Dwg_Object_Object_TIO_Ptr | Dwg_Object_Entity_TIO_Ptr, field: string): Dwg_Field_Value;
+    /**
+     * Returns the decoded field data of one object or entity.
+     * @group Dynamic API Methods
+     */
+    dwg_dynapi_entity_data<T>(obj: Dwg_Object_Object_TIO_Ptr | Dwg_Object_Entity_TIO_Ptr, field: string): T;
     /**
      * Header field value getter. Used to get the field value of dwg/dxf header.
      * @group Dynamic API Methods
@@ -512,6 +546,11 @@ export declare class LibreDwg {
      * @returns Returns the field value of dwg/dxf header.
      */
     dwg_dynapi_header_value(data: Dwg_Data_Ptr, field: string): Dwg_Field_Value;
+    /**
+     * Returns the field data of dwg/dxf header.
+     * @group Dynamic API Methods
+     */
+    dwg_dynapi_header_data<T>(data: Dwg_Data_Ptr, field: string): T;
     /**
      * The common field value getter. Used to get the value of object or entity common fields.
      * @group Dynamic API Methods
@@ -520,6 +559,11 @@ export declare class LibreDwg {
      * @returns Returns the value of object or entity common fields.
      */
     dwg_dynapi_common_value(obj: Dwg_Object_Object_TIO_Ptr | Dwg_Object_Entity_TIO_Ptr, field: string): Dwg_Field_Value;
+    /**
+     * Returns the field data of object or entity common fields.
+     * @group Dynamic API Methods
+     */
+    dwg_dynapi_common_data<T>(obj: Dwg_Object_Object_TIO_Ptr | Dwg_Object_Entity_TIO_Ptr, field: string): T;
     /**
      * The field of one object or entity may not be primitive type. It means one field may consist of
      * multiple sub-fields. This method is used to get the sub-field value of those complex field.
@@ -530,6 +574,23 @@ export declare class LibreDwg {
      * @returns Returns the sub-field value of one complex field.
      */
     dwg_dynapi_subclass_value(obj: Dwg_Object_Object_TIO_Ptr | Dwg_Object_Entity_TIO_Ptr, subclass: string, field: string): Dwg_Field_Value;
+    /**
+     * Returns the sub-field data of one complex field.
+     * @group Dynamic API Methods
+     */
+    dwg_dynapi_subclass_data<T>(obj: Dwg_Object_Object_TIO_Ptr | Dwg_Object_Entity_TIO_Ptr, subclass: string, field: string): T;
+    /**
+     * Returns the struct size of a dynapi subclass.
+     */
+    dwg_dynapi_subclass_size(subclass: string): number;
+    /**
+     * Returns the byte offset of a field within an entity struct.
+     */
+    dwg_dynapi_entity_field_offset(entity: Dwg_Object_Entity_TIO_Ptr, field: string): number;
+    /**
+     * Returns the byte offset of a field within a dynapi subclass struct.
+     */
+    dwg_dynapi_subclass_field_offset(subclass: string, field: string): number;
     /**
      * Returns the handle of one Dwg_Object instance.
      * @group Dwg_Object Methods