Class OHIFRemote

Hierarchy

EventEmitter
- OHIFRemote

Index

Constructors

constructor

Methods

Constructors

constructor

new OHIFRemote(options?: RemoteOptions): OHIFRemote

Overrides EventEmitter.constructor
Parameters
- options: RemoteOptions = {}
Returns OHIFRemote

Methods

connect

connect(options?: ConnectOptions): void

Connect to the OHIF viewer in the target frame and wait for messages.

Parameters
- options: ConnectOptions = {}
Returns void

destroy

destroy(): void

Stop listening to messages and destroy the channel.

Returns void

setProject

setProject(projectId: string): OHIFRemote

Set a project ID context for subsequent method calls.

Parameters
- projectId: string
  
  Flywheel project ID
Returns OHIFRemote

openStudy

openStudy(studyInstanceUid: string): void

Open a DICOM study.

Parameters
- studyInstanceUid: string
  
  StudyInstanceUID of the study
Returns void

openSession

openSession(sessionId: string): void

Open DICOM studies associated to a Flywheel session.

Parameters
- sessionId: string
  
  Flywheel session ID
Returns void

openFile

openFile(fileId: string): void

Open a NIfTI, PNG, or other image file.

Parameters
- fileId: string
  
  Flywheel file ID or provider UUID
Returns void

openTask

openTask(taskId: string): void

Open a reader task sequence.

Parameters
- taskId: string
  
  Flywheel task ID
Returns void

Generated using TypeDoc