Changes for page Widget TimeSeries

Last modified by ldomide on 2023/05/23 14:34

From version 33.1
edited by rominabaila
on 2023/05/15 11:06
Change comment: There is no comment for this version
To version 35.1
edited by rominabaila
on 2023/05/15 11:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -6,7 +6,7 @@
6 6  
7 7  == Purpose ==
8 8  
9 -It is a Jupyter Widget intended for the visualization of brain signals represented as time series.
9 +It is a JupyterLab Widget intended for the visualization of brain signals represented as time series.
10 10  
11 11  == Backends ==
12 12  
... ... @@ -75,28 +75,25 @@
75 75  %matplotlib widget
76 76  )))
77 77  
78 - Then, the **TimeSeriesWidget** (from the tvb-widgets API) and the **//display//** function should be imported:
78 +Then, simply import the **plot_timeseries** method, which gives you access to the TS widget:
79 79  
80 80  (% class="box" %)
81 81  (((
82 -from tvbwidgets.api import TimeSeriesWidget
83 -from IPython.core.display_functions import display
82 +from tvbwidgets.api import plot_timeseries
84 84  )))
85 85  
86 -Assuming that the user has already created or imported a valid input, this is how the widget can be initialized and how an input can be assigned to it, using the //**add_datatype** //method (example below assumes that **//tsr//  **is a TVB TimeSeries datatype):
87 87  
86 +Assuming that the user has already created or imported a valid input, this is how the widget can be initialized and displayed (example below assumes that **tsr  **is a TVB TimeSeries datatype):
87 +
88 88  (% class="box" %)
89 89  (((
90 -tsw = TimeSeriesWidget()
91 -tsw.add_datatype(tsr)
90 +backend = 'plotly' # change to 'matplotlib' to see the other TS widget
91 +
92 +plot_timeseries(data=tsr, backend=backend)
92 92  )))
93 93  
94 -Finally, to display and interact with the TimeSeries widget, the **//get_widget//**// //method is used inside the //**display **//function:
95 +After running the code from above into a Jupyter cell, you should see the TS widget corresponding to the backend you selected.
95 95  
96 -(% class="box" %)
97 -(((
98 -display(tsw)
99 -)))
100 100  
101 101  {{html}}
102 102  <iframe width="840" height="480" src="https://www.youtube.com/embed/VmueiXMxbVk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
Public

TVB Widgets