FileBrowserStore

Index

Constructors

• constructor

Properties

• HDUfileInfoExtended
• appendingFrame
• browserMode
• catalogFileInfo
• catalogFileList
• catalogHeaders
• exportCoordinateType
• exportFileType
• exportFilename
• exportRegionIndexes
• extendedLoading
• fileInfoResp
• fileList
• isImportingRegions
• isLoadingDialogOpen
• loadingCheckedCount
• loadingInfo
• loadingList
• loadingProgress
• loadingTotalCount
• regionFileInfo
• responseErrorMessage
• saveFileType
• saveFilename
• saveRegionId
• saveRestFreq
• saveSpectralEnd
• saveSpectralStart
• saveSpectralStride
• saveStokesOption
• selectedCatalogFile
• selectedFile
• selectedFiles
• selectedHDU
• selectedTab
• shouldDropDegenerateAxes
• startingDirectory

Accessors

• HDUList
• annotationOptionNum
• catalogHeaderDataset
• exportAnnotationNum
• exportRegionNum
• exportRegionOptions
• fileInfo
• fileInfoExtended
• getBrowserMode
• getfileListByMode
• headers
• includesAnnotation
• includesRegion
• isComplexImage
• regionOptionNum
• saveRestFreqInHz
• saveStokesRange
• Instance

Methods

• addExportRegionIndex
• cancelRequestingFileList
• clearExportRegionIndexes
• deleteExportRegionIndex
• getCatalogFileInfo
• getFileInfo
• getFileList
• getRegionFileInfo
• getStokesFile
• hideFileBrowser
• initialSaveSpectralRange
• resetExportRegionIndexes
• resetLoadingStates
• resetSaveRestFreq
• restoreStartingDirectory
• saveStartingDirectory
• selectFile
• selectFolder
• selectHDU
• selectParent
• setCatalogFileList
• setExportCoordinateType
• setExportFileType
• setExportFilename
• setFileList
• setImportingRegions
• setSaveFileType
• setSaveFilename
• setSaveRegionId
• setSaveRestFreq
• setSaveRestFreqUnit
• setSaveRestFreqVal
• setSaveSpectralEnd
• setSaveSpectralStart
• setSelectedFiles
• setSelectedTab
• setSortingConfig
• setStartingDirectory
• showExportRegions
• showFileBrowser
• showLoadingDialog
• updateExportRegionIndexes
• updateLoadingState

Constructors

constructor

• new FileBrowserStore(): FileBrowserStore

• Returns FileBrowserStore

Properties

HDUfileInfoExtended

HDUfileInfoExtended: {}

Type declaration

• [k string]: CARTA.IFileInfoExtended

appendingFrame

appendingFrame: boolean = false

browserMode

browserMode: BrowserMode = BrowserMode.File

catalogFileInfo

catalogFileInfo: any

catalogFileList

catalogFileList: any

catalogHeaders

catalogHeaders: ICatalogHeader[]

exportCoordinateType

exportCoordinateType: CoordinateType

exportFileType

exportFileType: any

exportFilename

exportFilename: string

exportRegionIndexes

exportRegionIndexes: number[] = []

extendedLoading

extendedLoading: boolean = false

fileInfoResp

fileInfoResp: boolean = false

fileList

fileList: any

isImportingRegions

isImportingRegions: boolean = false

isLoadingDialogOpen

isLoadingDialogOpen: boolean

loadingCheckedCount

loadingCheckedCount: number

loadingInfo

loadingInfo: boolean = false

loadingList

loadingList: boolean = false

loadingProgress

loadingProgress: number

loadingTotalCount

loadingTotalCount: number

regionFileInfo

regionFileInfo: string[]

responseErrorMessage

responseErrorMessage: string = ""

saveFileType

saveFileType: FileType = CARTA.FileType.CASA

saveFilename

saveFilename: string = ""

saveRegionId

saveRegionId: number

saveRestFreq

saveRestFreq: Freq = ...

saveSpectralEnd

saveSpectralEnd: number = 0

saveSpectralStart

saveSpectralStart: number = 0

saveSpectralStride

saveSpectralStride: number = 1

saveStokesOption

saveStokesOption: number

selectedCatalogFile

selectedCatalogFile: ICatalogFileInfo

selectedFile

selectedFile: any

selectedFiles

selectedFiles: ISelectedFile[]

selectedHDU

selectedHDU: string

selectedTab

selectedTab: TabId = FileInfoType.IMAGE_FILE

shouldDropDegenerateAxes

shouldDropDegenerateAxes: boolean

startingDirectory

startingDirectory: string = "$BASE"

Accessors

HDUList

• get HDUList(): OptionProps[]

• Returns OptionProps[]

annotationOptionNum

• get annotationOptionNum(): number

• Returns number

catalogHeaderDataset

• get catalogHeaderDataset(): { columnHeaders: CatalogHeader[]; columnsData: Map<number, ProcessedColumnData> }

• Returns { columnHeaders: CatalogHeader[]; columnsData: Map<number, ProcessedColumnData> }

  • columnHeaders: CatalogHeader[]

  • columnsData: Map<number, ProcessedColumnData>

exportAnnotationNum

• get exportAnnotationNum(): number

• Returns number

exportRegionNum

• get exportRegionNum(): number

• Returns number

exportRegionOptions

• get exportRegionOptions(): LineOption[]

• Returns LineOption[]

fileInfo

• get fileInfo(): string

• Returns string

fileInfoExtended

• get fileInfoExtended(): any

• Returns any

getBrowserMode

• get getBrowserMode(): FileInfoType

• Returns FileInfoType

getfileListByMode

• get getfileListByMode(): any

• Returns any

headers

• get headers(): string

• Returns string

includesAnnotation

• get includesAnnotation(): boolean

• Returns boolean

includesRegion

• get includesRegion(): boolean

• Returns boolean

isComplexImage

• get isComplexImage(): boolean

• Returns boolean

regionOptionNum

• get regionOptionNum(): number

• Returns number

saveRestFreqInHz

• get saveRestFreqInHz(): number

• Returns number

saveStokesRange

• get saveStokesRange(): number[]

• Returns number[]

staticInstance

• get Instance(): FileBrowserStore

• Returns FileBrowserStore

Methods

addExportRegionIndex

• addExportRegionIndex(regionIndex: number): void

• Parameters

  • regionIndex: number

  Returns void

cancelRequestingFileList

• cancelRequestingFileList(): void

• Returns void

clearExportRegionIndexes

• clearExportRegionIndexes(mode: SelectionMode): void

• Parameters

  • mode: SelectionMode

  Returns void

deleteExportRegionIndex

• deleteExportRegionIndex(regionIndex: number): void

• Parameters

  • regionIndex: number

  Returns void

getCatalogFileInfo

• getCatalogFileInfo(directory: string, filename: string): Generator<Promise<ICatalogFileInfoResponse>, void, unknown>

• Parameters

  • directory: string

  • filename: string

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

getFileInfo

• getFileInfo(directory: string, file: string, hdu: string): Generator<Promise<IFileInfoResponse>, void, unknown>

• Parameters

  • directory: string

  • file: string

  • hdu: string

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

getFileList

• getFileList(directory?: string): Generator<Promise<IFileListResponse>, void, unknown>

• Parameters

  • directory: string = ""

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

getRegionFileInfo

• getRegionFileInfo(directory: string, file: string): Generator<Promise<IRegionFileInfoResponse>, void, unknown>

• Parameters

  • directory: string

  • file: string

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

getStokesFile

• getStokesFile(directory: string, file: string, hdu: string): Promise<any>

• Retrieves Stokes file information from a given directory, file, and HDU.

  ---

  Parameters

  • directory: string

    The directory where the file is located.

  • file: string

    The name of the file.

  • hdu: string

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

  Returns Promise<any>

  A promise resolving to the Stokes file information.

hideFileBrowser

• hideFileBrowser(): void

• Returns void

initialSaveSpectralRange

• initialSaveSpectralRange(): void

• Returns void

resetExportRegionIndexes

• resetExportRegionIndexes(mode: SelectionMode): void

• Parameters

  • mode: SelectionMode

  Returns void

resetLoadingStates

• resetLoadingStates(): void

• Returns void

resetSaveRestFreq

• resetSaveRestFreq(): void

• Returns void

restoreStartingDirectory

• restoreStartingDirectory(): void

• Returns void

saveStartingDirectory

• saveStartingDirectory(directory?: string): void

• Parameters

  • optionaldirectory: string

  Returns void

selectFile

• selectFile(file: ISelectedFile): void

• Parameters

  • file: ISelectedFile

  Returns void

selectFolder

• selectFolder(folder: string, absolutePath?: boolean): void

• Parameters

  • folder: string

  • absolutePath: boolean = false

  Returns void

selectHDU

• selectHDU(hdu: string): void

• Parameters

  • hdu: string

  Returns void

selectParent

• selectParent(): void

• Returns void

setCatalogFileList

• setCatalogFileList(list: ICatalogListResponse): void

• Parameters

  • list: ICatalogListResponse

  Returns void

setExportCoordinateType

• setExportCoordinateType(coordType: CoordinateType): void

• Parameters

  • coordType: CoordinateType

  Returns void

setExportFileType

• setExportFileType(fileType: any): void

• Parameters

  • fileType: any

  Returns void

setExportFilename

• setExportFilename(filename: string): void

• Parameters

  • filename: string

  Returns void

setFileList

• setFileList(list: IFileListResponse): void

• Parameters

  • list: IFileListResponse

  Returns void

setImportingRegions

• setImportingRegions(isImportingRegions: boolean): void

• Parameters

  • isImportingRegions: boolean

  Returns void

setSaveFileType

• setSaveFileType(fileType: FileType): void

• Parameters

  • fileType: FileType

  Returns void

setSaveFilename

• setSaveFilename(filename: string): void

• Parameters

  • filename: string

  Returns void

setSaveRegionId

• setSaveRegionId(regionId: number): void

• Parameters

  • regionId: number

  Returns void

setSaveRestFreq

• setSaveRestFreq(freq: Freq): void

• Parameters

  • freq: Freq

  Returns void

setSaveRestFreqUnit

• setSaveRestFreqUnit(unit: FrequencyUnit): void

• Parameters

  • unit: FrequencyUnit

  Returns void

setSaveRestFreqVal

• setSaveRestFreqVal(val: number): void

• Parameters

  • val: number

  Returns void

setSaveSpectralEnd

• setSaveSpectralEnd(end: number): void

• Parameters

  • end: number

  Returns void

setSaveSpectralStart

• setSaveSpectralStart(start: number): void

• Parameters

  • start: number

  Returns void

setSelectedFiles

• setSelectedFiles(selection: ISelectedFile[]): void

• Parameters

  • selection: ISelectedFile[]

  Returns void

setSelectedTab

• setSelectedTab(newId: TabId): void

• Parameters

  • newId: TabId

  Returns void

setSortingConfig

• setSortingConfig(columnName: string, direction: number): void

• Parameters

  • columnName: string

  • direction: number

  Returns void

setStartingDirectory

• setStartingDirectory(directory?: string): void

• Parameters

  • optionaldirectory: string

  Returns void

showExportRegions

• showExportRegions(regionId?: number): void

• Parameters

  • optionalregionId: number

  Returns void

showFileBrowser

• showFileBrowser(mode: BrowserMode, append?: boolean): void

• Parameters

  • mode: BrowserMode

  • append: boolean = false

  Returns void

showLoadingDialog

• showLoadingDialog(): void

• Returns void

updateExportRegionIndexes

• updateExportRegionIndexes(exportRegionIndexes: number[]): void

• Parameters

  • exportRegionIndexes: number[]

  Returns void

updateLoadingState

• updateLoadingState(progress: number, checkedCount: number, totalCount: number): void

• Parameters

  • progress: number

  • checkedCount: number

  • totalCount: number

  Returns void