LanguageValues and typesStandard typesMedia and visual
AspectRatio
On this page
Width to height in whole numbers: 16:9.
Use it for screens, images and video. 16:9 and 32:18 stay two different values. For a ratio of any two numbers, use Ratio.
Shape
| Field | Type | Required? |
|---|---|---|
width |
Int |
Yes |
height |
Int |
Yes |
Example
AspectRatio { width: 16 height: 9 }text.parse(raw, as: AspectRatio) reads one from text that comes from outside. Text that isn't one at all fails malformed, such as 16/9, 1.85:1 or 0:1.
Good to know
- Decimals are refused, so
1.85:1is written185:100here. ==tells you whether two are the same.<andlist.sort_bydon't take it, so sort by one of its parts instead.
In JSON
A string, in a request, a response or json.write:
"16:9""4:3""1:1"
Details
Text form, storage, how it is shown, and operations
AspectRatio is in the group Media and visual, and has been in Jadpo since 0.1.0.
Text form
text.from writes one standard text form, the same form text.parse reads back: 16:9, 4:3 and 1:1.
How it is stored
It is stored in 2 columns, each named for the field, _ and its suffix. This is 1:1:
| Column | Type | Holds |
|---|---|---|
<field>_width |
integer |
1 |
<field>_height |
integer |
1 |
How it is shown to people
text.format(value, locale:) shows it to people in their locale.
With locale: Locale.en_gb:
| Value | Shown |
|---|---|
16:9 |
16:9 |
4:3 |
4:3 |
1:1 |
1:1 |
32:18 |
32:18 |
239:100 |
239:100 |
Operations
It also takes text.parse, text.from, text.format, json.read, json.write and ==. How every standard type behaves says how they work.
Markdown for agents: /docs/types/type-aspect-ratio.md.Built from Jadpo main at aee2e8f.