freesewing/markdown/dev/reference/api/config/options/pct/en.md

title
percentage

Percentage options are the bread and butter of freesewing. Almost all your options will most likely be percentage options as they ensure that your pattern will scale regardless of size.

Structure

Your percentage option should be a plain object with these properties:

• pct : The default percentage
• min : The minimum percentage that's allowed
• max : The maximum percentage that's allowed
• hide (optional) : A method to control the optional display of the option
• fromAbs (optional) : A method to determine the percentage based on a value in millimeter
• toAbs (optional) : A method to return the option value in millimeter
• snap (optional) : The configuration to control snapping of percentage options

Percentage options will be divided by 100 when loaded

You specify percentages in your config file. For example, 50 means 50%. When your configuration is loaded, those percentages will be divided by 100.

So a percentage of 50 in your config file will be 0.5 when you read out that option in your pattern.

Percentage options are not limited to the range 0-100

The minimum and maximum (and default) percentages are not restricted to the range from 0% to 100%. A percentage option that spans from -25% to 135% is just as valid.

Example

Below is a simple example:

options: {
  acrossBackFactor: { 
    pct:  97, 
    min:  93, 
    max: 100 
  }
}

Advanced use

Percentage options have a few more tricks up their sleeve: