Core API

This is the documentation for FreeSewing’s core library, published as @freesewing/core on NPM. It’s a complete toolbox for parametric design with a primary focus on sewing patterns, but can be utilized for a variety of similar 2D design tasks.

Core API Documentation

• Attributes

  • Attributes.add()
  • Attributes.asPropsIfPrefixIs()
  • Attributes.asRenderProps()
  • Attributes.clone()
  • Attributes.get()
  • Attributes.getAsArray()
  • Attributes.remove()
  • Attributes.render()
  • Attributes.renderAsCss()
  • Attributes.renderIfPrefixIs()
  • Attributes.set()
  • Attributes.setIfUnset()
• Defs

  • Defs.asRenderProps()
  • Defs.clone()
  • Defs.get()
  • Defs.remove()
  • Defs.render()
  • Defs.set()
  • Defs.setIfUnset()
• Design
• Part

  • Part.asRenderProps()
  • Part.attr()
  • Part.getId()
  • Part.hide()
  • Part.setHidden()
  • Part.shorthand()
  • Part.unhide()
  • Part.units()
  • Parts: Configuration

    • Assigning parts to stacks
    • Hiding parts
    • Naming parts
    • Part dependencies
    • Part measurements
    • Part options

      • Boolean options
      • Constant options
      • Counter options
      • Degree options
      • Extending options
      • List options
      • Millimeter options
      • Percentage options

        • Reporting a percentage option value in millimeter
        • Setting a value in millimeter as a percentage option
        • Snapped percentage options
    • Part plugins
  • The part's draft method
• Path

  • Path._curve()
  • Path.addClass()
  • Path.addText()
  • Path.angleAt()
  • Path.asPathString()
  • Path.asRenderProps()
  • Path.attr()
  • Path.bbox()
  • Path.clean()
  • Path.clone()
  • Path.close()
  • Path.combine()
  • Path.curve()
  • Path.curve_()
  • Path.divide()
  • Path.edge()
  • Path.end()
  • Path.hide()
  • Path.insop()
  • Path.intersects()
  • Path.intersectsX()
  • Path.intersectsY()
  • Path.join()
  • Path.length()
  • Path.line()
  • Path.move()
  • Path.noop()
  • Path.offset()
  • Path.reverse()
  • Path.rotate()
  • Path.roughLength()
  • Path.setClass()
  • Path.setHidden()
  • Path.setText()
  • Path.shiftAlong()
  • Path.shiftFractionAlong()
  • Path.smurve()
  • Path.smurve_()
  • Path.split()
  • Path.start()
  • Path.translate()
  • Path.trim()
  • Path.unhide()
• Pattern

  • Pattern.addPart()
  • Pattern.draft()
  • Pattern.draftPartForSet()
  • Pattern.getConfig()
  • Pattern.getLogs()
  • Pattern.getRenderProps()
  • Pattern.on()
  • Pattern.render()
  • Pattern.sample()
  • Pattern.sampleMeasurement()
  • Pattern.sampleModels()
  • Pattern.sampleOption()
  • Pattern.use()
• Point

  • Point.addCircle()
  • Point.addText()
  • Point.angle()
  • Point.asRenderProps()
  • Point.attr()
  • Point.clone()
  • Point.copy()
  • Point.dist()
  • Point.dx()
  • Point.dy()
  • Point.flipX()
  • Point.flipY()
  • Point.rotate()
  • Point.setCircle()
  • Point.setText()
  • Point.shift()
  • Point.shiftFractionTowards()
  • Point.shiftOutwards()
  • Point.shiftTowards()
  • Point.sitsOn()
  • Point.sitsRoughlyOn()
  • Point.slope()
  • Point.translate()
• Snippet

  • Snippet.asRenderProps()
  • Snippet.attr()
  • Snippet.clone()
  • Snippet.rotate()
  • Snippet.scale()
• Stack

  • Stack.addPart()
  • Stack.asRenderProps()
  • Stack.attr()
  • Stack.generateTransform()
  • Stack.getAnchor()
  • Stack.getPartList()
  • Stack.getPartNames()
  • Stack.home()
• Store

  • Store.extend()
  • Store.get()
  • Store.logs
  • Store.push()
  • Store.set()
  • Store.setIfUnset()
  • Store.unset()
• Svg

  • Svg.asRenderProps()
  • Svg.attributes
  • Svg.defs
  • Svg.layout
  • Svg.pattern
  • Svg.render()
  • Svg.style
• utils

  • utils.applyTransformToPoint()
  • utils.beamIntersectsCircle()
  • utils.beamIntersectsCurve()
  • utils.beamIntersectsX()
  • utils.beamIntersectsY()
  • utils.beamsIntersect()
  • utils.capitalize()
  • utils.circlesIntersect()
  • utils.combineTransform()
  • utils.curveEdge()
  • utils.curveIntersectsX()
  • utils.curveIntersectsY()
  • utils.curveParameterFromPoint()
  • utils.curvesIntersect()
  • utils.deg2rad()
  • utils.generateStackTransform()
  • utils.getTransformedBounds()
  • utils.lineIntersectsCircle()
  • utils.lineIntersectsCurve()
  • utils.linesIntersect()
  • utils.mergeI18n()
  • utils.mergeOptions()
  • utils.pctBasedOn()
  • utils.pointOnBeam()
  • utils.pointOnCurve()
  • utils.pointOnLine()
  • utils.rad2deg()
  • utils.round()
  • utils.splitCurve()
  • utils.stretchToScale()
  • utils.units()

Named exports

In general, software published under the FreeSewing namespaces prefers named exports over default exports, and the @freesewing/core package provides several of them. I have grouped them below in different categories:

• Constructors
• Constants
• Utilities

Constructors

Constants

const quarterCircle = new Path()
  .move(new Point(0, radius))
  .curve(new Point(cbqc, radius),
    new Point(radius, cbqc),
    new Point(radius, 0))

Utilities