@jscad/dxf-serializer
v2.1.19
Published
DXF Serializer for JSCAD
Downloads
1,815
Readme
@jscad/dxf-serializer
Serializer of JSCAD geometries to DXF entities
Overview
This serializer outputs a 'blobable' array of data from one or more JSCAD geometries. Currently, only DXF TEXT output is supported.
The array of data can either be used to create a Blob (new Blob(blobable)
), or converted to a Node.js buffer.
The serialization of the following geometries are possible.
- serialization of 2D geometry (geom2) to DXF LWPOLYLINE or POLYLINE
- serialization of 3D geometry (geom3) to DXF 3DFACE(s)
- serialization of 2D paths (path2) to DXF LWPOLYLINE or POLYINE
Table of Contents
Installation
npm install @jscad/dxf-serializer
Usage
const dxfSerializer = require('@jscad/dxf-serializer')
const rawData = dxfSerializer.serialize({}, geometry)
//in browser (with browserify etc)
const blob = new Blob(rawData)
Contributing
The various JSCAD packages and all source code are part of the JSCAD Organization, and maintained by a group of volunteers. We welcome and encourage anyone to pitch in but please take a moment to read the following guidelines.
If you want to submit a bug report please make sure to follow the Reporting Issues guide. Bug reports are accepted as Issues via GitHub.
If you want to submit a change or a patch, please read the Contributing Guide. New contributions are accepted as Pull Requests via GitHub.
We only accept bug reports and pull requests on GitHub.
If you have a question about how to use JSCAD, then please start a conversation at the JSCAD User Group. You might find the answer in the JSCAD User Guide.
If you have a change or new feature in mind, please start a conversation with the Core Developers and start contributing changes.
Small Note: If editing this README, please conform to the standard-readme specification.
License
The MIT License (MIT) (unless specified otherwise)