otsdaq_utilities  v2_02_00
src/WebGUI/js/visualizers_lib/ViewerRoot_lib/JsRoot/changes.md
1 # JSROOT changelog
2 
3 ## Changes in 4.5.0
4 1. Zooming with mouse wheel
5 2. Context menus for many different objects attributes are provided
6 3. Context menu for every drawn object can be activated via toolbar button
7 4. Support browsing of TTask and derived classes (#40)
8 5. Apply user range for drawing TH1/TH2 histograms, also when superimposed (#44)
9 6. Implement scaling factor like x10^3 on the vertical axes
10 7. Provide shortcut buttons for each subpad
11 8. Implement simple drawing for TBox, TWbox, TSliderBox classes
12 
13 
14 ## Changes in 4.4.4
15 1. Fix - toggling of statbox was not working in all situations
16 2. Fix - for mouse rect zooming use only left mouse button
17 3. Fix - correctly draw TH2 with lego option, when histogram has negative bin content
18 4. Fix - log axis drawing with no visible ticks
19 
20 
21 ## Changes in 4.4.3
22 1. Fix - wrong selection of TH1 Y axis range when errors are displayed (#44)
23 2. Fix - apply user range for TH1 X-axis zooming (#44)
24 3. Fix - protect against pathological case of 1-bin histogram
25 4. Fix - use error plot by default in TH1 only when positive sumw2 entry exists
26 5. Fix - for TH2 box draw option draw at least 1px rect for non-empty bin
27 6. Fix - support transparency (alpha) in TColor (#45)
28 7. Fix - correct tooltip handling for graphs with lines and markers
29 8. Fix - interactive zooming in TH2 when doing histogram update
30 
31 
32 ## Changes in 4.4.2
33 1. Fix - statistic collection for TH2
34 2. Fix - correct handling of empty TList in browser/inspector
35 3. Fix - support TFolder in browser/inspector (#40)
36 
37 
38 ## Changes in 4.4.1
39 1. Fix - colz palette resize when drawing histogram second time
40 2. Fix - use embeded in TCanvas color for background color of canvas itself
41 3. Fix - rotate too long X axis text labels
42 4. Fix - draw histogram bins on frame boundary
43 5. Fix - use alternative color for shapes with default black color
44 6. Fix - correctly handle pcon/pgon shape with rmin==rmax on top or bottom side
45 
46 
47 ## Changes in 4.4
48 1. Fix faces orientation for all TGeo shapes.
49 2. Improve TGeoTorus creation - handle all parameters combinations
50 3. Implement TGeoCompositeShape, using ThreeCSG.js
51 4. Fix problem with color pallete when switch to 3D mode (#28)
52 5. Use nested CSS classes to avoid conflicts with other libraries (#29)
53 6. Let move and resize TFrame
54 7. Improve TH1/TH2 drawings
55  - draw all histograms points in the range (no any skipped bins)
56  - minimize SVG code for drawing (up to factor 100)
57  - gives significant speedup in drawings
58 8. SVG code improvement for TGraph, TF1, TAxis drawings
59 9. Provide new tooltip kind
60  - created only when needed (minimizing SVG code)
61  - tooltip can be drawn for every object in the frame
62  - touch devices are supported
63 10. Fix - let draw same object on the canvas with different options
64 11. Create cached list of known class methods. It can be extended by users.
65 12. Use of cached methods improves binary I/O perfromance by 20%
66 13. Support TGaxis
67 14. Project now can be obtained via 'bower install jsroot'
68 15. Support 'scat' and 'text' draw options for TH2
69 16. Support in binary I/O zipped buffer bigger than 16M
70 17. Correctly handle in binary I/O pointer on TArray object (like in THnSparseArrayChunk)
71 
72 
73 ## Changes in 4.3
74 1. Implement TGeoCtub, TGeoParaboloid and TGeoHype shapes
75 2. Support TGeoTube with Rmin==0
76 3. Exclude empty faces in TGeoArb8
77 4. Improve TGeoSphere creation - handle all parameters combinations
78 5. Introduce JSROOT.cleanup() function to safely clear all drawn objects
79 6. Fix wrong resize method in 'tabs' and 'collapsible' layouts
80 7. Fix canvas resize problem (issue #27)
81 8. Fix zero-height canvas when draw TGeo in collapsible layout
82 9. Fix problem of simultaneous move TGeo drawings and canvas in flexible layout
83 
84 
85 ## Changes in 4.2
86 1. Significant performance improvements in 3D drawings - TGeo/TH2/TH3
87 2. Implement TGeoPara, TGeoGtra, TGeoXtru and TGeoEltu shapes
88 3. Optimize (reduce vertices number) for others TGeo shapes
89 4. Correct rotation/translation/scaling of TGeo nodes
90 5. Workaround for axis reflection (not directly supported in three.js)
91 6. Support array of objects in I/O (like in TAxis3D)
92 7. Correct reading of multi-dim arrays like Double_t fXY[8][2];
93 8. Provide canvas toolbar for actions like savepng or unzoom
94 9. Implement JSROOT.resize() function to let resize drawing after changes in page layout
95 10. Fix error with title display/update
96 
97 
98 ## Changes in 4.1
99 1. Introduce object inspector - one could browse object members of any class
100 2. Let draw sub-items from TCanvas list of primitives like sub-pad or TLatex
101 3. Provide possibility to save drawn SVG canvas as PNG
102 4. TGraph drawing optimization - limit number of drawn points
103 5. Implement painter for TPolyMarker3D
104 6. Improve drawing and update of TMultiGraph
105 7. Reorganize 3D drawing of TH2/TH3 histograms, allow to mix 2D and 3D display together
106 8. Support overlay of 3D graphic over SVG canvas (used for IE)
107 9. Fix problems and improve flex(ible) layout
108 
109 
110 ## Changes in 4.0
111 1. New TGeo classes support:
112  - browsing through volumes hieararchy
113  - changing visibility flags
114  - drawing of selected volumes
115 2. New 'flex' layout:
116  - create frames like in Multi Document Interface
117  - one could move/resize/minimize/maximize such frames
118 3. Significant (factor 4) I/O performance improvement:
119  - use ArrayBuffer class in HTTP requests instead of String
120  - use native arrays (like Int32Array) for array data members
121  - highly optimize streamer infos handling
122 4. TH2 drawing optimization:
123  - if there are too many non-empty bins, combine them together
124  - when zoom-in, all original bins will be displayed separately
125  - let draw big TH2 histogram faster than in 1 sec
126  - optimization can be disabled by providing '&optimize=0' in URL
127 5. TF1 drawing optimization:
128  - function 'compiled' only once
129 6. Reorganize scripts structure:
130  - move all math functions to JSRootMath.js
131  - TH2, TF1, THStack and TMultiGraph painters moved into JSRootPainter.more.js script
132  - reduce size of scripts required for default functionality
133 7. Update all basic libraries:
134  - d3.js - v3.5.9,
135  - jquery.js - v2.1.4,
136  - jquery-ui.js - v1.11.4,
137  - three.js - r73
138 8. Implement ROOT6-like color palettes:
139  - all palettes in range 51...112 are implemented
140  - by default palette 57 is used
141  - one could change default palette with '&palette=111' in URL
142  - or palette can be specified in draw option like '&opt=colz,pal77'
143 
144 
145 ## Changes in 3.9
146 1. Support non-equidistant bins for TH1/TH2 objects.
147 2. Display entries count from histo.fEntries member, only when not set use computed value
148 3. Support italic and bold text when used with MathJax
149 4. Improve TF1 drawing - support exp function in TFormula, fix errors with logx scale, enable zoom-in, (re)calculate function points when zooming
150 5. Support several columns in TLegend
151 6. Introduce context menus for x/y axis, add some items similar to native ROOT menus
152 7. Introduce context menu for TPaveStats, let switch single elements in the box
153 8. Enable usage of all context menus on touch devices
154 9. Implement JSROOT.Math.Prob function, provides probability value in stat box
155 10. Introduce context menu for color palette (z axis)
156 11. Implement col0 and col0z draw option for TH2 histograms, similar to ROOT6
157 
158 
159 ## Changes in 3.8
160 1. Let use HTML element pointer in JSROOT.draw function like:
161  JSROOT.draw(document.getElementsByTagName("div")[0], obj, "hist");
162  Normally unique identifier was used before, which is not required any longer.
163  Of course, old functionality with element identifier will work as well.
164 2. TreePlayer can also be used for trees, which not yet read from the file.
165  Requires appropriate changes in TRootSniffer class.
166 3. Fix error in I/O with members like: `Double_t *fArr; //[fN]`
167 4. Introduce JSROOT.OpenFile function. It loads I/O functionality automatically,
168  therefore can be used directly after loading JSRootCore.js script
169 5. Same is done with JSROOT.draw function. It is defined in the JSRootCore.js
170  and can be used directly. Makes usage of JSROOT easier
171 6. Introduce JSRootPainter.more.js script, where painters for auxiliary classes
172  will be implemented.
173 7. Implement painter for TEllipse, TLine, TArrow classes
174 8. Fix several problems with markers drawing; implement plus, asterisk, mult symbols.
175 9. Implement custom layout, which allows to configure user-defined layout for displayed objects
176 10. Fix errors with scaling of axis labels.
177 11. Support also Y axis with custom labels like: http://jsroot.gsi.de/dev/?nobrowser&file=../files/atlas.root&item=LEDShapeHeightCorr_Gain0;1&opt=col
178 
179 
180 ## Changes in 3.7
181 1. Support of X axis with custom labels like: http://jsroot.gsi.de/dev/index.htm?nobrowser&json=../files/hist_xlabels.json
182 2. Extend functionality of JSROOT.addDrawFunc() function. One could register type-specific
183  `make_request` and `after_request` functions; `icon`, `prereq`, `script`, `monitor` properties.
184  This let add more custom elements to the generic gui, implemented with JSROOT.HierarchyPainter
185 3. Provide full support of require.js. One could load now JSRootCore.js script like:
186 
187  <script type="text/javascript" src="require.js" data-main="scripts/JSRootCore.js"></script>
188 
189  After this several modules are defined and can be used with syntax like:
190 
191  require(['JSRootPainter'], function(jsroot) { /*any user code*/});
192 
193  Also inside JSROOT require.js used to load all dependencies.
194 
195 
196 ## Changes in 3.6
197 1. Try to provide workaround for websites where require.js already loaded.
198  This makes problem by direct loading of jquery and jquery-ui
199 2. Provide workaround for older version of jquery-ui
200 3. Prompt for input of command arguments
201 4. After command execution one could automatically reload hierarchy (_hreload property) or
202  update view of displayed object (_update_item property)
203 5. Use HiearchyPainter for implementing draw.htm. This let us handle
204  all different kinds of extra attributes in central place
205 6. Fix problem in tabs layout - new tab should be add to direct child
206 7. When drawing several tabs, activate frame before drawing - only then
207  real frame size will be set
208 8. Fix problem with GetBBox - it only can be used for visible elements in mozilla.
209 9. Support drawing of fit parameters in stat box, use (as far as possible) stat and
210  fit format for statistic display
211 10. Implement 'g' formatting kind for stat box output - one need to checks
212  significant digits when producing output.
213 11. Support new draw options for TGraph: 'C', 'B1', '0', '2', '3', '4', '[]'
214 12. Primary support for STL containers in IO part. Allows to read ROOT6 TF1.
215 13. Full support of TGraphBentErrors
216 14. Support objects drawing from JSON files in default user interface, including
217  monitoring. One could open file from link like: https://root.cern.ch/js/dev/?json=demo/canvas_tf1.json
218 15. Introduce JSROOT.FFormat function to convert numeric values into string according
219  format like 6.4g or 5.7e. Used for statistic display.
220 
221 
222 ## Changes in 3.5
223 1. Fix error in vertical text alignment
224 2. Many improvements in TPaletteAxis drawing - draw label, avoid too large ticks.
225 3. Fix error with col drawing - bin with maximum value got wrong color
226 4. Test for existing jquery.js, jquery-ui.js and d3.js libraries, reuse when provided
227 5. Fix several I/O problems; now one could read files, produced in Geant4
228 6. Implement 'e2' drawing option for TH1 class,
229  use by default 'e' option when TH1 has non-empty fSumw2
230 7. Reuse statistic from histogram itself, when no axis selection done
231 8. Support log/lin z scale for color drawing
232 9. Implement interactive z-scale selection on TPaletteAxis
233 10. Allow to redraw item with other draw options (before one should clear drawings)
234 11. Several improvements in THttpServer user interface - repair hierarchy reload,
235  hide unsupported context menu entries, status line update
236 
237 
238 ## Changes in 3.4
239 1. Support usage of minimized versions of .js and .css files.
240  Minimized scripts used by default on web servers.
241 2. Implement JSROOT.extend instead of jQuery.extend, reduce
242  usage of jquery.js in core JSROOT classes
243 3. Implement main graphics without jquery at all,
244  such mode used in `nobrowser` mode.
245 4. Provide optional latex drawing with MathJax SVG.
246  TMathText always drawn with MathJax,
247  other classes require `mathjax` option in URL
248 5. Improve drawing of different text classes, correctly handle
249  their alignment and scaling, special handling for IE
250 6. Fix error with time axes - time offset was not correctly interpreted
251 
252 
253 ## Changes in 3.3
254 1. Use d3.time.scale for display of time scales
255 2. Within JSRootCore.js script URL one could specify JSROOT
256  functionality to be loaded: '2d', '3d', 'io', 'load', 'onload'.
257  Old method with JSROOT.AssertPrerequisites will also work.
258 3. With THttpServer JSROOT now provides simple control functionality.
259  One could publish commands and execute them from the browser
260 4. One could open several ROOT files simultaneously
261 5. Add 'simple' layout - drawing uses full space on the right side
262 6. Allow to open ROOT files in online session (via url parameter)
263 7. One could monitor simultaneously objects from server and root files
264 8. Implement 'autocol' draw option - when superimposing histograms,
265  their line colors will be automatically assigned
266 9. Implement 'nostat' draw option - disabled stat drawing
267 10. Using '_same_' identifier in item name, one can easily draw or superimpose
268  similar items from different files. Could be used in URL like:
269  `...&files=[file1.root,file2.root]&items=[file1.root/hpx, file2.root/_same_]`
270  `...&files=[file1.root,file2.root]&item=file1.root/hpx+file2.root/_same_`
271  Main limitation - file names should have similar length.
272 11. When 'autozoom' specified in draw options, histogram zoomed into
273  non-empty content. Same command available via context menu.
274 12. Item of 'Text' kind can be created. It is displayed as
275  plain text in the browser. If property 'mathjax' specified,
276  MathJax.js library will be loaded and used for rendering.
277  See httpcontrol.C macro for example.
278 13. When using foreignObject, provide workaround for absolute positioning
279  problem in Chrome/Safari, see <http://bit.ly/1wjqCQ9>
280 
281 
282 ## Changes in 3.2
283 1. Support JSON objects embedding in html pages, produced by THttpServer
284 2. For small resize of canvas use autoscale functionality of SVG. Only when
285  relative changes too large, redraw complete canvas again.
286 3. Use touch-punch.min.js to process touch events with jquery-ui
287 4. Even when several TH1/TGraph/TF1 objects with fill attribute overlap each other,
288  one able to get tooltip for underlying objects
289 5. Use jquery-ui menu for context menu
290 6. From context menu one could select several options for drawing
291 7. Provide user interface for executing TTree::Draw on THttpServer
292 8. 3D graphic (three.js) works only with IE11
293 
294 
295 ## Changes in 3.1
296 1. Correctly show tooltips in case of overlapped objects
297 2. Implement JSROOT.Create() method to create supported
298  in JavaScript ROOT classes like TH1 or TGraph
299 3. Fix problem with JSROOT.draw in HTML element with zero width (display:none)
300 4. Provide possibility to load user scripts with JSROOT.BuildSimpleGUI
301  and JSROOT.AssertPrerequisites, also with main index.htm
302 5. Support of TCutG drawing
303 6. Implement hierarchy display (former dtree) with jQuery
304 7. Fix several problems in drawing optimization
305 8. Implement dragging objects from hierarchy browser into existing canvas
306  to superimpose several objects
307 9. Implement col2 and col3 draw options, using html5 canvas
308 10. Support 'p' and 'p0' draw options for TH1 class
309 
310 
311 ## Development of version 3.0
312 
313 ### November 2014
314 1. Better font size and position in pave stats
315 2. Resize/move of element only inside correspondent pad
316 3. Adjust of frame size when Y-axis exceed pad limits
317 4. Correct values in tooltip for THStack
318 5. Exclude drawing of markers from TGraph outside visible range
319 6. Drawing of canvas without TFrame object
320 7. Many other small bug fixes and improvements, thanks to Maximilian Dietrich
321 
322 ### October 2014
323 1. Add "shortcut icon"
324 2. Add demo of online THttpServer - shell script copies data from
325  running httpserver.C macro on Apache webserver
326 3. Evaluate 'monitoring' parameter for online server like:
327  <http://localhost:8080/?monitoring=1000>
328  Parameter defines how often displayed objects should be updated.
329 4. Implement 'opt' and 'opts' URL parameters for main page.
330 5. Show progress with scripts loading in the browser window
331 6. When one appends "+" to the filename, its content read completely with first I/O operation.
332 7. Implement JS custom streamer for TCanvas, restore aspect ratio when drawing
333 8. Major redesign of drawing classes. Resize and update of TCanvas are implemented.
334  All major draw functions working with HTML element id as first argument.
335 9. Extract 3D drawings into separate JSRoot3DPainter.js script
336 10. Use newest three.min.js (r68) for 3D drawings, solves problem with Firefox.
337 11. Introduce generic list of draw functions for all supported classes.
338 12. Add possibility to 'expand' normal objects in the hierarchy browser.
339  For instance, this gives access to single elements of canvas,
340  when whole canvas cannot be drawn.
341 13. Correct usage of colors map, provided with TCanvas.
342 14. Introduce JSROOT.redraw() function which is capable to create or update object drawing.
343 15. In main index.htm page browser can be disabled (nobrowser parameter) and
344  page can be used to display only specified items from the file
345 16. Add support of TPolyMarker3D in binary I/O
346 
347 ### September 2014
348 1. First try to handle resize of the browser,
349  for the moment works only with collapsible layout
350 2. Also first try to interactively move separation line between
351  browser and drawing field.
352 3. Small fix of minor ticks drawing on the axis
353 4. Introduce display class for MDI drawing. Provide two implementations -
354  'collapsible' for old kind and 'tabs' for new kinds.
355 5. Adjust size of color palette drawing when labels would take more place as provided.
356 6. Add correct filling of statistic for TProfile,
357  fix small problem with underflow/overflow bins.
358 7. Provide way to select display kind ('collapsible', 'tabs') in the simple GUI.
359 8. Implement 'grid' display, one could specify any number of devision like
360  'grid 3x3' or 'grid 4x2'.
361 9. MDI display object created at the moment when first draw is performed.
362 10. Introduce painter class for TCanvas, support resize and update of canvas drawing
363 11. Resize almost works for all layouts and all objects kinds.
364 12. Implement JSROOT.GetUrlOption to extract options from document URL.
365 13. Provide example fileitem.htm how read and display item from ROOT file.
366 14. In default index.htm page one could specify 'file', 'layout',
367  'item' and 'items' parameters like:
368  <http://root.cern.ch/js/3.0/index.htm?file=../files/hsimple.root&layout=grid3x2&item=hpx;1>
369 15. Support direct reading of objects from sub-sub-directories.
370 16. Introduce demo.htm, which demonstrates online usage of JSROOT.
371 17. One could use demo.htm directly with THttpServer providing address like:
372  <http://localhost:8080/jsrootsys/demo/demo.htm?addr=../../Files/job1.root/hpx/root.json.gz&layout=3x3>
373 18. Also for online server process url options like 'item', 'items', 'layout'
374 19. Possibility to generate URL, which reproduces opened page with layout and drawn items
375 
376 ### August 2014
377 1. All communication between server and browser done with JSON format.
378 2. Fix small error in dtree.js - one should always set
379  last sibling (_ls) property while tree can be dynamically changed.
380 3. In JSRootCore.js provide central function, which handles different kinds
381  of XMLHttpRequest. Use only async requests, also when getting file header.
382 4. Fully reorganize data management in file/tree/directory/collection hierarchical
383  display. Now complete description collected in HPainter class and decoupled from
384  visualization, performed with dTree.js.
385 5. Remove all global variables from the code.
386 6. Automatic scripts/style loading handled via JSROOT.loadScript() function.
387  One can specify arbitrary scripts list, which asynchronously loaded by browser.
388 7. Method to build simple GUI changed and more simplified :). The example in index.htm.
389  While loadScript and AssertPrerequisites functions moved to JSROOT, one
390  can easily build many different kinds of GUIs, reusing provided JSRootCore.js functions.
391 8. In example.htm also use AssertPrerequisites to load necessary scripts.
392  This helps to keep code up-to-date even by big changes in JavaScript code.
393 9. Provide monitoring of online THttpServer with similar interface as for ROOT files.
394 10. Fix several errors in TKey Streamer, use member names as in ROOT itself.
395 11. Keep the only version identifier JSROOT.version for JS code
396 12. One can specify in JSROOT.AssertPrerequisites functionality which is required.
397  One could specify '2d', 'io' (default) or '3d'.
398 13. Use new AssertPrerequisites functionality to load only required functionality.
399 14. When displaying single element, one could specify draw options and monitor property like:
400  <http://localhost:8080/Files/job1.root/hpxpy/draw.htm?opt=col&monitor=2000>
401  Such link is best possibility to integrate display into different HTML pages,
402  using `<iframe/>` tag like:
403  `<iframe src="http://localhost:8080/Files/job1.root/hpx/draw.htm"`
404  `style="width: 800px; height:600px"></iframe>`
405 15. Remove 'JSROOTIO.' prefix from _typename. Now real class name is used.
406 16. Use in all scripts JSROOT as central 'namespace'
407 17. Introduce context menu in 3D, use it for switch between 2D/3D modes
408 18. Use own code to generate hierarchical structure in HTML, replace dtree.js which is
409  extremely slow for complex hierarchies. Dramatically improve performance for
410  structures with large (~1000) number of items.
411 19. Deliver to the server title of the objects, display it as hint in the browser.
412 20. Better handling of special characters in the hierarchies - allows to display
413  symbols like ' or " in the file structure.
414 
415 ### July 2014
416 1. Migration to d3.v3.js and jQuery v2.1.1
417 2. Fix errors in filling of histogram statbox
418 3. Possibility of move and resize of statbox, title, color palete
419 4. Remove many (not all) global variables
420 5. Example with direct usage of JSRootIO graphics
421 6. Example of inserting ROOT graphics from THttpServer into `<iframe></iframe>`
422 
423 ### May 2014
424 1. This JSRootIO code together with THttpServer class included
425  in ROOT repository
426 
427 ### March 2014
428 1. Introduce JSROOT.TBuffer class, which plays similar role
429  as TBuffer in native ROOT I/O. Simplifies I/O logic,
430  reduce duplication of code in many places, fix errors.
431  Main advantage - one could try to keep code synchronous with C++.
432 2. Avoid objects cloning when object referenced several times.
433 3. Treat special cases (collection, arrays) in one place.
434  This is major advantage, while any new classes need to be implemented only once.
435 4. Object representation, produced by JSRootIO is similar to
436  objects, produced by TBufferJSON class. By this one can exchange
437  I/O engine and use same JavaSctript graphic for display.
438 5. More clear functions to display different elements of the file.
439  In the future functions should be fully separated from I/O part
440  and organized in similar way as online part.
441 6. Eliminate usage of gFile pointer in the I/O part.
442 7. Provide TBufferJSON::JsonWriteMember method. It allows to stream any
443  selected data member of the class. Supported are:
444  basic data types, arrays of basic data types, TString, TArray classes.
445  Also any object as data member can be streamed.
446 8. TRootSniffer do not creates sublevels for base classes