ofs-dxf-ts 1.0.0

package/dist/core/dxf-document.d.ts

@@ -0,0 +1,220 @@
+/**
+ * DxfDocument — Core document class with template parsing.
+ *
+ * ✅ Works in both Node.js AND Browser/Angular environments.
+ *
+ * Every document is built on a base DXF: a user template, or the built-in
+ * blank DXF R2018 document when created from scratch. New layers, linetypes,
+ * text styles, blocks, images and layouts are injected into that base on
+ * output, so both modes produce the same, complete R2000+ structure.
+ *
+ * Usage (Node.js):
+ *   const doc = DxfDocument.readFile('./template/template2018.dxf');
+ *   doc.saveas('output.dxf');
+ *
+ * Usage (Browser/Angular):
+ *   const doc = DxfDocument.fromString(templateDxfString);
+ *   const dxfOutput = doc.toDxfString();
+ *   // download via Blob, or send to server
+ *
+ * Usage (from scratch — both environments):
+ *   const doc = DxfDocument.create();
+ *   doc.addLayer('MyLayer', 7, 'CONTINUOUS');
+ *   const msp = doc.modelspace();
+ *   msp.add_circle([50, 50], 25);
+ *   const output = doc.toDxfString();
+ */
+import { Modelspace } from './modelspace.js';
+import { LayerDef, DxfEntity, GeoReferenceDef, LayoutDef } from './dxf-entities.js';
+export declare class DxfDocument {
+    private _layers;
+    private _linetypes;
+    private _styles;
+    private _blocks;
+    private _msp;
+    private _layouts;
+    /** Upper-cased layout name → entity collector for that layout. */
+    private _paperspaces;
+    private _rawSections;
+    private _templateBlockNames;
+    private _templateLayerNames;
+    private _templateStyleNames;
+    private _templateLayoutNames;
+    private _parsedTemplate;
+    private constructor();
+    /**
+     * Read a DXF file from disk (Node.js only).
+     * @throws Error if called in browser environment.
+     */
+    static readFile(filePath: string): DxfDocument;
+    /**
+     * Parse a DXF template from a string.
+     * ✅ Works in both Node.js and Browser/Angular.
+     */
+    static fromString(content: string): DxfDocument;
+    /**
+     * Create a blank DXF document (DXF R2018, meters).
+     * ✅ Works in both Node.js and Browser/Angular.
+     */
+    static create(): DxfDocument;
+    /** Get the modelspace for adding entities. */
+    modelspace(): Modelspace;
+    /** Add or update a layer. */
+    addLayer(name: string, color?: number, linetype?: string): void;
+    /** Check if a layer exists. */
+    hasLayer(name: string): boolean;
+    /** Get layer definition. */
+    getLayer(name: string): LayerDef | undefined;
+    /** Access layers as a record (backward compat). */
+    get layers(): Record<string, LayerDef>;
+    /**
+     * Add a text style. For Thai text use a TrueType font file name,
+     * e.g. `addTextStyle('THAI', 'THSarabunNew.ttf')`.
+     * Styles that already exist in the base document are kept as they are.
+     */
+    addTextStyle(name: string, font: string, height?: number): void;
+    /** ezdxf-compatible styles.new() */
+    get styles(): {
+        new: (name: string, dxfattribs: {
+            font: string;
+        }) => void;
+    };
+    /**
+     * Add a linetype definition. Pattern values are in drawing units:
+     * positive = dash, negative = gap, 0 = dot.
+     * Linetypes that already exist in the base document are kept as they are.
+     */
+    addLineType(name: string, description: string, pattern: number[]): void;
+    private _geoRef;
+    /**
+     * Set geographic coordinate reference for the drawing.
+     * This embeds coordinate system info into the DXF HEADER.
+     *
+     * @example
+     *   // UTM Zone 47N (Thailand)
+     *   doc.setGeoReference({
+     *       crsId: 'EPSG:32647',
+     *       designPoint: [0, 0],
+     *       referencePoint: [600000, 1700000],  // Easting, Northing
+     *       northDirection: 0,
+     *       scaleFactor: 1,
+     *       coordinateType: 2,  // projected
+     *   });
+     */
+    setGeoReference(geoRef: GeoReferenceDef): void;
+    /** Get the geo reference definition (if set). */
+    get geoReference(): GeoReferenceDef | null;
+    /**
+     * Add a Paper Space layout for plotting.
+     * Paper space units are mm; the origin is the lower-left corner of the
+     * printable area (inside the margins), as in AutoCAD.
+     *
+     * @example
+     *   doc.addLayout({
+     *       name: 'A1',
+     *       paperWidth: 841,   // mm
+     *       paperHeight: 594,  // mm
+     *       margins: [0, 0, 0, 0],
+     *       viewports: [{
+     *           center: [420, 297],
+     *           width: 800, height: 560,
+     *           viewCenter: [519500, 1033500],
+     *           scale: 12500,               // 1:12,500 — model in meters
+     *           frozenLayers: ['GRID'],
+     *       }]
+     *   });
+     */
+    addLayout(layout: LayoutDef): void;
+    /** Get all layout definitions added with addLayout(). */
+    get layouts(): LayoutDef[];
+    /** Names of all layouts: those of the base document (incl. "Model") and added ones. */
+    get layoutNames(): string[];
+    /** Check if a layout exists (case-insensitive). */
+    hasLayout(name: string): boolean;
+    /**
+     * Entity collector for a layout: an existing layout of the base document
+     * (e.g. "Layout1") or one added with addLayout(). "Model" returns model space.
+     */
+    paperspace(name: string): Modelspace;
+    /**
+     * Define (or redefine) a block. Entity coordinates are block-local,
+     * relative to `basePoint`.
+     */
+    addBlockDefinition(name: string, entities: DxfEntity[], basePoint?: [number, number]): void;
+    /** Check if a block exists (in template or user-defined). */
+    hasBlock(name: string): boolean;
+    /** Get all block names. */
+    getBlockNames(): string[];
+    /** Freeze a layer (entities on this layer are hidden and ignored). */
+    freezeLayer(name: string): void;
+    /** Thaw a layer (undo freeze). */
+    thawLayer(name: string): void;
+    /** Lock a layer (entities visible but not editable). */
+    lockLayer(name: string): void;
+    /** Unlock a layer. */
+    unlockLayer(name: string): void;
+    /** Turn a layer off (entities hidden but still selectable). */
+    setLayerOff(name: string): void;
+    /** Turn a layer on. */
+    setLayerOn(name: string): void;
+    /** Set layer color. */
+    setLayerColor(name: string, color: number): void;
+    /** Set layer linetype. */
+    setLayerLinetype(name: string, linetype: string): void;
+    private _headerVars;
+    /**
+     * Set a HEADER variable (replaces the base document's value).
+     * @example doc.setHeaderVar('$INSUNITS', [{ code: 70, value: '6' }]); // Meters
+     */
+    setHeaderVar(name: string, values: {
+        code: number;
+        value: string;
+    }[]): void;
+    /**
+     * Set the drawing extents (bounding box).
+     * This controls the initial zoom-to-extents view in CAD software.
+     * Equivalent to ezdxf: doc.header['$EXTMIN'] / doc.header['$EXTMAX']
+     */
+    setExtents(minX: number, minY: number, maxX: number, maxY: number): void;
+    /**
+     * Auto-calculate extents from all entities in modelspace.
+     * Scans all entity coordinates and sets $EXTMIN/$EXTMAX accordingly.
+     */
+    zoomExtents(padding?: number): void;
+    /**
+     * Set the view center and height (zoom level) for the initial view.
+     * Equivalent to ezdxf setting $VIEWCTR and $VIEWSIZE.
+     */
+    setViewCenter(x: number, y: number, viewHeight?: number): void;
+    /**
+     * Zoom to a specific window (rectangle).
+     */
+    zoomWindow(minX: number, minY: number, maxX: number, maxY: number): void;
+    /** Access the HEADER vars map (used by serializer). */
+    get headerVars(): Map<string, {
+        code: number;
+        value: string;
+    }[]>;
+    /**
+     * Calculate bounding box of all entities in modelspace.
+     */
+    private _calculateBounds;
+    setActiveLayer(_name: string): void;
+    drawPolyline(points: [number, number][], closed?: boolean): void;
+    drawCircle(cx: number, cy: number, radius: number): void;
+    drawText(x: number, y: number, height: number, rotation: number, text: string): void;
+    /** Serialize to DXF string. ✅ Works everywhere. */
+    toDxfString(): string;
+    /**
+     * Save to file (Node.js only).
+     * @throws Error if called in browser environment.
+     */
+    saveas(filePath: string): void;
+    /**
+     * Download DXF file in browser.
+     * ✅ Works in Browser/Angular.
+     */
+    downloadAs(filename: string): void;
+    private _loadBase;
+    private _addDefaultLinetypes;
+}