Appendix D: preferences schema

Contents

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#

https://cartavis.org/schemas/preferences_schema_2.json

Schema for CARTA Preferences (Version 2)

type

object

properties

  • version

The version of the preferences contained

type

integer

maximum

2

minimum

1

  • theme

enum

auto, light, dark

  • autoLaunch

type

boolean

  • fileSortingString

type

string

pattern

^([+\-])(date|filename|type|size)$

  • fileFilteringType

enum

fuzzy, unix, regex

  • layout

type

string

  • cursorPosition

enum

fixed, tracking

  • zoomMode

enum

fit, full

  • zoomPoint

enum

cursor, center

  • dragPanning

type

boolean

  • spectralMatchingType

enum

VRAD, VOPT, FREQ, WAVE, AWAV, CHANNEL

  • transparentImageBackground

type

boolean

  • scaling

type

integer

maximum

7

minimum

0

  • colormap

type

string

  • percentile

type

number

maximum

100

minimum

0

  • scalingAlpha

type

number

maximum

1000000

minimum

0.1

  • scalingGamma

type

number

maximum

2

minimum

0.1

  • nanColorHex

TODO: validate color string

type

string

  • nanAlpha

type

number

maximum

1

minimum

0

  • useSmoothedBiasContrast

type

boolean

  • contourGeneratorType

enum

start-step-multiplier, min-max-scaling, percentages-ref.value, mean-sigma-list

  • contourSmoothingMode

type

integer

maximum

2

minimum

0

  • contourSmoothingFactor

type

integer

maximum

33

minimum

1

  • contourNumLevels

type

integer

maximum

15

minimum

1

  • contourThickness

type

number

maximum

10

minimum

0.5

  • contourColormapEnabled

type

boolean

  • contourColor

TODO: validate color string

type

string

  • contourColormap

type

string

  • vectorOverlayPixelAveraging

type

number

maximum

64

minimum

0

default

4

  • vectorOverlayFractionalIntensity

type

boolean

default

False

  • vectorOverlayThickness

type

number

maximum

10

minimum

0.5

  • vectorOverlayColormapEnabled

type

boolean

  • vectorOverlayColor

TODO: validate color string

type

string

default

#ffffff

  • vectorOverlayColormap

type

string

default

viridis

  • astColor

TODO: validate color string

type

string

  • astGridVisible

type

boolean

  • astLabelsVisible

type

boolean

  • wcsType

enum

automatic, degrees, sexagesimal

  • colorbarVisible

type

boolean

  • colorbarInteractive

type

boolean

  • colorbarPosition

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

enum

open, solid

  • beamWidth

type

number

maximum

10

minimum

0.5

  • regionColor

TODO: validate color string

type

string

  • regionLineWidth

type

number

maximum

10

minimum

0.5

  • regionDashLength

type

integer

maximum

50

minimum

0

  • regionType

enum

0, 1, 2, 3, 4, 6

  • regionCreationMode

enum

center, corner

  • regionSize

type

number

maximum

100

minimum

10

  • imageCompressionQuality

type

integer

maximum

32

minimum

1

  • animationCompressionQuality

type

integer

maximum

32

minimum

1

  • GPUTileCache

type

integer

multipleOf

256

minimum

256

  • systemTileCache

type

integer

multipleOf

256

minimum

256

  • contourDecimation

type

integer

maximum

32

minimum

1

  • contourCompressionLevel

type

integer

maximum

19

minimum

0

  • contourChunkSize

type

integer

minimum

1000

  • contourControlMapWidth

type

integer

multipleOf

128

minimum

128

  • streamContoursWhileZooming

type

boolean

  • lowBandwidthMode

type

boolean

  • stopAnimationPlaybackMinutes

type

number

minimum

0

  • pixelGridVisible

type

boolean

  • pixelGridColor

type

string

  • codeSnippetsEnabled

type

boolean

  • limitOverlayRedraw

type

boolean

default

True

  • cursorInfoVisible

enum

always, activeImage, hideTiled, never

default

activeImage

  • keepLastUsedFolder

type

boolean

default

False

  • lastUsedFolder

type

string

default

  • imageMultiPanelEnabled

type

boolean

default

False

  • imagePanelMode

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

  • telemetryUuid

type

string

  • telemetryMode

enum

none, minimal, usage

default

usage

  • telemetryConsentShown

type

boolean

default

False

  • telemetryLogging

type

boolean

default

False

  • fileFilterMode

enum

content, extension, all

default

content

  • pvAxesOrderReverse

type

boolean

  • autoWCSMatching

type

integer

maximum

7

minimum

0

  • colormapHex

type

string

  • colormapHexStart

type

string

  • dynamicLayoutEnable

type

boolean

  • isHighDimPriority

type

boolean

  • dynamicLayout

type

object

  • annotationColor

type

string

  • annotationLineWidth

type

number

maximum

10

minimum

0.5

  • annotationDashLength

type

number

maximum

50

minimum

0

  • pointAnnotationShape

type

integer

maximum

7

minimum

0

  • pointAnnotationWidth

type

number

maximum

100

minimum

1

  • textAnnotationLineWidth

type

number

maximum

10

minimum

0.5

  • pvPreviewCubeSizeLimit

PV preview cube size limit, in GB.

type

number

minimum

0.1

  • pvPreviewCubeSizeLimitUnit

This is a deprecated preference.

enum

TB, GB, MB, kB, B

  • logEventList

type

array

items

type

number

  • catalogDisplayedColumnSize

type

number

minimum

1

  • catalogTableSeparatorPosition

type

string

  • checkNewRelease

type

boolean

  • latestRelease

type

string

  • compatibilityAipsBeamSupport

type

boolean