Api - exporter Namespace

Index

Interfaces

Variables

svgUnit

Functions

Object literals

colors

Variables

svgUnit

svgUnit: svgUnitConversion

Map of MakerJs unit system to SVG unit system

Functions

chainToSVGPathData

chainToSVGPathData(chain: IChain, offset: IPoint, accuracy?: number): string

- Defined in src/maker.js/packages/maker.js/src/core/svg.ts:78
Convert a chain to SVG path data.

Parameters
- chain: IChain
  
  Chain to convert.
- offset: IPoint
  
  IPoint relative offset point.
- Optional accuracy: number
  
  Optional accuracy of SVG path data.
Returns string

String of SVG path data.

pathToSVGPathData

pathToSVGPathData(pathToExport: IPath, pathOffset: IPoint, exportOffset: IPoint, accuracy?: number, clockwiseCircle?: boolean): string

- Defined in src/maker.js/packages/maker.js/src/core/svg.ts:177
Export a path to SVG path data.

Parameters
- pathToExport: IPath
  
  IPath to export.
- pathOffset: IPoint
  
  IPoint relative offset of the path object.
- exportOffset: IPoint
  
  IPoint relative offset point of the export.
- Optional accuracy: number
  
  Optional accuracy of SVG path data.
- Optional clockwiseCircle: boolean
  
  Optional flag to use clockwise winding for circles.
Returns string

String of SVG path data.

toDXF

toDXF(modelToExport: IModel, options?: IDXFRenderOptions): string
toDXF(pathsToExport: IPath[], options?: IDXFRenderOptions): string
toDXF(pathToExport: IPath, options?: IDXFRenderOptions): string

- Defined in src/maker.js/packages/maker.js/src/core/dxf.ts:3
Renders an item in AutoDesk DFX file format.

Parameters
- modelToExport: IModel
- Optional options: IDXFRenderOptions
  
  Rendering options object.
Returns string

String of DXF content.
- Defined in src/maker.js/packages/maker.js/src/core/dxf.ts:4
Renders an item in AutoDesk DFX file format.

Parameters
- pathsToExport: IPath[]
- Optional options: IDXFRenderOptions
Returns string

String of DXF content.
- Defined in src/maker.js/packages/maker.js/src/core/dxf.ts:5
Renders an item in AutoDesk DFX file format.

Parameters
- pathToExport: IPath
- Optional options: IDXFRenderOptions
Returns string

String of DXF content.

toJscadCAG

toJscadCAG(jscadCAG: typeof CAG, modelToExport: IModel, jsCadCagOptions?: IJscadCagOptions): CAG | object

- Defined in src/maker.js/packages/maker.js/src/core/openjscad.ts:183
Converts a model to a @jscad/csg CAG object - 2D to 2D. See https://en.wikibooks.org/wiki/OpenJSCAD_User_Guide#2D_Paths

Example:
```
//First, use npm install @jscad/csg from the command line in your jscad project
//Create a CAG instance from a model.
var { CAG } = require('@jscad/csg');
var model = new makerjs.models.Ellipse(70, 40);
var cag = makerjs.exporter.toJscadCAG(CAG, model, {maxArcFacet: 1});
```
Parameters
- jscadCAG: typeof CAG
  
  @jscad/csg CAG engine, see https://www.npmjs.com/package/@jscad/csg
- modelToExport: IModel
  
  Model object to export.
- Optional jsCadCagOptions: IJscadCagOptions
Returns CAG | object

jscad CAG object in 2D, or a map (keyed by layer id) of jscad CAG objects - if options.byLayers is true.

toJscadCSG

toJscadCSG(jscadCAG: typeof CAG, modelToExport: IModel, options?: IJscadCsgOptions): CSG

- Defined in src/maker.js/packages/maker.js/src/core/openjscad.ts:320
Converts a model to a @jscad/csg CSG object - 2D to 3D.

Example:
```
//First, use npm install @jscad/csg from the command line in your jscad project
//Create a CSG instance from a model.
var { CAG } = require('@jscad/csg');
var model = new makerjs.models.Ellipse(70, 40);
var csg = makerjs.exporter.toJscadCSG(CAG, model, {maxArcFacet: 1, extrude: 10});
```
Parameters
- jscadCAG: typeof CAG
  
  @jscad/csg CAG engine, see https://www.npmjs.com/package/@jscad/csg
- modelToExport: IModel
  
  Model object to export.
- Optional options: IJscadCsgOptions
  
  Optional options object.
Returns CSG

jscad CAG object in 2D, or a map (keyed by layer id) of jscad CAG objects - if options.byLayers is true.

toJscadSTL

toJscadSTL(CAG: typeof CAG, stlSerializer: StlSerializer, modelToExport: IModel, options?: IJscadCsgOptions): string | ArrayBuffer[]

- Defined in src/maker.js/packages/maker.js/src/core/openjscad.ts:458
Exports a model in STL format - 2D to 3D.

Parameters
- CAG: typeof CAG
- stlSerializer: StlSerializer
  
  @jscad/stl-serializer, see https://www.npmjs.com/package/@jscad/stl-serializer
- modelToExport: IModel
  
  Model object to export.
- Optional options: IJscadCsgOptions
  
  Optional options object.
Returns string | ArrayBuffer[]

String in STL ASCII format.

toJscadScript

toJscadScript(modelToExport: IModel, options?: IJscadScriptOptions): string

- Defined in src/maker.js/packages/maker.js/src/core/openjscad.ts:405
Creates a string of JavaScript code for execution with a Jscad environment.

Parameters
- modelToExport: IModel
  
  Model object to export.
- Default value options: IJscadScriptOptions = {}
  
  Export options object.
Returns string

String of JavaScript containing a main() function for Jscad.

toJson

toJson(itemToExport: any, options?: IJsonExportOptions): string

- Defined in src/maker.js/packages/maker.js/src/core/exporter.ts:39
Renders an item in JSON.

Parameters
- itemToExport: any
  
  Item to render: may be a path, an array of paths, or a model object.
- Default value options: IJsonExportOptions = {}
  
  Rendering options object.
Returns string

String of DXF content.

toPDF

toPDF(doc: PDFDocument, modelToExport: IModel, options?: IPDFRenderOptions): void

- Defined in src/maker.js/packages/maker.js/src/core/pdf.ts:11
Injects drawing into a PDFKit document.

Parameters
- doc: PDFDocument
  
  PDFKit.PDFDocument object. See https://pdfkit.org/
- modelToExport: IModel
  
  Model object to export.
- Optional options: IPDFRenderOptions
  
  Export options object.
Returns void

String of PDF file contents.

toSVG

toSVG(modelToExport: IModel, options?: ISVGRenderOptions): string
toSVG(pathsToExport: IPath[], options?: ISVGRenderOptions): string
toSVG(pathToExport: IPath, options?: ISVGRenderOptions): string

- Defined in src/maker.js/packages/maker.js/src/core/svg.ts:300
Renders an item in SVG markup.

Parameters
- modelToExport: IModel
- Optional options: ISVGRenderOptions
  
  Rendering options object.
Returns string

String of XML / SVG content.
- Defined in src/maker.js/packages/maker.js/src/core/svg.ts:301
Renders an item in SVG markup.

Parameters
- pathsToExport: IPath[]
- Optional options: ISVGRenderOptions
Returns string

String of XML / SVG content.
- Defined in src/maker.js/packages/maker.js/src/core/svg.ts:302
Renders an item in SVG markup.

Parameters
- pathToExport: IPath
- Optional options: ISVGRenderOptions
Returns string

String of XML / SVG content.

toSVGPathData

toSVGPathData(modelToExport: IModel, options?: ISVGPathDataRenderOptions): IPathDataByLayerMap | string
toSVGPathData(modelToExport: IModel, byLayers?: boolean, origin?: IPoint, accuracy?: number): IPathDataByLayerMap | string

- Defined in src/maker.js/packages/maker.js/src/core/svg.ts:247
Convert a model to SVG path data.

Parameters
- modelToExport: IModel
  
  Model to export.
- Optional options: ISVGPathDataRenderOptions
  
  Optional ISVGPathDataRenderOptions object.
Returns IPathDataByLayerMap | string

String of SVG path data (if options.byLayers is false) or an object map of path data by layer .
- Defined in src/maker.js/packages/maker.js/src/core/svg.ts:258
Convert a model to SVG path data.

Parameters
- modelToExport: IModel
  
  Model to export.
- Optional byLayers: boolean
  
  Optional boolean flag to return a map of path data by layer.
- Optional origin: IPoint
  
  Optional origin. Default x = 0, y = topmost y point in the model. Use [0, 0] to use the same origin as Maker.js, which will translate to negative Y values in SVG.
- Optional accuracy: number
  
  Optional accuracy of SVG decimals.
Returns IPathDataByLayerMap | string

String of SVG path data (if byLayers is false) or an object map of path data by layer .

Object literals

colors

colors: object

Named colors, safe for CSS and DXF 17 colors from https://www.w3.org/TR/CSS21/syndata.html#value-def-color mapped to DXF equivalent AutoDesk Color Index

aqua

aqua: number

black

black: number

blue

blue: number

fuchsia

fuchsia: number

gray

gray: number

green

green: number

lime

lime: number

maroon

maroon: number

navy

navy: number

olive

olive: number

orange

orange: number

purple

purple: number

red

red: number

silver

silver: number

teal

teal: number

white

white: number

yellow

yellow: number

Generated using TypeDoc

Api - exporter Namespace

Index

Interfaces

Variables

Functions

Object literals

Variables

svgUnit

Functions

chainToSVGPathData

Parameters

chain: IChain

offset: IPoint

Optional accuracy: number

Returns string

pathToSVGPathData

Parameters

pathToExport: IPath

pathOffset: IPoint

exportOffset: IPoint

Optional accuracy: number

Optional clockwiseCircle: boolean

Returns string

toDXF

Parameters

modelToExport: IModel

Optional options: IDXFRenderOptions

Returns string

Parameters

pathsToExport: IPath[]

Optional options: IDXFRenderOptions

Returns string

Parameters

pathToExport: IPath

Optional options: IDXFRenderOptions

Returns string

toJscadCAG

Parameters

jscadCAG: typeof CAG

modelToExport: IModel

Optional jsCadCagOptions: IJscadCagOptions

Returns CAG | object

toJscadCSG

Parameters

jscadCAG: typeof CAG

modelToExport: IModel

Optional options: IJscadCsgOptions

Returns CSG

toJscadSTL

Parameters

CAG: typeof CAG

stlSerializer: StlSerializer

modelToExport: IModel

Optional options: IJscadCsgOptions

Returns string | ArrayBuffer[]

toJscadScript

Parameters

modelToExport: IModel

Default value options: IJscadScriptOptions = {}

Returns string

toJson

Parameters

itemToExport: any

Default value options: IJsonExportOptions = {}

Returns string

toPDF

Parameters

doc: PDFDocument

modelToExport: IModel

Optional options: IPDFRenderOptions

Returns void

toSVG

Parameters

modelToExport: IModel

Optional options: ISVGRenderOptions

Returns string

Parameters

pathsToExport: IPath[]

Optional options: ISVGRenderOptions

Returns string