Skip to content

Configuring the viewer

In order to create a consistent experience across users, you may want to configure the viewer so that specific settings are applied when users open the viewer. This can be achieved through creating an ohif_configv3.json configuration file for your project.

Note

The settings that can be configured for the V3 viewer are currently limited compared to the V2 viewer. As Flywheel continues to develop the V3 viewer, further configuration options will be implemented. If there are settings that you are currently configuring in the V2 viewer that you would like to be able to configure in the V3 viewer, please reach out to your Flywheel representative to help with roadmap prioritization.

Create a configuration file for the V3 viewer

To create a configuration file for the V3 viewer:

  1. Navigate to the Information tab of your project.

  2. In the Attachments section, click on "Create" to launch the File Editor.

    Create config file

  3. In the File Editor, select JSON as the file type.

  4. Upon configuring your file, save the file (Save > Save As...) under the name ohif_configv3.json.

    Save config file

  5. The configuration file is now present in the Attachments section and can be further edited by clicking on the Actions icon Three dots menu icon and selecting Launch in Code Editor.

    Edit config file

Note

You can also upload a configuration file by using the Upload button in the Attachments section. Upon upload, open the file in the Code Editor and save it as ohif_configv3.json

Configuration options

Labels

  • Property name: labels

Configuring labels allows to define a list of labels that users can chose from when annotating images. Additional parameters can be configured to define a color for each label, prompt users to select a label every time they create an annotation, or allow users to enter custom labels.

  • Nested properties:
Property Value Description
items String for both value and label nested properties List of labels that can be selected in the viewer when creating measurements.
Defined as an array of objects with the following properties:
value - value that is displayed in the measurement panel, in the annotations quick view, and in csv exports.
label - value displayed in the list shown to the user when selecting a label
labelOnMeasure boolean When set to true, users will be prompted to choose from the list of items every time they create an annotation.
exclusive boolean When set to true, users are not allowed to enter custom labels.
Example
{
    "labels": {
        "items": [
        { "value": "BM", "label": "Bruch's Membrane" },
        { "value": "SAP", "label": "Supraspinatus - anteroposterior" },
        ],
        "labelOnMeasure": false,
        "exclusive": false
     }
}