Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

dxf

3.3.1 • Public • Published

Build Status

dxf

DXF parser for node/browser.

Uses several ES6 features in the source code (import, classes, let, const, arrows) but is packaged using babel so you can use it legacy JS environments.

Version 2.0 is a complete rewrite from the first attempt to write it in a SAX style, which wasn't really appropriate for a document with nested references (e.g inserts referencing blocks, nested inserts).

Version 3.0 converted the codebase to use standard JS, ES6 imports, stop using Gulp, and updated & removed some dependencies.

At this point in time, the important geometric entities are supported, but notably:

  • MTEXT
  • DIMENSION
  • STYLE

and some others are parsed, but are not supported for SVG rendering (see section below on SVG rendering)

Getting started

There is an ES5 and ES6 example in the examples/ directory that show how to use the library, but there are 3 basic steps:

  1. Parse the DXF contents using dxf.parseString(<contents>). This will return an object representation of the DXF contents.
  2. Denormalise the entities into an array using dxf.denormalise(<parsed>). After Step 1, the entities are still in the block hierarchy of the DXF file, denormalising will create the resulting entities with the block transforms applied.
  3. (Optional) Create an SVG using dxf.toSVG(<parsed>, <options>). Please refer to the SVG section below regarding limitations. Options supported are interpolationsPerSplineSegment, with default = 25, e.g. dxf.toSVG(<parsed>, {interpolationsPerSplineSegment: 10})

Running the Examples

Node ES5: $ node examples/example.es5.js

Node ES6: $ babel-node examples/example.es6.js

Browser: $ open examples/dxf.html

SVG

The initial aim of this library was to support rendering of the main geometric components, not dimensions, text, hatches and styles. There is a mechanism for converting the parsed entities to SVG, but they are all converted to polylines, and if you look at the resulting SVG files when running the functional tests, you will see that all entities are rendered as paths.

Here's an example you will find in the functional test output:

svg example image

Command line

There is a command-line utility (courtesy of @Joge97) for converting DXF files to SVG:

$ npm i -g dxf
$ dxf-to-svg

  Usage: dxf-to-svg [options] <dxfFile> [svgFile]

  Converts a dxf file to a svg file.

  Options:

    -V, --version  output the version number
    -v --verbose   Verbose output
    -h, --help     output usage information

Tests

Running

$ npm test

will execute the unit tests and functional tests, which generate SVGs for reference DXF files. You can view these SVGs (located in test/functional/output) in a browser or other SVG viewer to see what is supported.

Contributors

Keywords

install

npm i dxf

Downloadsweekly downloads

127

version

3.3.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability