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

carta_preferences_2
Schema for CARTA Preferences (Version 2)
properties
version	The version of the preferences contained
	type	integer
	maximum	2
	minimum	1
username	type	string
	minLength	1
theme	type	string
	enum	auto, light, dark
autoLaunch	type	boolean
fileSortingString	type	string
	pattern	^([+\-])(date|filename|type|size)$
fileFilteringType	type	string
	enum	fuzzy, unix, regex
layout	type	string
cursorPosition	type	string
	enum	fixed, tracking
zoomMode	type	string
	enum	fit, full
zoomPoint	type	string
	enum	cursor, center
dragPanning	type	boolean
spectralMatchingType	type	string
	enum	VRAD, VOPT, FREQ, WAVE, AWAV, CHANNEL
wcsMatchingType	type	integer
	maximum	3
	minimum	0
transparentImageBackground	type	boolean
scaling	type	integer
	maximum	7
	minimum	0
colormap	type	string
percentile	type	number
	exclusiveMaximum	100
	exclusiveMinimum	0
scalingAlpha	type	number
	minimum	1
scalingGamma	type	number
	exclusiveMinimum	0
nanColorHex	TODO: validate color string
	type	string
nanAlpha	type	number
	maximum	1
	minimum	0
useSmoothedBiasContrast	type	boolean
contourGeneratorType	type	string
	enum	start-step-multiplier, min-max-scaling, percentages-ref.value, mean-sigma-list
contourSmoothingMode	type	integer
	maximum	2
	minimum	0
contourSmoothingFactor	type	integer
	minimum	0
contourNumLevels	type	integer
	minimum	1
contourThickness	type	number
	minimum	0
contourColormapEnabled	type	boolean
contourColor	TODO: validate color string
	type	string
contourColormap	type	string
astColor	TODO: validate color string
	type	string
astGridVisible	type	boolean
astLabelsVisible	type	boolean
wcsType	type	string
	enum	automatic, degrees, sexagesimal
colorbarVisible	type	boolean
colorbarInteractive	type	boolean
colorbarPosition	type	string
	enum	right, top, bottom
colorbarWidth	type	integer
	maximum	100
	minimum	1
colorbarTicksDensity	type	number
	maximum	20
	minimum	0.2
colorbarLabelVisible	type	boolean
beamVisible	type	boolean
beamColor	type	string
beamType	type	string
	enum	open, solid
beamWidth	type	number
	minimum	0
regionColor	TODO: validate color string
	type	string
regionLineWidth	type	number
	minimum	0
regionDashLength	type	integer
	minimum	0
regionType	type	integer
	maximum	6
	minimum	0
regionCreationMode	type	string
	enum	center, corner
regionSize	type	number
	minimum	1
imageCompressionQuality	type	integer
	maximum	32
	minimum	4
animationCompressionQuality	type	integer
	maximum	32
	minimum	4
GPUTileCache	type	integer
	multipleOf	256
	minimum	1024
systemTileCache	type	integer
	multipleOf	128
	minimum	1024
contourDecimation	type	integer
	maximum	32
	minimum	1
contourCompressionLevel	type	integer
	maximum	19
	minimum	0
contourChunkSize	type	integer
	multipleOf	25000
	maximum	1000000
	minimum	25000
contourControlMapWidth	type	integer
	multipleOf	128
	maximum	1024
	minimum	128
streamContoursWhileZooming	type	boolean
lowBandwidthMode	type	boolean
stopAnimationPlayback	type	integer
	maximum	30
	minimum	5
pixelGridVisible	type	boolean
pixelGridColor	type	string
codeSnippetsEnabled	type	boolean
limitOverlayRedraw	type	boolean
	default	True
cursorInfoVisible	type	string
	enum	always, activeImage, hideTiled, never
	default	activeImage
keepLastUsedFolder	type	boolean
	default	False
lastUsedFolder	type	string
	default
imageMultiPanelEnabled	type	boolean
	default	False
imagePanelMode	type	string
	enum	dynamic, fixed
	default	dynamic
imagePanelColumns	type	number
	minimum	1
	default	2
imagePanelRows	type	number
	minimum	1
	default	2
statsPanelEnabled	type	boolean
	default	False
statsPanelMode	type	integer
	minimum	0
	default	0
fileFilterMode	type	string
	enum	content, extension, all
	default	content