PreferenceStore

The store manages the preference setting

Index

Properties

• isPreferenceReady
• preferences

Accessors

• animationCompressionQuality
• annotationColor
• annotationDashLength
• annotationLineWidth
• astColor
• autoWCSMatching
• beamColor
• beamType
• beamWidth
• catalogDisplayedColumnSize
• catalogTableSeparatorPosition
• colorbarPosition
• colorbarTicksDensity
• colorbarWidth
• colormap
• colormapHex
• colormapHexStart
• contourChunkSize
• contourColor
• contourColormap
• contourCompressionLevel
• contourControlMapWidth
• contourDecimation
• contourGeneratorType
• contourNumLevels
• contourSmoothingFactor
• contourSmoothingMode
• contourThickness
• cursorInfoVisible
• cursorPosition
• enabledLoggingEventNames
• existLayoutMapping
• fileFilteringType
• fileFilterMode
• fileSortingString
• gpuTileCache
• hasAipsBeamSupport
• hasTelemetryConsentShown
• hasTransparentImageBackground
• imageCompressionQuality
• imagePanelColumns
• imagePanelMode
• imagePanelRows
• isAstGridVisible
• isAstLabelsVisible
• isBeamVisible
• isCodeSnippetsEnabled
• isColorbarInteractive
• isColorbarLabelVisible
• isColorbarVisible
• isContourColormapEnabled
• isCursorFrozen
• isDragPanning
• isDynamicLayoutEnabled
• isHighDimPriority
• isImageMultiPanelEnabled
• isLowBandwidthMode
• isPixelGridVisible
• isPVAxesOrderReverse
• isRegionCornerMode
• isSelectingAllLogEvents
• isSelectingIndeterminateLogEvents
• isStatsPanelEnabled
• isTelemetryLogging
• isVectorOverlayColormapEnabled
• isVectorOverlayFractionalIntensity
• isZoomRAWMode
• lastUsedFolder
• latestRelease
• layout
• nanAlpha
• nanColorHex
• percentile
• pixelGridColor
• pointAnnotationShape
• pointAnnotationWidth
• pvPreviewCubeSizeLimit
• regionColor
• regionCreationMode
• regionDashLength
• regionLineWidth
• regionSize
• regionType
• scaling
• scalingAlpha
• scalingGamma
• shouldAutoLaunch
• shouldAutoSelectImageOverlayCoordinateColumns
• shouldCheckNewRelease
• shouldKeepLastUsedFolder
• shouldLimitOverlayRedraw
• shouldStreamContoursWhileZooming
• shouldUseSmoothedBiasContrast
• spectralMatchingType
• statsPanelMode
• stopAnimationPlaybackMinutes
• systemTileCache
• telemetryMode
• telemetryUuid
• textAnnotationLineWidth
• theme
• vectorOverlayColor
• vectorOverlayColormap
• vectorOverlayPixelAveraging
• vectorOverlayThickness
• wcsType
• zoomMode
• zoomPoint
• Instance

Methods

• clearPreferences
• fetchPreferences
• isEventLoggingEnabled
• isWCSMatchingEnabled
• resetAnnotationSettings
• resetCatalogSettings
• resetCompatibilitySettings
• resetContourConfigSettings
• resetGlobalSettings
• resetLayoutSettings
• resetLogEventSettings
• resetOverlayConfigSettings
• resetPerformanceSettings
• resetRegionSettings
• resetRenderConfigSettings
• resetSilentSettings
• resetTelemetrySettings
• resetVectorOverlayConfigSettings
• selectAllLogEvents
• setPreference

Properties

isPreferenceReady

isPreferenceReady: boolean = false

Whether the preference data is initialized from the preference file or localStorage.

preferences

preferences: Map<PreferenceKeys, any> = ...

Accessors

animationCompressionQuality

• get animationCompressionQuality(): number

• Returns number

annotationColor

• get annotationColor(): string

• Returns string

annotationDashLength

• get annotationDashLength(): number

• Returns number

annotationLineWidth

• get annotationLineWidth(): number

• Returns number

astColor

• get astColor(): string

• Returns string

autoWCSMatching

• get autoWCSMatching(): WCSMatchingType

• Returns WCSMatchingType

beamColor

• get beamColor(): string

• Returns string

beamType

• get beamType(): BeamType

• Returns BeamType

beamWidth

• get beamWidth(): number

• Returns number

catalogDisplayedColumnSize

• get catalogDisplayedColumnSize(): number

• Returns number

catalogTableSeparatorPosition

• get catalogTableSeparatorPosition(): string

• Returns string

colorbarPosition

• get colorbarPosition(): right | top | bottom

• Returns right | top | bottom

colorbarTicksDensity

• get colorbarTicksDensity(): number

• Returns number

colorbarWidth

• get colorbarWidth(): number

• Returns number

colormap

• get colormap(): string

• Returns string

colormapHex

• get colormapHex(): string

• Returns string

colormapHexStart

• get colormapHexStart(): string

• Returns string

contourChunkSize

• get contourChunkSize(): number

• Returns number

contourColor

• get contourColor(): string

• Returns string

contourColormap

• get contourColormap(): string

• Returns string

contourCompressionLevel

• get contourCompressionLevel(): number

• Returns number

contourControlMapWidth

• get contourControlMapWidth(): number

• Returns number

contourDecimation

• get contourDecimation(): number

• Returns number

contourGeneratorType

• get contourGeneratorType(): ContourGeneratorType

• Returns ContourGeneratorType

contourNumLevels

• get contourNumLevels(): number

• Returns number

contourSmoothingFactor

• get contourSmoothingFactor(): number

• Returns number

contourSmoothingMode

• get contourSmoothingMode(): SmoothingMode

• Returns SmoothingMode

contourThickness

• get contourThickness(): number

• Returns number

cursorInfoVisible

• get cursorInfoVisible(): string

• Returns string

cursorPosition

• get cursorPosition(): string

• Returns string

enabledLoggingEventNames

• get enabledLoggingEventNames(): string[]

• Returns string[]

existLayoutMapping

• get existLayoutMapping(): {}

• Returns {}

  • [key string]: string

fileFilteringType

• get fileFilteringType(): FileFilteringType

• Returns FileFilteringType

fileFilterMode

• get fileFilterMode(): FileFilterMode

• Returns FileFilterMode

fileSortingString

• get fileSortingString(): string

• Returns string

gpuTileCache

• get gpuTileCache(): number

• Returns number

hasAipsBeamSupport

• get hasAipsBeamSupport(): boolean

• Returns boolean

hasTelemetryConsentShown

• get hasTelemetryConsentShown(): boolean

• Returns boolean

hasTransparentImageBackground

• get hasTransparentImageBackground(): boolean

• Returns boolean

imageCompressionQuality

• get imageCompressionQuality(): number

• Returns number

imagePanelColumns

• get imagePanelColumns(): number

• Returns number

imagePanelMode

• get imagePanelMode(): ImagePanelMode

• Returns ImagePanelMode

imagePanelRows

• get imagePanelRows(): number

• Returns number

isAstGridVisible

• get isAstGridVisible(): boolean

• Returns boolean

isAstLabelsVisible

• get isAstLabelsVisible(): boolean

• Returns boolean

isBeamVisible

• get isBeamVisible(): boolean

• Returns boolean

isCodeSnippetsEnabled

• get isCodeSnippetsEnabled(): boolean

• Returns boolean

isColorbarInteractive

• get isColorbarInteractive(): boolean

• Returns boolean

isColorbarLabelVisible

• get isColorbarLabelVisible(): boolean

• Returns boolean

isColorbarVisible

• get isColorbarVisible(): boolean

• Returns boolean

isContourColormapEnabled

• get isContourColormapEnabled(): boolean

• Returns boolean

isCursorFrozen

• get isCursorFrozen(): boolean

• Returns boolean

isDragPanning

• get isDragPanning(): boolean

• Returns boolean

isDynamicLayoutEnabled

• get isDynamicLayoutEnabled(): boolean

• Returns boolean

isHighDimPriority

• get isHighDimPriority(): boolean

• Returns boolean

isImageMultiPanelEnabled

• get isImageMultiPanelEnabled(): boolean

• Returns boolean

isLowBandwidthMode

• get isLowBandwidthMode(): boolean

• Returns boolean

isPixelGridVisible

• get isPixelGridVisible(): boolean

• Returns boolean

isPVAxesOrderReverse

• get isPVAxesOrderReverse(): boolean

• Returns boolean

isRegionCornerMode

• get isRegionCornerMode(): boolean

• Returns boolean

isSelectingAllLogEvents

• get isSelectingAllLogEvents(): boolean

• Returns boolean

isSelectingIndeterminateLogEvents

• get isSelectingIndeterminateLogEvents(): boolean

• Returns boolean

isStatsPanelEnabled

• get isStatsPanelEnabled(): boolean

• Returns boolean

isTelemetryLogging

• get isTelemetryLogging(): boolean

• Returns boolean

isVectorOverlayColormapEnabled

• get isVectorOverlayColormapEnabled(): boolean

• Returns boolean

isVectorOverlayFractionalIntensity

• get isVectorOverlayFractionalIntensity(): boolean

• Returns boolean

isZoomRAWMode

• get isZoomRAWMode(): boolean

• Returns boolean

lastUsedFolder

• get lastUsedFolder(): string

• Returns string

latestRelease

• get latestRelease(): string

• Returns string

layout

• get layout(): string

• Returns string

nanAlpha

• get nanAlpha(): number

• Returns number

nanColorHex

• get nanColorHex(): string

• Returns string

percentile

• get percentile(): number

• Returns number

pixelGridColor

• get pixelGridColor(): string

• Returns string

pointAnnotationShape

• get pointAnnotationShape(): PointAnnotationShape

• Returns PointAnnotationShape

pointAnnotationWidth

• get pointAnnotationWidth(): number

• Returns number

pvPreviewCubeSizeLimit

• get pvPreviewCubeSizeLimit(): number

• Returns number

regionColor

• get regionColor(): string

• Returns string

regionCreationMode

• get regionCreationMode(): string

• Returns string

regionDashLength

• get regionDashLength(): number

• Returns number

regionLineWidth

• get regionLineWidth(): number

• Returns number

regionSize

• get regionSize(): number

• Returns number

regionType

• get regionType(): RegionType

• Returns RegionType

scaling

• get scaling(): FrameScaling

• Returns FrameScaling

scalingAlpha

• get scalingAlpha(): number

• Returns number

scalingGamma

• get scalingGamma(): number

• Returns number

shouldAutoLaunch

• get shouldAutoLaunch(): boolean

• Returns boolean

shouldAutoSelectImageOverlayCoordinateColumns

• get shouldAutoSelectImageOverlayCoordinateColumns(): boolean

• Returns boolean

shouldCheckNewRelease

• get shouldCheckNewRelease(): boolean

• Returns boolean

shouldKeepLastUsedFolder

• get shouldKeepLastUsedFolder(): boolean

• Returns boolean

shouldLimitOverlayRedraw

• get shouldLimitOverlayRedraw(): boolean

• Returns boolean

shouldStreamContoursWhileZooming

• get shouldStreamContoursWhileZooming(): boolean

• Returns boolean

shouldUseSmoothedBiasContrast

• get shouldUseSmoothedBiasContrast(): boolean

• Returns boolean

spectralMatchingType

• get spectralMatchingType(): SpectralType

• Returns SpectralType

statsPanelMode

• get statsPanelMode(): number

• Returns number

stopAnimationPlaybackMinutes

• get stopAnimationPlaybackMinutes(): number

• Returns number

systemTileCache

• get systemTileCache(): number

• Returns number

telemetryMode

• get telemetryMode(): TelemetryMode

• Returns TelemetryMode

telemetryUuid

• get telemetryUuid(): string

• Returns string

textAnnotationLineWidth

• get textAnnotationLineWidth(): number

• Returns number

theme

• get theme(): string

• Returns string

vectorOverlayColor

• get vectorOverlayColor(): string

• Returns string

vectorOverlayColormap

• get vectorOverlayColormap(): string

• Returns string

vectorOverlayPixelAveraging

• get vectorOverlayPixelAveraging(): number

• Returns number

vectorOverlayThickness

• get vectorOverlayThickness(): number

• Returns number

wcsType

• get wcsType(): string

• Returns string

zoomMode

• get zoomMode(): string

• Returns string

zoomPoint

• get zoomPoint(): string

• Returns string

publicstaticInstance

• get Instance(): PreferenceStore

• Returns PreferenceStore

Methods

clearPreferences

• clearPreferences(keys: PreferenceKeys[]): Generator<Promise<any>, void, unknown>

• Clear the preference setting of the selecting key

  ---

  Parameters

  • keys: PreferenceKeys[]

    keys of PreferenceKeys

  Returns Generator<Promise<any>, void, unknown>

fetchPreferences

• fetchPreferences(): Generator<Promise<any>, void, unknown>

• Fetch the values of the preference keys

  ---

  Returns Generator<Promise<any>, void, unknown>

publicisEventLoggingEnabled

• isEventLoggingEnabled(eventType: EventType): boolean

• Parameters

  • eventType: EventType

  Returns boolean

publicisWCSMatchingEnabled

• isWCSMatchingEnabled(matchingType: WCSMatchingType): boolean

• Parameters

  • matchingType: WCSMatchingType

  Returns boolean

resetAnnotationSettings

• resetAnnotationSettings(): void

• Reset the annotation settings

  ---

  Returns void

resetCatalogSettings

• resetCatalogSettings(): void

• Reset the catalog settings

  ---

  Returns void

resetCompatibilitySettings

• resetCompatibilitySettings(): void

• Reset the compatibility settings

  ---

  Returns void

resetContourConfigSettings

• resetContourConfigSettings(): void

• Reset the contour configuration settings

  ---

  Returns void

resetGlobalSettings

• resetGlobalSettings(): void

• Reset the Global preference settings

  ---

  Returns void

resetLayoutSettings

• resetLayoutSettings(): void

• Reset the layout settings

  ---

  Returns void

resetLogEventSettings

• resetLogEventSettings(): void

• Reset the log event setting

  ---

  Returns void

resetOverlayConfigSettings

• resetOverlayConfigSettings(): void

• Reset the overlay configuration settings

  ---

  Returns void

resetPerformanceSettings

• resetPerformanceSettings(): void

• Reset the preference settings

  ---

  Returns void

resetRegionSettings

• resetRegionSettings(): void

• Reset the region settings

  ---

  Returns void

resetRenderConfigSettings

• resetRenderConfigSettings(): void

• Reset the render configuration settings

  ---

  Returns void

resetSilentSettings

• resetSilentSettings(): void

• Reset the Silent preference settings

  ---

  Returns void

resetTelemetrySettings

• resetTelemetrySettings(): void

• Reset the telemetry settings

  ---

  Returns void

resetVectorOverlayConfigSettings

• resetVectorOverlayConfigSettings(): void

• Reset the vector overlay configuration settings

  ---

  Returns void

selectAllLogEvents

• selectAllLogEvents(): void

• Reset the all log events

  ---

  Returns void

setPreference

• setPreference(key: PreferenceKeys, value: any): Generator<Promise<any>, any, unknown>

• Sets the preference parameter

  ---

  Parameters

  • key: PreferenceKeys

    The enum of PreferenceKeys.

  • value: any

    The given value to the preference key except PreferenceKeys.LOG_EVENT and PreferenceKeys.GLOBAL_AUTO_WCS_MATCHING. For PreferenceKeys.LOG_EVENT, the input value should be an enum CARTA.EventType, functioning as a toggle for an element within the PreferenceKeys.LOG_EVENT. For PreferenceKeys.GLOBAL_AUTO_WCS_MATCHING, the input value should be a WCSMatchingType enum or a sum of the enums, functioning as an exclusive OR value for PreferenceKeys.GLOBAL_AUTO_WCS_MATCHING.

  Returns Generator<Promise<any>, any, unknown>

  false if the key or value is not valid; yield a result using ApiService.Instance.setPreference