BackendService

Index

Properties

• animationId
• catalogStream
• connectionDropped
• connectionStatus
• contourStream
• endToEndPing
• errorStream
• fittingProgressStream
• histogramStream
• listProgressStream
• loggingEnabled
• momentProgressStream
• pvPreviewStream
• pvProgressStream
• rasterSyncStream
• rasterTileStream
• scriptingStream
• serverFeatureFlags
• serverUrl
• sessionId
• spatialProfileStream
• spectralProfileStream
• statsStream
• vectorTileStream

Accessors

• Instance

Methods

• addRequiredTiles
• cancelRequestingFileList
• cancelRequestingFitting
• cancelRequestingMoment
• cancelRequestingPV
• closeCatalogFile
• closeFile
• closePvPreview
• connect
• exportRegion
• getCatalogFileInfo
• getCatalogList
• getFileInfo
• getFileList
• getRegionFileInfo
• getRegionList
• importRegion
• loadCatalogFile
• loadFile
• loadStokeFiles
• removeRegion
• removeRequiredTiles
• requestFitting
• requestMoment
• requestPV
• requestRemoteFile
• resumeSession
• saveFile
• sendAnimationFlowControl
• sendPing
• sendScriptingResponse
• serverHasFeature
• setAuthToken
• setCatalogFilterRequest
• setChannels
• setContourParameters
• setCursor
• setHistogramRequirements
• setRegion
• setSpatialRequirements
• setSpectralRequirements
• setStatsRequirements
• setVectorOverlayParameters
• startAnimation
• stopAnimation
• stopPvPreview
• updateEndToEndPing

Properties

publicanimationId

animationId: number

readonlycatalogStream

catalogStream: Subject<CatalogFilterResponse>

connectionDropped

connectionDropped: boolean

connectionStatus

connectionStatus: ConnectionStatus

readonlycontourStream

contourStream: Subject<ContourImageData>

endToEndPing

endToEndPing: number

readonlyerrorStream

errorStream: Subject<ErrorData>

readonlyfittingProgressStream

fittingProgressStream: Subject<FittingProgress>

readonlyhistogramStream

histogramStream: Subject<RegionHistogramData>

readonlylistProgressStream

listProgressStream: Subject<ListProgress>

readonlyloggingEnabled

loggingEnabled: boolean

readonlymomentProgressStream

momentProgressStream: Subject<MomentProgress>

readonlypvPreviewStream

pvPreviewStream: Subject<PvPreviewData>

readonlypvProgressStream

pvProgressStream: Subject<PvProgress>

readonlyrasterSyncStream

rasterSyncStream: Subject<RasterTileSync>

readonlyrasterTileStream

rasterTileStream: Subject<RasterTileData>

readonlyscriptingStream

scriptingStream: Subject<ScriptingRequest>

publicserverFeatureFlags

serverFeatureFlags: number

publicserverUrl

serverUrl: string

publicsessionId

sessionId: number

readonlyspatialProfileStream

spatialProfileStream: Subject<SpatialProfileData>

readonlyspectralProfileStream

spectralProfileStream: Subject<SpectralProfileData>

readonlystatsStream

statsStream: Subject<RegionStatsData>

readonlyvectorTileStream

vectorTileStream: Subject<VectorOverlayTileData>

Accessors

staticInstance

• get Instance(): BackendService

• Returns BackendService

Methods

addRequiredTiles

• addRequiredTiles(fileId: number, tiles: number[], quality: number): boolean

• Parameters

  • fileId: number

  • tiles: number[]

  • quality: number

  Returns boolean

cancelRequestingFileList

• cancelRequestingFileList(fileListType: FileListType): any

• Parameters

  • fileListType: FileListType

  Returns any

cancelRequestingFitting

• cancelRequestingFitting(fileId: number): any

• Parameters

  • fileId: number

  Returns any

cancelRequestingMoment

• cancelRequestingMoment(fileId: number): any

• Parameters

  • fileId: number

  Returns any

cancelRequestingPV

• cancelRequestingPV(fileId: number): any

• Parameters

  • fileId: number

  Returns any

closeCatalogFile

• closeCatalogFile(fileId: number): boolean

• Parameters

  • fileId: number

  Returns boolean

closeFile

• closeFile(fileId: number): boolean

• Parameters

  • fileId: number

  Returns boolean

closePvPreview

• closePvPreview(previewId: number): boolean

• Parameters

  • previewId: number

  Returns boolean

connect

• connect(url: string): Promise<IRegisterViewerAck>

• Parameters

  • url: string

  Returns Promise<IRegisterViewerAck>

exportRegion

• exportRegion(directory: string, file: string, type: FileType, coordType: CoordinateType, fileId: number, regionStyles: Map<number, IRegionStyle>, overwrite?: boolean): Promise<IExportRegionAck>

• Parameters

  • directory: string

  • file: string

  • type: FileType

  • coordType: CoordinateType

  • fileId: number

  • regionStyles: Map<number, IRegionStyle>

  • overwrite: boolean = false

  Returns Promise<IExportRegionAck>

getCatalogFileInfo

• getCatalogFileInfo(directory: string, name: string): Promise<ICatalogFileInfoResponse>

• Parameters

  • directory: string

  • name: string

  Returns Promise<ICatalogFileInfoResponse>

getCatalogList

• getCatalogList(directory: string, filterMode: FileListFilterMode): Promise<ICatalogListResponse>

• Parameters

  • directory: string

  • filterMode: FileListFilterMode

  Returns Promise<ICatalogListResponse>

getFileInfo

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

• Parameters

  • directory: string

  • file: string

  • hdu: string

  Returns Promise<IFileInfoResponse>

getFileList

• getFileList(directory: string, filterMode: FileListFilterMode): Promise<IFileListResponse>

• Parameters

  • directory: string

  • filterMode: FileListFilterMode

  Returns Promise<IFileListResponse>

getRegionFileInfo

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

• Parameters

  • directory: string

  • file: string

  Returns Promise<IRegionFileInfoResponse>

getRegionList

• getRegionList(directory: string, filterMode: FileListFilterMode): Promise<IRegionListResponse>

• Parameters

  • directory: string

  • filterMode: FileListFilterMode

  Returns Promise<IRegionListResponse>

importRegion

• importRegion(directory: string, file: string, type: FileType, fileId: number): Promise<IImportRegionAck>

• Parameters

  • directory: string

  • file: string

  • type: FileType

  • fileId: number

  Returns Promise<IImportRegionAck>

loadCatalogFile

• loadCatalogFile(directory: string, name: string, fileId: number, previewDataSize: number): Promise<IOpenCatalogFileAck>

• Parameters

  • directory: string

  • name: string

  • fileId: number

  • previewDataSize: number

  Returns Promise<IOpenCatalogFileAck>

loadFile

• loadFile(directory: string, file: string, hdu: string, fileId: number, imageArithmetic: boolean): Promise<IOpenFileAck>

• Parameters

  • directory: string

  • file: string

  • hdu: string

  • fileId: number

  • imageArithmetic: boolean

  Returns Promise<IOpenFileAck>

loadStokeFiles

• loadStokeFiles(stokesFiles: IStokesFile[], fileId: number, renderMode: RenderMode): Promise<IConcatStokesFilesAck>

• Parameters

  • stokesFiles: IStokesFile[]

  • fileId: number

  • renderMode: RenderMode

  Returns Promise<IConcatStokesFilesAck>

removeRegion

• removeRegion(regionId: number): boolean

• Parameters

  • regionId: number

  Returns boolean

removeRequiredTiles

• removeRequiredTiles(fileId: number, tiles: number[]): boolean

• Parameters

  • fileId: number

  • tiles: number[]

  Returns boolean

requestFitting

• requestFitting(message: IFittingRequest): Promise<IFittingResponse>

• Parameters

  • message: IFittingRequest

  Returns Promise<IFittingResponse>

requestMoment

• requestMoment(message: IMomentRequest): Promise<IMomentResponse>

• Parameters

  • message: IMomentRequest

  Returns Promise<IMomentResponse>

requestPV

• requestPV(message: IPvRequest): Promise<IPvResponse>

• Parameters

  • message: IPvRequest

  Returns Promise<IPvResponse>

requestRemoteFile

• requestRemoteFile(message: IRemoteFileRequest): Promise<IRemoteFileResponse>

• Parameters

  • message: IRemoteFileRequest

  Returns Promise<IRemoteFileResponse>

resumeSession

• resumeSession(message: IResumeSession): Promise<IResumeSessionAck>

• Parameters

  • message: IResumeSession

  Returns Promise<IResumeSessionAck>

saveFile

• saveFile(fileId: number, outputFileDirectory: string, outputFileName: string, outputFileType: FileType, regionId?: number, channels?: number[], stokes?: number[], keepDegenerate?: boolean, restFreq?: number, overwrite?: boolean): Promise<ISaveFileAck>

• Parameters

  • fileId: number

  • outputFileDirectory: string

  • outputFileName: string

  • outputFileType: FileType

  • optionalregionId: number

  • optionalchannels: number[]

  • optionalstokes: number[]

  • optionalkeepDegenerate: boolean

  • optionalrestFreq: number

  • overwrite: boolean = false

  Returns Promise<ISaveFileAck>

sendAnimationFlowControl

• sendAnimationFlowControl(message: IAnimationFlowControl): boolean

• Parameters

  • message: IAnimationFlowControl

  Returns boolean

sendPing

• sendPing(): void

• Returns void

sendScriptingResponse

• sendScriptingResponse(message: IScriptingResponse): boolean

• Parameters

  • message: IScriptingResponse

  Returns boolean

publicserverHasFeature

• serverHasFeature(feature: ServerFeatureFlags): boolean

• Parameters

  • feature: ServerFeatureFlags

  Returns boolean

setAuthToken

• setAuthToken(token: string): void

• Parameters

  • token: string

  Returns void

setCatalogFilterRequest

• setCatalogFilterRequest(filterRequest: ICatalogFilterRequest): boolean

• Parameters

  • filterRequest: ICatalogFilterRequest

  Returns boolean

setChannels

• setChannels(fileId: number, channel: number, stokes: number, requiredTiles: IAddRequiredTiles): boolean

• Parameters

  • fileId: number

  • channel: number

  • stokes: number

  • requiredTiles: IAddRequiredTiles

  Returns boolean

setContourParameters

• setContourParameters(message: ISetContourParameters): boolean

• Parameters

  • message: ISetContourParameters

  Returns boolean

setCursor

• setCursor(fileId: number, x: number, y: number): boolean

• Parameters

  • fileId: number

  • x: number

  • y: number

  Returns boolean

setHistogramRequirements

• setHistogramRequirements(requirementsMessage: ISetHistogramRequirements): boolean

• Parameters

  • requirementsMessage: ISetHistogramRequirements

  Returns boolean

setRegion

• setRegion(fileId: number, regionId: number, region: RegionStore, isRequestingPreview?: boolean): Promise<ISetRegionAck>

• Parameters

  • fileId: number

  • regionId: number

  • region: RegionStore

  • optionalisRequestingPreview: boolean

  Returns Promise<ISetRegionAck>

setSpatialRequirements

• setSpatialRequirements(requirementsMessage: ISetSpatialRequirements): boolean

• Parameters

  • requirementsMessage: ISetSpatialRequirements

  Returns boolean

setSpectralRequirements

• setSpectralRequirements(requirementsMessage: ISetSpectralRequirements): boolean

• Parameters

  • requirementsMessage: ISetSpectralRequirements

  Returns boolean

setStatsRequirements

• setStatsRequirements(requirementsMessage: ISetStatsRequirements): boolean

• Parameters

  • requirementsMessage: ISetStatsRequirements

  Returns boolean

setVectorOverlayParameters

• setVectorOverlayParameters(message: ISetVectorOverlayParameters): boolean

• Parameters

  • message: ISetVectorOverlayParameters

  Returns boolean

startAnimation

• startAnimation(animationMessage: IStartAnimation): Promise<IStartAnimationAck>

• Parameters

  • animationMessage: IStartAnimation

  Returns Promise<IStartAnimationAck>

stopAnimation

• stopAnimation(animationMessage: IStopAnimation): boolean

• Parameters

  • animationMessage: IStopAnimation

  Returns boolean

stopPvPreview

• stopPvPreview(previewId: number): boolean

• Parameters

  • previewId: number

  Returns boolean

updateEndToEndPing

• updateEndToEndPing(): void

• Returns void