Skip to main content
Version: Next

AppStore

Index

Properties

Accessors

Methods

Properties

activeImage

activeImage: ImageItem | null = null

The active image, which can be a loaded image, a color blended image, or a PV preivew.

activeLayer

activeLayer: ImageViewLayer = ImageViewLayer.RegionMoving

activeWorkspace

activeWorkspace: Workspace | undefined = undefined

readonlyalertStore

alertStore: AlertStore

readonlyanimatorStore

animatorStore: AnimatorStore

readonlyapiService

apiService: ApiService

readonlybackendService

backendService: BackendService

readonlycatalogStore

catalogStore: CatalogStore

readonlychannelMapStore

channelMapStore: ChannelMapStore

contourDataSource

contourDataSource: FrameStore | null = null

readonlydialogStore

dialogStore: DialogStore

readonlydynamicLayoutStore

dynamicLayoutStore: DynamicLayoutStore

readonlyfileBrowserStore

fileBrowserStore: FileBrowserStore

fullViewHeight

fullViewHeight: number = 1

fullViewWidth

fullViewWidth: number = 1

getEnumSnapshots

getEnumSnapshots: (names: string[]) => EnumSnapshot[] = getEnumSnapshotsFromRegistry

Type declaration

    • (names: string[]): EnumSnapshot[]

    • Parameters

      • names: string[]

      Returns EnumSnapshot[]

readonlyhelpStore

helpStore: HelpStore

readonlyhipsQueryStore

hipsQueryStore: HipsQueryStore = HipsQueryStore.Instance

Management of HiPS data queries.

hoveredFrame

hoveredFrame: FrameStore | null = null

readonlyimageFittingStore

imageFittingStore: ImageFittingStore

imageRatio

imageRatio: number = 1

readonlyimageViewConfigStore

imageViewConfigStore: ImageViewConfigStore = ImageViewConfigStore.Instance

Configuration of the images in the image view widget.

isAstReady

isAstReady: boolean = false

isCartaComputeReady

isCartaComputeReady: boolean = false

isCursorFrozen

isCursorFrozen: boolean = false

isCursorMirrored

isCursorMirrored: boolean = false

isExportingImage

isExportingImage: boolean = false

isFileLoading

isFileLoading: boolean = false

isFileSaving

isFileSaving: boolean = false

isLoadingMultipleFiles

isLoadingMultipleFiles: boolean = false

isLoadingWorkspace

isLoadingWorkspace: boolean = false

isResumingSession

isResumingSession: boolean = false

isSplashScreenVisible

isSplashScreenVisible: boolean = true

isToolbarExpanded

isToolbarExpanded: boolean = true

readonlylayoutStore

layoutStore: LayoutStore

listEnumSnapshots

listEnumSnapshots: () => string[] = listEnumSnapshotsFromRegistry

Type declaration

    • (): string[]

    • Returns string[]

readonlylogStore

logStore: LogStore

newRelease

newRelease: string = ""

readonlyoverlaySettings

overlaySettings: OverlaySettings

readonlypreferenceStore

preferenceStore: PreferenceStore

previewFrames

previewFrames: ObservableMap<number, FrameStore> = ...

rasterScalingReference

rasterScalingReference: FrameStore | null = null

regionClipboard

regionClipboard: RegionClipboardData | null = null

regionHistograms

regionHistograms: Map<number, ObservableMap<number, ObservableMap<number, IRegionHistogramData>>> = ...

regionStats

regionStats: Map<number, ObservableMap<number, ObservableMap<number, RegionStatsData>>> = ...

readonlyscriptingService

scriptingService: ScriptingService

shouldMatchMoment

shouldMatchMoment: boolean = true

shouldShowNewRelease

shouldShowNewRelease: boolean = false

shouldSyncContourToFrame

shouldSyncContourToFrame: boolean = true

shouldSyncFrameToContour

shouldSyncFrameToContour: boolean = true

readonlysnippetStore

snippetStore: SnippetStore

spatialProfiles

spatialProfiles: Map<string, SpatialProfileStore> = ...

spatialReference

spatialReference: FrameStore | null = null

spectralMatchingType

spectralMatchingType: SpectralType = SpectralType.VRAD

spectralProfiles

spectralProfiles: Map<number, ObservableMap<number, SpectralProfileStore>> = ...

spectralReference

spectralReference: FrameStore | null = null

systemTheme

systemTheme: string = ""

taskCurrentTime

taskCurrentTime: number = 0

taskProgress

taskProgress: number = 0

taskStartTime

taskStartTime: number = 0

readonlytelemetryService

telemetryService: TelemetryService

readonlytileService

tileService: TileService

username

username: string = ""

readonlywidgetsStore

widgetsStore: WidgetsStore

publiczIndexManager

zIndexManager: FloatingObjzIndexManager = ...

publicstaticreadonlyDEFAULT_STATS_TYPES

DEFAULT_STATS_TYPES: any[] = ...

Accessors

activeFrame

  • The active frame. If the active image is a loaded image or a PV preview, returns the corresponding frame. If the active image is a color blended image, returns the base frame.

    Returns FrameStore | null

activeFrameFileId

  • get activeFrameFileId(): number | undefined

  • Returns number | undefined

activeFrameIndex

  • get activeFrameIndex(): number

  • Returns number

activeImageIndex

  • get activeImageIndex(): number

  • The index of the active image in the image list.

    Returns number

catalogNextFileId

  • get catalogNextFileId(): number

  • Returns number

catalogNum

  • get catalogNum(): number

  • Returns number

contourFrames

estimatedTaskRemainingTime

  • get estimatedTaskRemainingTime(): number | undefined

  • Returns number | undefined

focusedRegion

frameChannels

  • get frameChannels(): number[]

  • Returns number[]

frameMap

frameNames

  • get frameNames(): OptionProps[]

  • Returns OptionProps[]

frameNum

  • get frameNum(): number

  • Returns number

frameOptions

  • get frameOptions(): FrameOption[]

  • Returns FrameOption[]

frames

  • All the loaded images in the image list.

    Returns FrameStore[]

frameStokes

  • get frameStokes(): number[]

  • Returns number[]

frontendVersion

  • get frontendVersion(): string

  • Returns string

isAppendFileDisabled

  • get isAppendFileDisabled(): boolean

  • Returns boolean

isDarkTheme

  • get isDarkTheme(): boolean

  • Returns boolean

isFrameLockedToContour

  • get isFrameLockedToContour(): boolean

  • Returns boolean

isOpenFileDisabled

  • get isOpenFileDisabled(): boolean

  • Returns boolean

modifierString

  • get modifierString(): ctrl + | cmd + | alt +

  • Returns ctrl + | cmd + | alt +

pixelRatio

  • get pixelRatio(): number

  • This is devicePixelRatio * imageRatio, which is used to make image rendering consistent across different devices.

    Returns number

spatialAndSpectalMatchedFileIds

  • get spatialAndSpectalMatchedFileIds(): number[]

  • Returns number[]

vectorOverlayFrames

publicstaticInstance

Methods

addFrame

  • addFrame(ack: IOpenFileAck, directory: string, isLelExpr: boolean, hdu: string, isGenerated?: boolean, shouldSetAsActive?: boolean, shouldUpdateStartingDirectory?: boolean): boolean

  • Adds a frame to the frame array based on the provided parameters.

    Parameters

    • ack: IOpenFileAck

      The ack message received after opening a file.

    • directory: string

      The path to the parent directory of the file.

    • isLelExpr: boolean
    • hdu: string

      The Header Data Unit (HDU) identifier of the file.

    • isGenerated: boolean = false
    • shouldSetAsActive: boolean = true
    • shouldUpdateStartingDirectory: boolean = true

    Returns boolean

    Whether the frame was successfully added.

addPreviewFrame

  • addPreviewFrame(ack: any, directory: string, hdu: string, sourceFileId: number | undefined, pvGeneratorWidgetStore: PvGeneratorWidgetStore): FrameStore | undefined

addRegionsInBatch

  • addRegionsInBatch(frame: FrameStore, regions: [string, IRegionInfo][], regionStyleMap: Map<string, IRegionStyle>, startIndex: number, count: number): void

  • Parameters

    • frame: FrameStore
    • regions: [string, IRegionInfo][]
    • regionStyleMap: Map<string, IRegionStyle>
    • startIndex: number
    • count: number

    Returns void

appendCatalog

  • appendCatalog(directory: string, file: string, previewDataSize: number, type: CatalogFileType): Generator<Promise<IOpenCatalogFileAck>, number, unknown>

  • Parameters

    • directory: string
    • file: string
    • previewDataSize: number
    • type: CatalogFileType

    Returns Generator<Promise<IOpenCatalogFileAck>, number, unknown>

appendConcatFile

  • appendConcatFile(stokesFiles: IStokesFile[], directory: string, hdu: string): Promise<any>

  • Parameters

    • stokesFiles: IStokesFile[]
    • directory: string
    • hdu: string

    Returns Promise<any>

appendFile

  • appendFile(path: string, filename?: string, hdu?: string, isImageArithmetic?: boolean, shouldSetAsActive?: boolean, shouldUpdateStartingDirectory?: boolean): Generator<Generator<Promise<IOpenFileAck>, FrameStore | null | undefined, unknown>, any, unknown>

  • Appends a file at the given path to the list of existing open files.

    @example
    // Append a file with the given path and filename
    const file = await appendFile("/path/to/directory", "example.fits");

    Parameters

    • path: string

      The path to the parent directory of the file to open, or of the file itself.

    • optionalfilename: string

      The filename of the file to open.

    • optionalhdu: string

      The Header Data Unit (HDU) to open. If left blank, the first image HDU will be opened.

    • isImageArithmetic: boolean = false
    • shouldSetAsActive: boolean = true
    • shouldUpdateStartingDirectory: boolean = true

    Returns Generator<Generator<Promise<IOpenFileAck>, FrameStore | null | undefined, unknown>, any, unknown>

    A promise that resolves to the FrameStore of the opened file.

cancelCubeHistogramRequest

  • cancelCubeHistogramRequest(fileId?: number): void

  • Parameters

    • fileId: number = -1

    Returns void

cancelRequestingMoment

  • cancelRequestingMoment(fileId?: number): void

  • Parameters

    • fileId: number = -1

    Returns void

cancelRequestingPV

  • cancelRequestingPV(fileId?: number, previewId?: number): void

  • Parameters

    • fileId: number = -1
    • optionalpreviewId: number

    Returns void

clearRasterScalingReference

  • clearRasterScalingReference(): void

  • Returns void

clearSpatialReference

  • clearSpatialReference(): void

  • Returns void

clearSpectralReference

  • clearSpectralReference(): void

  • Returns void

closeCurrentFile

  • closeCurrentFile(shouldConfirmClose?: boolean): void

  • Closes the currently active image if the active image is not a PV preview.

    Parameters

    • shouldConfirmClose: boolean = false

    Returns void

closeFile

  • closeFile(frame: FrameStore, shouldConfirmClose?: boolean): Generator<Promise<boolean>, void, unknown>

  • Closes a loaded image.

    Parameters

    • frame: FrameStore

      The loaded image.

    • shouldConfirmClose: boolean = true

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

closeImage

  • closeImage(image: ImageViewItem, shouldConfirmClose?: boolean): void

  • Closes a loaded image or a color blended image.

    Parameters

    • image: ImageViewItem

      The image item to close.

    • shouldConfirmClose: boolean = true

    Returns void

closeOtherFiles

  • closeOtherFiles(frame: FrameStore, shouldConfirmClose?: boolean): void

  • Closes all the loaded image except the provided one.

    Parameters

    • frame: FrameStore

      A loaded image.

    • shouldConfirmClose: boolean = true

    Returns void

closeOtherImages

  • Closes all the images except the provided loaded image.

    Parameters

    Returns void

closeWorkspace

  • closeWorkspace(): void

  • Returns void

copySelectedRegion

  • copySelectedRegion(): boolean

  • Returns boolean

decreaseImageRatio

  • decreaseImageRatio(): void

  • Returns void

delay

  • delay(time: number): Promise<unknown>

  • Parameters

    • time: number

    Returns Promise<unknown>

deleteAllAnnotations

  • deleteAllAnnotations(): void

  • Deletes all annotations.

    Returns void

deleteAllRegions

  • deleteAllRegions(): void

  • Deletes all regions including annotations.

    Returns void

deleteAllRegularRegions

  • deleteAllRegularRegions(): void

  • Deletes all regular regions.

    Returns void

deleteRegion

deleteSelectedRegions

  • deleteSelectedRegions(): boolean

  • Returns boolean

deleteWorkspace

  • deleteWorkspace(name: string): Promise<void>

  • Parameters

    • name: string

    Returns Promise<void>

endFileLoading

  • endFileLoading(): void

  • Returns void

endFileSaving

  • endFileSaving(): void

  • Returns void

exportImage

  • exportImage(imageRatio: number): void

  • Parameters

    • imageRatio: number

    Returns void

exportRegions

  • exportRegions(directory: string, file: string, coordType: CoordinateType, fileType: any, exportRegions: number[], shouldOverwrite?: boolean, targetFrame?: FrameStore): Generator<Promise<IExportRegionAck>, void, unknown>

  • Exports specified regions and saves a region file to the provided directory.

    Parameters

    • directory: string

      The directory where the region file will be saved.

    • file: string

      The filename of the region file.

    • coordType: CoordinateType

      The coordinate system used in the exported region file.

    • fileType: any

      The type of the exported region file.

    • exportRegions: number[]

      The indices of the regions to be exported.

    • shouldOverwrite: boolean = false
    • optionaltargetFrame: FrameStore

      The target frame containing the regions. If not provided, the active frame is used.

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

fetchParameter

  • fetchParameter(val: any): any

  • Parameters

    • val: any

    Returns any

publicgetAppContainer

  • getAppContainer(): HTMLElement | null

  • Returns HTMLElement | null

getFileList

  • getFileList(directory: string): Promise<IFileListResponse>

  • Parameters

    • directory: string

    Returns Promise<IFileListResponse>

getFrame

  • getFrame(fileId: number): FrameStore | null | undefined

  • Parameters

    • fileId: number

    Returns FrameStore | null | undefined

getFrameIndex

  • getFrameIndex(fileId: number): number

  • Parameters

    • fileId: number

    Returns number

getFrameName

  • getFrameName(fileId: number): string | undefined

  • Parameters

    • fileId: number

    Returns string | undefined

getImageDataUrl

  • getImageDataUrl(backgroundColor: string): string | null

  • Parameters

    • backgroundColor: string

    Returns string | null

handleCatalogFilterStream

  • handleCatalogFilterStream(catalogFilter: CatalogFilterResponse): void

  • Parameters

    • catalogFilter: CatalogFilterResponse

    Returns void

handleContourImageStream

  • handleContourImageStream(contourImageData: ContourImageData): void

  • Parameters

    • contourImageData: ContourImageData

    Returns void

handleErrorStream

  • handleErrorStream(errorData: ErrorData): void

  • Parameters

    • errorData: ErrorData

    Returns void

handleFileProgressStream

  • handleFileProgressStream(fileProgress: ListProgress): void

  • Parameters

    • fileProgress: ListProgress

    Returns void

handleFittingProgressStream

  • handleFittingProgressStream(fittingProgress: FittingProgress): void

  • Parameters

    • fittingProgress: FittingProgress

    Returns void

handleMomentProgressStream

  • handleMomentProgressStream(momentProgress: MomentProgress): void

  • Parameters

    • momentProgress: MomentProgress

    Returns void

handlePvPreviewStream

  • handlePvPreviewStream(pvPreviewData: PvPreviewData): void

  • Parameters

    • pvPreviewData: PvPreviewData

    Returns void

handlePvProgressStream

  • handlePvProgressStream(pvProgress: PvProgress): void

  • Parameters

    • pvProgress: PvProgress

    Returns void

handleRegionHistogramStream

  • handleRegionHistogramStream(regionHistogramData: RegionHistogramData): void

  • Parameters

    • regionHistogramData: RegionHistogramData

    Returns void

handleRegionStatsStream

  • handleRegionStatsStream(regionStatsData: RegionStatsData): void

  • Parameters

    • regionStatsData: RegionStatsData

    Returns void

handleScriptingRequest

  • handleScriptingRequest(request: IScriptingRequest): void

  • Parameters

    • request: IScriptingRequest

    Returns void

handleSpatialProfileStream

  • handleSpatialProfileStream(spatialProfileData: ISpatialProfileData): void

  • Parameters

    • spatialProfileData: ISpatialProfileData

    Returns void

handleSpectralProfileStream

  • handleSpectralProfileStream(spectralProfileData: SpectralProfileData): void

  • Parameters

    • spectralProfileData: SpectralProfileData

    Returns void

handleThemeChange

  • handleThemeChange(isDarkMode: boolean): void

  • Parameters

    • isDarkMode: boolean

    Returns void

handleTileStream

handleVectorTileStream

  • handleVectorTileStream(vectorTileData: VectorOverlayTileData): void

  • Parameters

    • vectorTileData: VectorOverlayTileData

    Returns void

hideSplashScreen

  • hideSplashScreen(): void

  • Returns void

importRegion

  • importRegion(directory: string, file: string, type: any, targetFrame?: FrameStore): Generator<Promise<IImportRegionAck>, void, unknown>

  • Imports a region file to the active frame or a specified frame. Supported file types are CRTF and DS9.

    Parameters

    • directory: string

      The directory containing the region file.

    • file: string

      The filename of the region file.

    • type: any

      The type of the region file (CRTF or DS9_REG).

    • optionaltargetFrame: FrameStore

      The frame to which the regions should be imported. If not provided, the active frame is used. If the frame is spatially matched, the reference frame is used.

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

isActiveImage

  • Checks if the given image is the active image.

    Parameters

    Returns boolean

    Whether the given image is the active image.

loadConcatStokes

  • loadConcatStokes(stokesFiles: IStokesFile[], directory: string, hdu: string): Promise<any>

  • Parameters

    • stokesFiles: IStokesFile[]
    • directory: string
    • hdu: string

    Returns Promise<any>

loadDefaultFiles

  • loadDefaultFiles(): Generator<Generator<Promise<IOpenFileAck>, FrameStore | null | undefined, unknown> | Generator<Generator<Generator<Promise<IOpenFileAck>, FrameStore | null | undefined, unknown>, any, unknown> | Promise<Workspace | undefined>, boolean, Workspace & FrameStore>, void, unknown>

  • Returns Generator<Generator<Promise<IOpenFileAck>, FrameStore | null | undefined, unknown> | Generator<Generator<Generator<Promise<IOpenFileAck>, FrameStore | null | undefined, unknown>, any, unknown> | Promise<Workspace | undefined>, boolean, Workspace & FrameStore>, void, unknown>

loadFile

  • loadFile(path: string, filename: string, hdu: string, isImageArithmetic: boolean, shouldSetAsActive?: boolean, shouldUpdateStartingDirectory?: boolean): Generator<Promise<IOpenFileAck>, FrameStore | null | undefined, unknown>

  • Loads a file at the given path and adds it as a frame to the application.

    @throws

    If there is an error loading the file.

    Parameters

    • path: string

      The path to the parent directory of the file to load, or of the file itself.

    • filename: string

      The filename of the file to load.

    • hdu: string

      The Header Data Unit (HDU) to load. If left blank, the first image HDU will be loaded.

    • isImageArithmetic: boolean
    • shouldSetAsActive: boolean = true
    • shouldUpdateStartingDirectory: boolean = true

    Returns Generator<Promise<IOpenFileAck>, FrameStore | null | undefined, unknown>

    The added frame.

loadRemoteFile

  • loadRemoteFile(remoteRequest: IRemoteFileRequest): Generator<Promise<IRemoteFileResponse>, any, any>

  • Loads a file by HiPS data queries and adds it as a frame.

    @throws

    If there is an error loading the file.

    Parameters

    • remoteRequest: IRemoteFileRequest

      Parameters for the query.

    Returns Generator<Promise<IRemoteFileResponse>, any, any>

    The added frame.

publicloadWorkspace

  • loadWorkspace(name: string, isKey?: boolean): Generator<Generator<Generator<Promise<IOpenFileAck>, FrameStore | null | undefined, unknown>, any, unknown> | Promise<Workspace | undefined>, boolean, Workspace & FrameStore>

  • Parameters

    • name: string
    • isKey: boolean = false

    Returns Generator<Generator<Generator<Promise<IOpenFileAck>, FrameStore | null | undefined, unknown>, any, unknown> | Promise<Workspace | undefined>, boolean, Workspace & FrameStore>

matchAllRasterScaling

  • matchAllRasterScaling(): void

  • Returns void

matchAllSpatial

  • matchAllSpatial(): Generator<Promise<boolean> | Generator<Promise<boolean>, void, unknown>, void, unknown>

  • Returns Generator<Promise<boolean> | Generator<Promise<boolean>, void, unknown>, void, unknown>

matchAllSpectral

  • matchAllSpectral(): void

  • Returns void

nextImage

  • nextImage(): void

  • Shifts the active image to the next image. If the active image is a PV preview, the shift doesn't occur.

    Returns void

onReconnectAlertClosed

  • onReconnectAlertClosed(): Promise<void>

  • Returns Promise<void>

openConcatFile

  • openConcatFile(stokesFiles: IStokesFile[], directory: string, hdu: string): Promise<any>

  • Parameters

    • stokesFiles: IStokesFile[]
    • directory: string
    • hdu: string

    Returns Promise<any>

openFile

  • openFile(path: string, filename?: string, hdu?: string, isImageArithmetic?: boolean, shouldUpdateStartingDirectory?: boolean): Generator<Generator<Promise<IOpenFileAck>, FrameStore | null | undefined, unknown>, any, unknown>

  • Closes all existing files and opens a file at the given path.

    @example
    // Open a file with the given path and filename
    const openedFile = await openFile("/path/to/directory", "example.fits");

    Parameters

    • path: string

      The path to the parent directory of the file to open, or of the file itself.

    • optionalfilename: string

      The filename of the file to open.

    • optionalhdu: string

      The Header Data Unit (HDU) to open. If left blank, the first image HDU will be opened.

    • optionalisImageArithmetic: boolean
    • shouldUpdateStartingDirectory: boolean = true

    Returns Generator<Generator<Promise<IOpenFileAck>, FrameStore | null | undefined, unknown>, any, unknown>

    A promise that resolves to the FrameStore of the opened file.

pasteRegion

  • pasteRegion(): boolean

  • Returns boolean

prevImage

  • prevImage(): void

  • Shifts the active image to the previous image. If the active image is a PV preview, the shift doesn't occur.

    Returns void

recalculateRequirements

  • recalculateRequirements(): void

  • Returns void

removeAllFrames

  • removeAllFrames(): void

  • Closes all the images in the image view widget.

    Returns void

removeCatalog

  • removeCatalog(fileId: number, catalogWidgetId: string, catalogComponentId?: string): void

  • Parameters

    • fileId: number
    • catalogWidgetId: string
    • optionalcatalogComponentId: string

    Returns void

removePreviewFrame

  • removePreviewFrame(previewId: number): void

  • Closes a PV preview.

    Parameters

    • previewId: number

      The file id of the image cube from which the PV preview was created.

    Returns void

reorderFrame

  • reorderFrame(oldIndex: number, newIndex: number, length: number): void

  • Reorders images in the image list.

    Parameters

    • oldIndex: number

      The first index of the images to move.

    • newIndex: number

      The index to move the image to.

    • length: number

      The length of the images to move.

    Returns void

requestCubeHistogram

  • requestCubeHistogram(fileId?: number): void

  • Parameters

    • fileId: number = -1

    Returns void

requestFitting

  • requestFitting(message: IFittingRequest): Generator<Promise<IFittingResponse>, void, unknown>

  • Parameters

    • message: IFittingRequest

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

requestMoment

  • requestMoment(message: IMomentRequest, frame: FrameStore): Generator<Promise<IMomentResponse>, void, unknown>

  • Parameters

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

requestPreviewPV

  • requestPreviewPV(message: IPvRequest, frame: FrameStore, id: string): Generator<Promise<IPvResponse>, void, unknown>

  • Parameters

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

requestPV

  • requestPV(message: IPvRequest, frame: FrameStore, shouldKeepExisting: boolean): Generator<Promise<IPvResponse>, void, unknown>

  • Parameters

    • message: IPvRequest
    • frame: FrameStore
    • shouldKeepExisting: boolean

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

publicresetCursorRegionSpectralProfileProgress

  • resetCursorRegionSpectralProfileProgress(fileId: number): void

  • Parameters

    • fileId: number

    Returns void

resetImageRatio

  • resetImageRatio(): void

  • Returns void

publicresetRegionSpectralProfileProgress

  • resetRegionSpectralProfileProgress(regionId: number): void

  • Parameters

    • regionId: number

    Returns void

restartTaskProgress

  • restartTaskProgress(): void

  • Returns void

saveFile

  • saveFile(directory: string, filename: string, fileType: FileType, regionId?: number, channels?: number[], stokes?: number[], shouldDropDegenerateAxes?: boolean, restFreq?: number, shouldOverwrite?: boolean): Generator<Promise<ISaveFileAck>, any, unknown>

  • Parameters

    • directory: string
    • filename: string
    • fileType: FileType
    • optionalregionId: number
    • optionalchannels: number[]
    • optionalstokes: number[]
    • optionalshouldDropDegenerateAxes: boolean
    • optionalrestFreq: number
    • shouldOverwrite: boolean = false

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

publicsaveWorkspace

  • saveWorkspace(name: string): Generator<Promise<Workspace | undefined> | Promise<string | false | undefined>, boolean, unknown>

  • Parameters

    • name: string

    Returns Generator<Promise<Workspace | undefined> | Promise<string | false | undefined>, boolean, unknown>

sendCatalogFilter

  • sendCatalogFilter(catalogFilter: ICatalogFilterRequest): void

  • Parameters

    • catalogFilter: ICatalogFilterRequest

    Returns void

setActiveImage

  • setActiveImage(activeImage: ImageItem | null): void

  • Sets the active image.

    Parameters

    • activeImage: ImageItem | null

      The image to set as the active image.

    Returns void

setActiveImageById

  • setActiveImageById(type: ImageType, id: number): void

  • Sets the active image by its type and stable store id.

    For ImageType.FRAME, id is frameInfo.fileId (i.e. FrameStore.id). For ImageType.COLOR_BLENDING, id is ColorBlendingStore.id. For ImageType.PV_PREVIEW, id is FrameStore.id, which is always PREVIEW_PV_FILEID (-2). Only one PV preview can exist at a time (creating a new one replaces the old), so this id is unique in practice.

    Preferred over setActiveImageByIndex for programmatic activation, because imageList indices are volatile (images can be added, removed, or reordered), whereas (type, id) is stable.

    Parameters

    • type: ImageType

      The image-view item type.

    • id: number

      The stable store id for that type.

    Returns void

setActiveImageByIndex

  • setActiveImageByIndex(index: number): void

  • Sets the active image based on the image list index.

    Parameters

    • index: number

      The image list index.

    Returns void

setAllReferences

  • setAllReferences(frame: FrameStore): Generator<Generator<Promise<boolean>, void, unknown>, void, unknown>

  • Parameters

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

publicsetAppContainer

  • setAppContainer(container: HTMLElement | null): void

  • Parameters

    • container: HTMLElement | null

    Returns void

setAstReady

  • setAstReady(isReady: boolean): void

  • Parameters

    • isReady: boolean

    Returns void

setAutoTheme

  • setAutoTheme(): void

  • Returns void

setCanvasUpdated

  • setCanvasUpdated(): void

  • Returns void

setChannelsByFrame

setContourDataSource

setCursorFrozen

  • setCursorFrozen(isFrozen: boolean): void

  • Parameters

    • isFrozen: boolean

    Returns void

setDarkTheme

  • setDarkTheme(): void

  • Returns void

setHoveredFrame

setImageRatio

  • setImageRatio(val: number): void

  • Parameters

    • val: number

    Returns void

setImageViewDimensions

  • setImageViewDimensions(w: number, h: number): void

  • Parameters

    • w: number
    • h: number

    Returns void

setIsCanvasUpdated

  • setIsCanvasUpdated(isUpdated: boolean): void

  • Parameters

    • isUpdated: boolean

    Returns void

setIsExportingImage

  • setIsExportingImage(isExporting: boolean): void

  • Parameters

    • isExporting: boolean

    Returns void

setLightTheme

  • setLightTheme(): void

  • Returns void

setLoadingMultipleFiles

  • setLoadingMultipleFiles(isLoadingMultipleFiles: boolean): void

  • Parameters

    • isLoadingMultipleFiles: boolean

    Returns void

setMatchingEnabled

  • setMatchingEnabled(isSpatial: boolean, isSpectral: boolean): void

  • Parameters

    • isSpatial: boolean
    • isSpectral: boolean

    Returns void

setRasterScalingMatchingEnabled

  • setRasterScalingMatchingEnabled(frame: FrameStore, isEnabled: boolean): void

  • Parameters

    Returns void

setRasterScalingReference

  • setRasterScalingReference(frame: FrameStore): void

setShowNewRelease

  • setShowNewRelease(shouldShow: boolean): void

  • Parameters

    • shouldShow: boolean

    Returns void

setSpatialMatchingEnabled

  • setSpatialMatchingEnabled(frame: FrameStore, isEnabled: boolean): Generator<Promise<boolean>, void, unknown>

  • Sets the spatial matching for a frame.

    Parameters

    • frame: FrameStore

      The frame for which to set spatial matching.

    • isEnabled: boolean

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

setSpatialReference

  • setSpatialReference(frame: FrameStore, shouldShowColorBlendingAlert?: boolean): Generator<Promise<boolean>, void, unknown>

  • Sets the spatial reference frame.

    Parameters

    • frame: FrameStore

      The frame to set as the spatial reference.

    • shouldShowColorBlendingAlert: boolean = true

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

setSpectralMatchingEnabled

  • setSpectralMatchingEnabled(frame: FrameStore, isEnabled: boolean): void

  • Parameters

    Returns void

setSpectralMatchingType

  • setSpectralMatchingType(spectralMatchingType: SpectralType): void

setSpectralReference

setTheme

  • setTheme(theme: string): void

  • Parameters

    • theme: string

    Returns void

setToolbarExpanded

  • setToolbarExpanded(isExpanded: boolean): void

  • Parameters

    • isExpanded: boolean

    Returns void

setUsername

  • setUsername(username: string): void

  • Parameters

    • username: string

    Returns void

showSplashScreen

  • showSplashScreen(): void

  • Returns void

startFileLoading

  • startFileLoading(): void

  • Returns void

startFileSaving

  • startFileSaving(): void

  • Returns void

toggleActiveLayer

  • toggleActiveLayer(): void

  • Returns void

toggleCursorFrozen

  • toggleCursorFrozen(): void

  • Returns void

toggleCursorMirror

  • toggleCursorMirror(): void

  • Returns void

toggleFrameContourLock

  • toggleFrameContourLock(): void

  • Returns void

toggleMomentToMatch

  • toggleMomentToMatch(): void

  • Returns void

toggleRasterScalingMatching

  • toggleRasterScalingMatching(frame: FrameStore): void

toggleSpatialMatching

toggleSpectralMatching

toggleToolbarExpanded

  • toggleToolbarExpanded(): void

  • Returns void

updateActiveImage

  • Sets the active image. Ignores when animating.

    Parameters

    • image: ImageItem

      The image to set as the active image.

    Returns void

updateActiveImageByFrame

  • Sets the active image with a loaded image or a PV preview. Ignores when animating.

    Parameters

    • frame: FrameStore

      The loaded image or the PV preview.

    Returns void

updateActiveLayer

updateCatalogProfile

  • updateCatalogProfile(fileId: number, frame: FrameStore): string

  • Parameters

    Returns string

updateChannels

  • updateChannels(updates: ChannelUpdate[]): void

  • Parameters

    • updates: ChannelUpdate[]

    Returns void

updateHistogram

  • updateHistogram(fileId: number, stokes: number, channel: number): void

  • Parameters

    • fileId: number
    • stokes: number
    • channel: number

    Returns void

updateLayerPixelRatio

  • updateLayerPixelRatio(layerRef: any): void

  • Parameters

    • layerRef: any

    Returns void

updateTaskProgress

  • updateTaskProgress(progress: number): void

  • Parameters

    • progress: number

    Returns void

waitForImageData

  • waitForImageData(): Promise<void>

  • Returns Promise<void>

Page Options