Appendix D: preferences schema#
The full preferences options are shown below. If you use an IDE to edit the “preferences.json”, tooltips may be available while you edit it. The following example is with Visual Studio Code.
Preferences#
Schema for CARTA Preferences (Version 2) |
|||
type |
object |
||
properties |
|||
|
The version of the preferences contained |
||
type |
integer |
||
maximum |
2 |
||
minimum |
1 |
||
|
enum |
auto, light, dark |
|
|
type |
boolean |
|
|
type |
string |
|
pattern |
^([+\-])(date|filename|type|size)$ |
||
|
enum |
fuzzy, unix, regex |
|
|
type |
string |
|
|
enum |
fixed, tracking |
|
|
enum |
fit, full |
|
|
enum |
cursor, center |
|
|
type |
boolean |
|
|
enum |
VRAD, VOPT, FREQ, WAVE, AWAV, CHANNEL |
|
|
type |
boolean |
|
|
type |
integer |
|
maximum |
7 |
||
minimum |
0 |
||
|
type |
string |
|
|
type |
number |
|
maximum |
100 |
||
minimum |
0 |
||
|
type |
number |
|
maximum |
1000000 |
||
minimum |
0.1 |
||
|
type |
number |
|
maximum |
2 |
||
minimum |
0.1 |
||
|
TODO: validate color string |
||
type |
string |
||
|
type |
number |
|
maximum |
1 |
||
minimum |
0 |
||
|
type |
boolean |
|
|
enum |
start-step-multiplier, min-max-scaling, percentages-ref.value, mean-sigma-list |
|
|
type |
integer |
|
maximum |
2 |
||
minimum |
0 |
||
|
type |
integer |
|
maximum |
33 |
||
minimum |
1 |
||
|
type |
integer |
|
maximum |
15 |
||
minimum |
1 |
||
|
type |
number |
|
maximum |
10 |
||
minimum |
0.5 |
||
|
type |
boolean |
|
|
TODO: validate color string |
||
type |
string |
||
|
type |
string |
|
|
type |
number |
|
maximum |
64 |
||
minimum |
0 |
||
default |
4 |
||
|
type |
boolean |
|
default |
False |
||
|
type |
number |
|
maximum |
10 |
||
minimum |
0.5 |
||
|
type |
boolean |
|
|
TODO: validate color string |
||
type |
string |
||
default |
#ffffff |
||
|
type |
string |
|
default |
viridis |
||
|
TODO: validate color string |
||
type |
string |
||
|
type |
boolean |
|
|
type |
boolean |
|
|
enum |
automatic, degrees, sexagesimal |
|
|
type |
boolean |
|
|
type |
boolean |
|
|
enum |
right, top, bottom |
|
|
type |
integer |
|
maximum |
100 |
||
minimum |
1 |
||
|
type |
number |
|
maximum |
20 |
||
minimum |
0.2 |
||
|
type |
boolean |
|
|
type |
boolean |
|
|
type |
string |
|
|
enum |
open, solid |
|
|
type |
number |
|
maximum |
10 |
||
minimum |
0.5 |
||
|
TODO: validate color string |
||
type |
string |
||
|
type |
number |
|
maximum |
10 |
||
minimum |
0.5 |
||
|
type |
integer |
|
maximum |
50 |
||
minimum |
0 |
||
|
enum |
0, 1, 2, 3, 4, 6 |
|
|
enum |
center, corner |
|
|
type |
number |
|
maximum |
100 |
||
minimum |
10 |
||
|
type |
integer |
|
maximum |
32 |
||
minimum |
1 |
||
|
type |
integer |
|
maximum |
32 |
||
minimum |
1 |
||
|
type |
integer |
|
multipleOf |
256 |
||
minimum |
256 |
||
|
type |
integer |
|
multipleOf |
256 |
||
minimum |
256 |
||
|
type |
integer |
|
maximum |
32 |
||
minimum |
1 |
||
|
type |
integer |
|
maximum |
19 |
||
minimum |
0 |
||
|
type |
integer |
|
minimum |
1000 |
||
|
type |
integer |
|
multipleOf |
128 |
||
minimum |
128 |
||
|
type |
boolean |
|
|
type |
boolean |
|
|
type |
number |
|
minimum |
0 |
||
|
type |
boolean |
|
|
type |
string |
|
|
type |
boolean |
|
|
type |
boolean |
|
default |
True |
||
|
enum |
always, activeImage, hideTiled, never |
|
default |
activeImage |
||
|
type |
boolean |
|
default |
False |
||
|
type |
string |
|
default |
|||
|
type |
boolean |
|
default |
False |
||
|
enum |
dynamic, fixed |
|
default |
dynamic |
||
|
type |
number |
|
minimum |
1 |
||
default |
2 |
||
|
type |
number |
|
minimum |
1 |
||
default |
2 |
||
|
type |
boolean |
|
default |
False |
||
|
type |
integer |
|
minimum |
0 |
||
default |
0 |
||
|
type |
string |
|
|
enum |
none, minimal, usage |
|
default |
usage |
||
|
type |
boolean |
|
default |
False |
||
|
type |
boolean |
|
default |
False |
||
|
enum |
content, extension, all |
|
default |
content |
||
|
type |
boolean |
|
|
type |
integer |
|
maximum |
7 |
||
minimum |
0 |
||
|
type |
string |
|
|
type |
string |
|
|
type |
boolean |
|
|
type |
boolean |
|
|
type |
object |
|
|
type |
string |
|
|
type |
number |
|
maximum |
10 |
||
minimum |
0.5 |
||
|
type |
number |
|
maximum |
50 |
||
minimum |
0 |
||
|
type |
integer |
|
maximum |
7 |
||
minimum |
0 |
||
|
type |
number |
|
maximum |
100 |
||
minimum |
1 |
||
|
type |
number |
|
maximum |
10 |
||
minimum |
0.5 |
||
|
PV preview cube size limit, in GB. |
||
type |
number |
||
minimum |
0.1 |
||
|
This is a deprecated preference. |
||
enum |
TB, GB, MB, kB, B |
||
|
type |
array |
|
items |
type |
number |
|
|
type |
number |
|
minimum |
1 |
||
|
type |
string |
|
|
type |
boolean |
|
|
type |
string |
|
|
type |
boolean |
|