fix: Initial sort not consistent (#5224)

* fix: Initial sort not consistent

* Add better sort criteria

* Remove sorting changes

* Start replacing screen shots

* Update bun lock for version

* Leave default sort for test mode

* fix: Add consistent sorting for same series splits

* PR comments

* docs: add notes for series/display set sort

* Updated example docs

* Update sortVector to be compareSameStudy

* Add unit test

* PR comments

platform/docs/docs/development/notes-requirements.md

@@ -0,0 +1,68 @@
+
+---
+sidebar_position: 14
+sidebar_label: Notes and Requirements
+title: Notes and Requirements for general OHIF behaviour
+summary: Specifies some of the expected behavior of OHIF generally
+---
+
+# Notes and Requirements
+
+This document just lists general notes and requirements for how OHIF behaves.
+The plan is to break this document down into a new sub-category once there
+are sufficient notes/requirements.
+
+
+## Series and Display Set Sorting `sortStudy.ts`
+
+Often a user will want to see a sorted list of series, or more generally
+a sorted list of display sets.  Series are the original data and can be split
+up into several display sets, although they are the same general sort of concept
+
+For example, an MR series might contain both T1 and T2 echos, and the T2 echo
+should occur after the T1.  Or, a single series might contain 4 mammography views:
+`LCC`, `RCC`, `LMLO`, `RMLO` with all the `CC` views shown first, and within
+that all the left views first for a given sub-type of CC view.
+
+To allow controlling that, the `sortStudy` can register sort functions
+that user used when two display sets come from the same series.  Between
+those display sets, the registration also registers a default ordering
+for that compare function.  Thus, the registration might look like:
+
+```javascript
+   addSameSeriesCompare('mammographyCompare', mammographyCompare, 5)
+   addSameSeriesCompare('mrT1T2Compare', mrT1T2Compare, 7);
+```
+
+Then, the display set for mr and mammography need to set the field `compareSameSeries`
+to the value `mammographyCompare`.
+
+```javascript
+   makeDisplaySet
+     ...
+     displaySet = {
+      ...,
+      compareSameSeries: 'mammographyCompare',
+```
+
+### Specifying Sort Order from Series Split
+
+The series split rules (`getSopClassHandlerModule`) can specify a custom order
+of display sets for the same series by adding a `sortVector`
+to the display set created.  Display sets which match on series instance uid
+are then compared using the sort vector.  The first element is the general sort
+order for this type of value among all other sort types, and must be numeric.
+The remainder of the values in the vector should be consistent for all
+sort vectors whose first value is the same value.
+
+For example, the mammography sort vector might have a primary value of '25',
+and then use the next three values for `view type`, `sub type` and `side`.
+It might also be true that "both" side views sort before everything and would be assigned
+a value less than `25` here.
+
+```
+   // LCC view
+   [25, 'CC', 'L', 'XO']
+   // BCC view
+   [24, 'CC', 'B']
+```