Mercurial > hg > orthanc-stone

annotate Applications/StoneWebViewer/NOTES.txt @ 2024:e24e93418061 StoneWebViewer-2.5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
StoneWebViewer-2.5
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 05 Dec 2022 08:15:09 +0100
parents f30d7055ed6a
children 5653b6335642
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1691
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 Differences with Osimis Web viewer
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 ==================================
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 - The images are retrieved using DICOMweb.
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7
1702
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
8
1708
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1702
diff changeset
9 - In the Stone Web viewer, the individual instances are loaded on
1715
1952162474c3 A few æsthetic changes in the text body
Benjamin Golinvaux <bgo@osimis.io>
parents: 1709
diff changeset
10 an as-needed basis, in order to reduce the network bandwidth usage.
1952162474c3 A few æsthetic changes in the text body
Benjamin Golinvaux <bgo@osimis.io>
parents: 1709
diff changeset
11 This contrasts with the Osimis Web viewer that loads the entire images
1952162474c3 A few æsthetic changes in the text body
Benjamin Golinvaux <bgo@osimis.io>
parents: 1709
diff changeset
12 in the background.
1708
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1702
diff changeset
13
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1702
diff changeset
14
2009
196684ae6206 fix NOTES.txt
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1958
diff changeset
15 - The Stone Web viewer does not support Live Share that was available
196684ae6206 fix NOTES.txt
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1958
diff changeset
16 in old versions of the Osimis Web viewer.
1719
9a1f79d21a3f added buttons to go to the first and last frames
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1715
diff changeset
17
9a1f79d21a3f added buttons to go to the first and last frames
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1715
diff changeset
18
1720
b8d19f53aaca display the instance number, and the wc/ww info (work-in-progress)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1719
diff changeset
19 - The Stone Web viewer displays a color block at the bottom-right of
b8d19f53aaca display the instance number, and the wc/ww info (work-in-progress)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1719
diff changeset
20 each viewport. A "red" color means that the current frame is still
b8d19f53aaca display the instance number, and the wc/ww info (work-in-progress)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1719
diff changeset
21 being loaded, so don't trust what is currently displayed. A "yellow"
b8d19f53aaca display the instance number, and the wc/ww info (work-in-progress)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1719
diff changeset
22 color means that the viewport displays a low-quality preview (JPEG).
b8d19f53aaca display the instance number, and the wc/ww info (work-in-progress)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1719
diff changeset
23 A "green" color means that the viewport contains an image with the
b8d19f53aaca display the instance number, and the wc/ww info (work-in-progress)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1719
diff changeset
24 same quality as the source DICOM image.
b8d19f53aaca display the instance number, and the wc/ww info (work-in-progress)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1719
diff changeset
25
b8d19f53aaca display the instance number, and the wc/ww info (work-in-progress)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1719
diff changeset
26
1715
1952162474c3 A few æsthetic changes in the text body
Benjamin Golinvaux <bgo@osimis.io>
parents: 1709
diff changeset
27 - The Stone Web viewer uses the DICOM identifiers, while the Osimis Web
1952162474c3 A few æsthetic changes in the text body
Benjamin Golinvaux <bgo@osimis.io>
parents: 1709
diff changeset
28 viewer uses the Orthanc identifiers.
1691
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 https://book.orthanc-server.com/faq/orthanc-ids.html
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 In the Stone Web viewer, the studies are indexed by their "Study
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 Instance UID" tag (0020,000d). The series are indexed by their
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 "Series Instance UID" tag (0020,000e). To open a single series,
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 the parent study must be provided.
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 To open a single study:
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 http://.../index.html?study=<StudyInstanceUID>
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 To open a single series:
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 http://.../index.html?study=<StudyInstanceUID>&series=<SeriesInstanceUID>
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
1702
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
42
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
43 - In the Osimis Web viewer, the "OpenAllPatientStudies" configuration
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
44 option can be provided to search Orthanc for all studies from
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
45 patients with the same PatientID as the selected study, then display
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
46 them.
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
47
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
48 In the Stone Web viewer, the "OpenAllPatientStudies" configuration
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
49 option is replaced by the single "patient" GET argument. This option
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
50 contains a comma-separated list of "Patient ID" tag (0010,0020).
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
51
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
52 To open all the studies of one patient:
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
53 http://.../index.html?patient=<PatientID>
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
54
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
55 To open all the studies of several patients:
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
56 http://.../index.html?patient=<PatientID1>,<PatientID2>,...
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
57
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
58
1692
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
59 - In the Osimis Web viewer, the "pickableStudyIds" parameter in the
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
60 URL defines the list of studies that are available for display, and
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
61 that are listed in the dropdown at the top-left of the interface.
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
62
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
63 In the Stone Web viewer, "pickableStudyIds" is replaced by the
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
64 single "study" GET argument, that is allowed to contain a
1702
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
65 comma-separated list of studies. The "series" parameter must not be
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
66 provided in this case.
1691
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 To open a list of studies:
4a49de03a419 porting the "pickableStudyIds" feature of Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 http://.../index.html?study=<StudyInstanceUID1>,<StudyInstanceUID2>,...
1702
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
70
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
71
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
72 - In the Osimis Web viewer, the "selectedStudyIds" parameter in the
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
73 URL defines the list of studies that are selected in the dropdown at
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
74 the top-left corner of the viewer (those studies are therefore
bc40b6450261 "patient" GET argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1696
diff changeset
75 displayed when the viewer starts).
1692
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
76
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
77 In the Stone Web viewer, "selectedStudyIds" is replaced by the
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
78 "selectedStudies" GET argument, that is allowed to contain a
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
79 comma-separated list of studies.
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
80
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
81 To make a list of studies available, but display only one of those
1715
1952162474c3 A few æsthetic changes in the text body
Benjamin Golinvaux <bgo@osimis.io>
parents: 1709
diff changeset
82 studies when the viewer starts, please use:
1692
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
83 http://.../index.html?study=<StudyInstanceUID1>,<StudyInstanceUID2>,...&selectedStudies=<StudyInstanceUID1>
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
84
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
85 If the "selectedStudies" is not provided, then all the studies are
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
86 displayed at the startup.
e787b52d025f "selectedStudies" argument to replace "selectedStudyIds" from Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1691
diff changeset
87
1696
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
88
1958
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
89 Minor changes
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
90 -------------
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
91
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
92 - Option "ShowInfoPanelButtonEnabled" in the Osimis Web viewer is
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
93 named "ShowUserPreferencesButton" in the Stone Web viewer.
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
94
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
95 - Option "AlwaysShowNotForDiagnosticUsageDisclaimer" in the Osimis Web
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
96 viewer is named "ShowNotForDiagnosticUsageDisclaimer" in the Stone
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
97 Web viewer.
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
98
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
99 - The allowed values for option "ShowInfoPanelAtStartup" are "Always",
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
100 "Never" of "User" (note the first character in upper case). In the
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
101 Osimis Web viewer, these options were in lower case.
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
102
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
103
142c7ee8fe1f added configuration options: ShowInfoPanelAtStartup, ShowUserPreferencesButton, and ShowNotForDiagnosticUsageDisclaimer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1762
diff changeset
104
1761
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
105 Authorization to the DICOMweb server (new in 2.0)
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
106 ====================================
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
107
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
108 The function "stone.AddHttpHeader()" exposed in the WebAssembly API
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
109 can be used to add custom HTTP headers to each XMLHttpRequest that is
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
110 sent to the DICOMweb server. This notably gives the opportunity to
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
111 provide an authentication token using the "Authorization" HTTP header.
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
112
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
113 The Vue.js application will set the "Authorization" HTTP header to the
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
114 value "Bearer <token>" where "<token>" is value of the GET argument
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
115 "token" provided when opening "index.html". If the "token" GET
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
116 argument is absent, the "Authorization" header is not altered.
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
117
1762
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1761
diff changeset
118 For instance, if the user opens the Stone Web viewer using the
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1761
diff changeset
119 following URL:
1761
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
120
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
121 http://.../index.html?study=<StudyInstanceUID1>&token=Hello
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
122
1762
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1761
diff changeset
123 Then each request to the DICOMweb server will contain the HTTP header:
1761
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
124 "Authorization: Bearer Hello"
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
125
28755e42c007 Fix issue #197 (Support for passing credentials with all HTTP requests)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1720
diff changeset
126
2016
f30d7055ed6a new URL argument "menu" to change the layout of the list of studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2009
diff changeset
127 Additional options
f30d7055ed6a new URL argument "menu" to change the layout of the list of studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2009
diff changeset
128 ==================
f30d7055ed6a new URL argument "menu" to change the layout of the list of studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2009
diff changeset
129
f30d7055ed6a new URL argument "menu" to change the layout of the list of studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2009
diff changeset
130 - If present in the URL, the "menu" argument can be used to set the
f30d7055ed6a new URL argument "menu" to change the layout of the list of studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2009
diff changeset
131 default layout of the left-hand list of studies/series. Its allowed
f30d7055ed6a new URL argument "menu" to change the layout of the list of studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2009
diff changeset
132 values are "hidden", "small", "grid" (default value at the study
f30d7055ed6a new URL argument "menu" to change the layout of the list of studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2009
diff changeset
133 level), or "full" (default value at the series level). (new in Stone
f30d7055ed6a new URL argument "menu" to change the layout of the list of studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2009
diff changeset
134 Web viewer 2.5)
f30d7055ed6a new URL argument "menu" to change the layout of the list of studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2009
diff changeset
135
f30d7055ed6a new URL argument "menu" to change the layout of the list of studies/series
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2009
diff changeset
136
1696
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
137 Dynamic actions using messages
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
138 ==============================
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
139
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
140 Some actions can be dynamically triggered in the Stone Web viewer from
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
141 another Web page. This is done by using the "window.postMessage()"
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
142 primitive of JavaScript:
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
143 https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
144
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
145 Each message must be a JSON object containing at least the "type"
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
146 field. The latter field indicates the type of action to be triggered.
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
147
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
148 For security, the "ExpectedMessageOrigin" configuration option of the
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
149 Stone Web viewer must have been set to the expected origin of the
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
150 messages. Otherwise, the Stone Web viewer will reject the message.
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
151
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
152
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
153 Action of type "show-osirix-annotations"
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
154 ----------------------------------------
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
155
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
156 This action loads a set of ROIs exported from OsiriX. The ROIs must
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
157 use the XML file format of OsiriX.
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
158
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
159 The parent DICOM study containing the annotation(s) must have been
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
160 loaded by the Stone Web viewer beforehand. The Stone Web viewer shall
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
161 automatically focus on one instance that is associated with the ROIs.
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
162
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
163 The JSON message must contain the following fields:
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
164
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
165 - "type" must be equal to "show-osirix-annotations"
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
166
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
167 - "xml" must contain the XML file generated by OsiriX
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
168
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
169 - "clear" is a Boolean to indicate whether to clear the annotations
572652803929 bootstrapping the Stone Web viewer configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1692
diff changeset
170 that have previously been opened.