flag.preset()

The flag.preset() method is a way to flag a pre-defined flag object. There are currently two such pre-defined flags provided by the annotations-plugin:

  • expandIsOn
  • expandIsOff

They inform the user about the effect of the expand setting on the pattern, when expand is on or off respectively.

Signature

Javascript
undefined Store.flag.preset(string preset)

Since these methods are not part of FreeSewing’s core API, what you pass to this method does depend on your own implementation. The example above is from our implementation, which uses the following properties:

Configuration

PropertyTypeDescription
presetStringThe ID of an existing preset

Example

Javascript
({ store, expand,  part }) => {
  store.flag.preset(expand
    ? 'expandIsOn'
    : 'expandIsOff'
  )

  return part
}