Attention: The Collaboratory IAM will down for up to 1 hour on Monday, the 7th of July 2025 starting from 5pm CEST (my timezone) for up to 1 hour. Any and all services, which require a user login with an EBRAINS account, will be un-available during that time


Changes for page Widget TimeSeries

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

From version 11.1
edited by rominabaila
on 2022/04/12 09:30
Change comment: There is no comment for this version
To version 15.1
edited by rominabaila
on 2022/04/12 11:31
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -36,9 +36,46 @@
36 36  )))
37 37  )))
38 38  
39 -Then, to install the tvb-widgets library just type:
39 +Then, to install the tvb-widgets library, just type:
40 40  
41 41  (% class="box" %)
42 42  (((
43 43  pip install tvb-widgets
44 44  )))
45 +
46 +
47 +== API usage ==
48 +
49 +First, the correct matplotlib backend must be set, which enables the interaction with the TimeSeries widget, by running the following command:
50 +
51 +(% class="box" %)
52 +(((
53 +%matplotlib widget
54 +)))
55 +
56 + Then, the TimeSeries widget (from the tvb-widgets API) and the display function should be imported:
57 +
58 +(% class="box" %)
59 +(((
60 +from tvbwidgets.api import TimeSeriesWidget
61 +from IPython.core.display_functions import display
62 +)))
63 +
64 +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):
65 +
66 +(% class="box" %)
67 +(((
68 +tsw = TimeSeriesWidget()
69 +tsw.add_datatype(tsr)
70 +)))
71 +
72 +Finally, to display and interact with the TimeSeries widget, the **//get_widget//**// //method is used inside the //**display **//function:
73 +
74 +(% class="box" %)
75 +(((
76 +display(tsw.get_widget())
77 +)))
78 +
79 +{{html}}
80 +<iframe src="https://drive.google.com/file/d/1g4ryY1VIFMUD14Mb6Dq_KVb0b2_XU4VX/preview" width="840" height="480" allow="autoplay"></iframe>
81 +{{/html}}
Public

TVB Widgets