ohif-viewer/docs/latest/modes/validity.md
Alireza 5643f8f6d2
feat: Added documentation for OHIF-v3 (#2450)
* Added docs with new screenshots

* Added doc to architecture

* Added documentations to various extension modules

* Added more documentation to modes

* Added docs to managers

* Added docs for services

* Fixed deployment docs

* Added white labelling documentation

* Added i18n docs and measurement export
2021-06-15 11:15:29 -04:00

926 B

Mode: Validity

Overview

There are two mechanism for checking the validity of a mode for a study.

  • isValidMode: which is called on a selected study in the workList.
  • validTags

isValidMode

This hook can be used to define a function that return a boolean which decided the validity of the mode based on StudyInstanceUID and modalities that are in the study.

For instance, for pet-ct mode, both PT and 'CT' modalities should be available inside the study.

export default function mode() {
  return {
    id: '',
    displayName: '',
    isValidMode: ({ modalities, StudyInstanceUID }) => {
      const modalities_list = modalities.split('\\');
      const validMode = ['CT', 'PT'].every(modality => modalities_list.includes(modality));
      return validMode;
    },
    /*
    ...
    */
  }
}