title | excerpt | layout |
---|---|---|
fromInches |
Converts a number from inches to the current default unit. |
manual |
WARNING: This function is deprecated.
Converts a number from inches to the current default unit.
DEPRECATED prefer using explicit numeric suffixes (e.g., 42inch
) or the to...
conversion functions.
No matter what units the current file uses, this function will always return a number equivalent to the input in inches.
For example, if the current file uses inches, fromInches(1)
will return 1
. If the current file uses millimeters, fromInches(1)
will return 25.4
.
Caution: This function is only intended to be used when you absolutely MUST have different units in your code than the file settings. Otherwise, it is a bad pattern to use this function.
We merely provide these functions for convenience and readability, as fromInches(10)
is more readable that your intent is "I want 10 inches" than 10 * 25.4
, if the file settings are in millimeters.
fromInches(input: number): number
units
Name | Type | Description | Required |
---|---|---|---|
input |
number |
Yes |
totalWidth = fromInches(10)