Skip to content

Commit

Permalink
Docs changes requested in the PR
Browse files Browse the repository at this point in the history
  • Loading branch information
wayfarer3130 committed Oct 3, 2023
1 parent 40a52e1 commit 9307305
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
6 changes: 4 additions & 2 deletions platform/core/src/log.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ const log = {
},
// Store the timing keys to allow knowing whether or not to log events
timingKeys: {
// script time values are added before log is loaded, and the log
// shouldn't depend on the enums, so for this case recreate the string.
// script time values are added during the index.html initial load,
// before log (this file) is loaded, and the log
// can't depend on the enums, so for this case recreate the string.
// See TimingEnum for details
scriptToView: true,
},
};
Expand Down
18 changes: 17 additions & 1 deletion platform/core/src/types/TimingEnum.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
export enum TimingEnum {
// The time from when the users selects a study until the study metadata
// is loaded (and the display sets are ready)
STUDY_TO_DISPLAY_SETS = 'studyToDisplaySetsLoaded',

// The time from when the user selects a study until any viewport renders
STUDY_TO_FIRST_IMAGE = 'studyToFirstImage',

// The time from when display sets are loaded until any viewport renders
// an image.
DISPLAY_SETS_TO_FIRST_IMAGE = 'displaySetsToFirstImage',

// The time from when display sets are loaded until all viewports have images
DISPLAY_SETS_TO_ALL_IMAGES = 'displaySetsToAllImages',
SCRIPT_TO_VIEW = 'scriptToView',

// The time from when the user hits search until the worklist is displayed
SEARCH_TO_LIST = 'searchToList',

// The time from when the html script first starts being evaluated (before
// any other scripts or CSS is loaded), until the time that the first image
// is viewed for viewer endpoints, or the time that the first search for studies
// completes.
SCRIPT_TO_VIEW = 'scriptToView',
}

0 comments on commit 9307305

Please sign in to comment.