sample

The sample setting holds an object that is used by pass information to the [Pattern.sample()][1] method. [1]: /reference/api/pattern/sample

Signature

const settings = {
  Object sample = {}
}

Example

import { Aaron } from "@freesewing/aaron"

const pattern = new Aaron({
  settings = {
    Object sample = {
      type: 'option',
      option: 'headEase',
    }
  }
})

Notes

The sample setting object can hold the following properties:

• type: One of option, measurement, or models
• option: An option name as defined in the pattern config file (only used when type is option).
• measurement: A measurement name as defined in the pattern config file (only used when type is measurement).
• models: A plain object of different models where the key is the model name and the value an object with the required measurements.

RELATED

Please see the [Pattern.sample()][1] documentation for more information about pattern sampling.