annotate Applications/StoneWebViewer/WebApplication/configuration.json @ 1843:251d7f7a6c4e

New configuration option "DownloadDicomDir" in Stone Web viewer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 24 Jun 2021 14:30:00 +0200
parents a878e807cd96
children 58049bdebdc3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1696
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 {
1700
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
2 "StoneWebViewer" :
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
3 {
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
4 /**
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
5 * Defines how dates are displayed in the UI. If this option is not
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
6 * set, the DICOM tags will be displayed as such. "DD" will be
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
7 * replaced by the day, "MM" by the month, and "YYYY" by the year.
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
8 **/
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
9 // "DateFormat" : "DD/MM/YYYY",
1699
0598c87e1e88 "WindowingPresets" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1698
diff changeset
10
1700
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
11 /**
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
12 * This option allows you to define windowing presets.
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
13 * For each preset, you must provide a name, the window width
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
14 * and window center.
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
15 **/
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
16 "WindowingPresets" : [
1701
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
17 {"Name" : "CT Lung", "WindowCenter" : -400, "WindowWidth" : 1600},
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
18 {"Name" : "CT Abdomen", "WindowCenter" : 60, "WindowWidth" : 400},
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
19 {"Name" : "CT Bone", "WindowCenter" : 300, "WindowWidth" : 1500},
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
20 {"Name" : "CT Brain", "WindowCenter" : 40, "WindowWidth" : 80},
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
21 {"Name" : "CT Chest", "WindowCenter" : 40, "WindowWidth" : 400},
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
22 {"Name" : "CT Angio", "WindowCenter" : 300, "WindowWidth" : 600}
1700
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
23 ],
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
24
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
25 /**
1701
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
26 * Enables/disables the combined tool. This is the default mode
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
27 * for mouse interactions. The combined tool allows to access the
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
28 * windowing, zoom and pan from a single mouse configuration. The
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
29 * behaviour of the combined tool is defined in
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
30 * CombinedToolBehaviour. The available mouse actions are
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
31 * "Crosshair", "Windowing", "Pan", "Rotate" and "Zoom".
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
32 **/
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
33 "CombinedToolEnabled" : true,
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
34 "CombinedToolBehaviour" : {
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
35 "LeftMouseButton" : "Windowing",
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
36 "MiddleMouseButton" : "Pan",
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
37 "RightMouseButton" : "Zoom"
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
38 },
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
39
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
40 /**
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
41 * Enables/disables the print button.
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
42 **/
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
43 "PrintEnabled" : true,
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
44
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
45 /**
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
46 * Enables/disables the button to download a screenshot of the
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
47 * active viewport as a JPEG file.
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
48 **/
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
49 "DownloadAsJpegEnabled" : true,
1709
2931f5e15320 download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1701
diff changeset
50
2931f5e15320 download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1701
diff changeset
51 /**
2931f5e15320 download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1701
diff changeset
52 * Enables/disables the button to download the display study.
1712
fb57536fcc5f documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1710
diff changeset
53 * Only used if "OrthancApiRoot" is properly set.
1709
2931f5e15320 download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1701
diff changeset
54 **/
2931f5e15320 download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1701
diff changeset
55 "DownloadStudyEnabled" : true,
2931f5e15320 download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1701
diff changeset
56
1701
b5a8bf32d969 new configuration options: "CombinedToolEnabled", "CombinedToolBehaviour" and "DownloadAsJpegEnabled"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1700
diff changeset
57 /**
1700
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
58 * The allowed origin for messages corresponding to dynamic actions
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
59 * triggered by another Web page using "window.postMessage()". The
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
60 * special value "*" will allow any origin, which is an insecure
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
61 * value to be used only during development. If this option is not
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
62 * set, all the requests for dynamic actions will be rejected.
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
63 * https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
64 **/
1712
fb57536fcc5f documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1710
diff changeset
65 "ExpectedMessageOrigin" : "http://localhost:8042",
1709
2931f5e15320 download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1701
diff changeset
66
2931f5e15320 download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1701
diff changeset
67 /**
1713
aec45e0b2528 configuration option "DicomWebRoot"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1712
diff changeset
68 * Root path of the DICOMweb server. This option is automatically
aec45e0b2528 configuration option "DicomWebRoot"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1712
diff changeset
69 * set by the Orthanc plugin if missing.
aec45e0b2528 configuration option "DicomWebRoot"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1712
diff changeset
70 **/
aec45e0b2528 configuration option "DicomWebRoot"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1712
diff changeset
71 "DicomWebRoot" : "../dicom-web",
1714
a878e807cd96 configuration option "DicomCacheSize", warning if cache should be larger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1713
diff changeset
72
a878e807cd96 configuration option "DicomCacheSize", warning if cache should be larger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1713
diff changeset
73 /**
a878e807cd96 configuration option "DicomCacheSize", warning if cache should be larger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1713
diff changeset
74 * Set the size of the cache that stores the DICOM files. This
a878e807cd96 configuration option "DicomCacheSize", warning if cache should be larger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1713
diff changeset
75 * size is expressed in megabytes. The default value of 128MB
a878e807cd96 configuration option "DicomCacheSize", warning if cache should be larger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1713
diff changeset
76 * should work in most setups, except if very large multiframe
a878e807cd96 configuration option "DicomCacheSize", warning if cache should be larger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1713
diff changeset
77 * instances are encountered, which might for instance be the case
a878e807cd96 configuration option "DicomCacheSize", warning if cache should be larger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1713
diff changeset
78 * for mammography. Setting this parameter to zero will disable
a878e807cd96 configuration option "DicomCacheSize", warning if cache should be larger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1713
diff changeset
79 * the cache, which should only be done for testing.
a878e807cd96 configuration option "DicomCacheSize", warning if cache should be larger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1713
diff changeset
80 **/
a878e807cd96 configuration option "DicomCacheSize", warning if cache should be larger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1713
diff changeset
81 "DicomCacheSize" : 128,
1713
aec45e0b2528 configuration option "DicomWebRoot"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1712
diff changeset
82
aec45e0b2528 configuration option "DicomWebRoot"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1712
diff changeset
83 /**
1709
2931f5e15320 download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1701
diff changeset
84 * The following parameter can be set if running the Stone Web
1713
aec45e0b2528 configuration option "DicomWebRoot"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1712
diff changeset
85 * viewer from Orthanc, but without using the associated plugin
aec45e0b2528 configuration option "DicomWebRoot"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1712
diff changeset
86 * (e.g. using the "Serve Folders" sample plugin). Using the
aec45e0b2528 configuration option "DicomWebRoot"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1712
diff changeset
87 * plugin would overwrite this setting. This will enable features
aec45e0b2528 configuration option "DicomWebRoot"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1712
diff changeset
88 * that are only available if the Orthanc REST API is accessible
aec45e0b2528 configuration option "DicomWebRoot"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1712
diff changeset
89 * (download of studies, and playing videos). This option is
aec45e0b2528 configuration option "DicomWebRoot"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1712
diff changeset
90 * typically used by the developers of Stone.
1709
2931f5e15320 download study from Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1701
diff changeset
91 **/
1843
251d7f7a6c4e New configuration option "DownloadDicomDir" in Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1714
diff changeset
92 "OrthancApiRoot" : "..",
251d7f7a6c4e New configuration option "DownloadDicomDir" in Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1714
diff changeset
93
251d7f7a6c4e New configuration option "DownloadDicomDir" in Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1714
diff changeset
94 /**
251d7f7a6c4e New configuration option "DownloadDicomDir" in Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1714
diff changeset
95 * If this option is set to "true", the Stone Web viewer will
251d7f7a6c4e New configuration option "DownloadDicomDir" in Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1714
diff changeset
96 * create DICOMDIR media archives (as generated by the route
251d7f7a6c4e New configuration option "DownloadDicomDir" in Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1714
diff changeset
97 * "/studies/{id}/media" of Orthanc), instead of archives
251d7f7a6c4e New configuration option "DownloadDicomDir" in Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1714
diff changeset
98 * containing a human-readable hierarchy of folders (as generated
251d7f7a6c4e New configuration option "DownloadDicomDir" in Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1714
diff changeset
99 * by the route "/studies/{id}/archive").
251d7f7a6c4e New configuration option "DownloadDicomDir" in Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1714
diff changeset
100 **/
251d7f7a6c4e New configuration option "DownloadDicomDir" in Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1714
diff changeset
101 "DownloadDicomDir" : false
1700
f1bd464dc3e1 the plugin uses the Orthanc configuration instead of the default configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1699
diff changeset
102 }
1696
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 }