Skip to main content
Version: 3.12.0-beta.74 (Latest)

Study Browser

The Study Browser is a component that allows users to browse and manage studies.

studyBrowser.studyMode

IDstudyBrowser.studyMode
Description
Controls the study browser mode to determine whether to show all studies (including prior studies) or only the current study.
Default Value
'all'
Example

window.config = {
  // rest of window config
  customizationService: [
    {
      'studyBrowser.studyMode': {
         $set: 'primary', // or recent
      },
    },
  ],
};

studyBrowser.viewPresets

IDstudyBrowser.viewPresets
Description
Defines the view presets for the study browser, such as list or thumbnail views.
Default Value
[
  {
    "id": "list",
    "iconName": "ListView",
    "selected": false
  },
  {
    "id": "thumbnails",
    "iconName": "ThumbnailView",
    "selected": true
  }
]
Example

window.config = {
  // rest of window config
  customizationService: [
    {
      'studyBrowser.viewPresets': {
        $set: [
          {
            id: 'list',
            iconName: 'ListView',
            selected: true, // Makes the list view the default selected option
          },
          {
            id: 'thumbnails',
            iconName: 'ThumbnailView',
            selected: false,
          },
        ],
      },
    },
  ],
};

studyBrowser.sortFunctions

IDstudyBrowser.sortFunctions
Description
Sorting options for study browser items.
Default Value
[
  {
    "label": "Series Number"
  },
  {
    "label": "Series Date"
  }
]
Example

window.config = {
  // rest of window config
  customizationService: [
    {
      'studyBrowser.sortFunctions': {
        $push: [
          {
            label: 'Series Stuff',
            sortFunction: (a, b) => Stuff,
          },
        ],
      },
    },
  ],
};

studyBrowser.thumbnailMenuItems

IDstudyBrowser.thumbnailMenuItems
Description
Defines the menu items available in the thumbnail menu items of the study browser.
Default Value
[
  {
    "id": "tagBrowser",
    "label": "Tag Browser",
    "iconName": "DicomTagBrowser",
    "commands": "openDICOMTagViewer"
  }
]
Example

window.config = {
  // rest of window config
  customizationService: [
    {
      'studyBrowser.thumbnailMenuItems': {
        $set: [
          {
            id: 'tagBrowser',
            label: 'Tag Browser',
            iconName: 'DicomTagBrowser',
            commands: 'openDICOMTagViewer',
          },
          {
            id: 'deleteThumbnail',
            label: 'Delete',
            iconName: 'Delete',
            commands: 'deleteThumbnail',
          },
          {
            id: 'markAsFavorite',
            label: 'Mark as Favorite',
            commands: 'markAsFavorite',
          },
        ],
      },
    },
  ],
};

studyBrowser.studyMenuItems

IDstudyBrowser.studyMenuItems
Description
Defines the menu items available in the study menu items of the study browser.
Default Value
[]
Example

window.config = {
  // rest of window config
  customizationService: [
    {
      'studyBrowser.studyMenuItems': {
        $set: [
          {
            id: 'downloadStudy',
            label: 'Download Study',
            iconName: 'Download',
            commands: () => {
              console.debug('downloadStudy');
            },
          },
        ],
      },
    },
  ],
};

studyBrowser.thumbnailDoubleClickCallback

IDstudyBrowser.thumbnailDoubleClickCallback
Description
Defines the callback function for when the user double clicks a series on the study browser.
Default Value
{
    callback: ({
            activeViewportId,
            servicesManager,
            isHangingProtocolLayout
        }) =>
        async displaySetInstanceUID => {
            const {
                hangingProtocolService,
                viewportGridService,
                uiNotificationService
            } =
            servicesManager.services;
            let updatedViewports = [];
            const viewportId = activeViewportId;

            try {
                updatedViewports = hangingProtocolService.getViewportsRequireUpdate(
                    viewportId,
                    displaySetInstanceUID,
                    isHangingProtocolLayout
                );
            } catch (error) {
                console.warn(error);
                uiNotificationService.show({
                    title: 'Thumbnail Double Click',
                    message: 'The selected display sets could not be added to the viewport.',
                    type: 'error',
                    duration: 3000,
                });
            }

            commandsManager.run({
              commandName: 'setDisplaySetsForViewports',
              commandOptions: { viewportsToUpdate: updatedViewports },
            });
        },
}
Example

window.config = {
    // rest of window config
    customizationService: [{
        'studyBrowser.thumbnailDoubleClickCallback': {
            callback: ({
                    activeViewportId,
                    commandsManager,
                    servicesManager,
                    isHangingProtocolLayout
                }) =>
                async displaySetInstanceUID => {
                    const {
                        hangingProtocolService,
                        viewportGridService,
                        uiNotificationService
                    } =
                    servicesManager.services;

                    let updatedViewports = [];
                    const viewportId = activeViewportId;

                    // Changing original function here:
                    if (isBlacklistedModality(displaySetInstanceUID)) {
                        return;
                    }

                    try {
                        updatedViewports = hangingProtocolService.getViewportsRequireUpdate(
                            viewportId,
                            displaySetInstanceUID,
                            isHangingProtocolLayout
                        );
                    } catch (error) {
                        console.warn(error);
                        uiNotificationService.show({
                            title: 'Thumbnail Double Click',
                            message: 'The selected display sets could not be added to the viewport.',
                            type: 'error',
                            duration: 3000,
                        });
                    }
                  commandsManager.run({
                    commandName: 'setDisplaySetsForViewports',
                    commandOptions: { viewportsToUpdate: updatedViewports },
                  });
                };
        },
    }],
};

instanceSortingCriteria

IDinstanceSortingCriteria
Description
Defines the instance sorting criteria to sort the images
Default Value
{
    sortFunctions: {},
    defaultSortFunctionName: '',
  }
Example

window.config = {
  // rest of window config
  customizationService: [
   {
      'instanceSortingCriteria': {
        $set: {
          sortFunctions: {
            sort: (a, b) => {}
          },
          defaultSortFunctionName: 'sort',
        },
      },
    }
  ],
};