Reference

You can find a list of all FreeSewing reference documentation below:

Main sections

• Backend REST API
• CSS Classes
• Core API
• Lifecycle hooks
• Macros
• Measurements
• Packages
• Plugins
• Settings
• Sites
• Snippets
• Store Methods
• Terminology
• Web of Trust

Full list

• Backend REST API

  • API Keys

    • Create an API key
    • Delete an API key
    • Read an API key
    • Read the current API key
  • Access control
  • Account

    • Confirm an account
    • Create an account
    • MFA
    • Sign In
    • Update account
  • Authentication
  • Patterns

    • Clone a Pattern
    • Create a Pattern
    • Delete a Pattern
    • Read a Pattern
    • Update a Pattern
  • People

    • Clone a Person
    • Create a Person
    • Delete a Person
    • Read a Person
    • Update a Person
• CSS Classes
• Core API

  • 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.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.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.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()
• Lifecycle hooks

  • insertText
  • postDraft
  • postInit
  • postLayout
  • postPartDraft
  • postRender
  • postSample
  • postSetDraft
  • preDraft
  • preInit
  • preLayout
  • prePartDraft
  • preRender
  • preSample
  • preSetDraft
• Macros

  • banner
  • bannerBox
  • bartack
  • bartackAlong
  • bartackFractionAlong
  • crossBox
  • cutOnFold
  • flip
  • gore
  • grainline
  • hd
  • ld
  • miniScale
  • mirror
  • pd
  • pleat
  • ringSector
  • rmBanner
  • rmBannerBox
  • rmBartack
  • rmBartackAlong
  • rmBartackFractionAlong
  • rmCrossBox
  • rmCutOnFold
  • rmGrainline
  • rmHd
  • rmLd
  • rmMiniScale
  • rmPd
  • rmPleat
  • rmRingSector
  • rmScaleBox
  • rmSewTogether
  • rmTitle
  • rmVd
  • rmaD
  • rmaHd
  • rmaLd
  • rmaPd
  • rmaVd
  • round
  • scalebox
  • sewTogether
  • sprinkle
  • title
  • vd
• Measurements
• Packages

  • models
  • new-design
  • prettier-config
  • react-components
  • rehype-highlight-lines
  • rehype-jargon
  • snapseries
• Plugins

  • core-plugins
  • plugin-annotations
  • plugin-bust
  • plugin-flip
  • plugin-gore
  • plugin-i18n
  • plugin-measurements
  • plugin-mirror
  • plugin-ringsector
  • plugin-round
  • plugin-sprinkle
  • plugin-svgattr
  • plugin-theme
  • plugin-timing
  • plugin-versionfree-svg
• Settings

  • absoluteOptions
  • complete
  • embed
  • idPrefix
  • layout
  • locale
  • margin
  • measurements
  • only
  • options
  • paperless
  • sa
  • sample
  • scale
  • stackPrefix
  • units
• Sites

  • Sanity
• Snippets

  • bnotch
  • button
  • buttonhole
  • buttonhole-end
  • buttonhole-start
  • eyelet
  • logo
  • notch
  • snap-socket
  • snap-stud
• Store Methods

  • cutlist.addCut()
  • cutlist.removeCut()
  • cutlist.setCutOnFold()
  • cutlist.setGrain()
  • flag.error()
  • flag.fixme()
  • flag.info()
  • flag.note()
  • flag.preset()
  • flag.tip()
  • flag.warn()
  • generateMacroIds()
  • getMacroIds()
  • log.debug()
  • log.error()
  • log.info()
  • log.warn()
  • pack()
  • removeMacroNodes()
  • storeMacroIds()
  • unflag.error()
  • unflag.fixme()
  • unflag.info()
  • unflag.note()
  • unflag.preset()
  • unflag.tip()
  • unflag.warn()
• Terminology

  • Variadic
  • cjs
  • esm
• Web of Trust