-
Notifications
You must be signed in to change notification settings - Fork 0
/
galyleo_jupyterlab_client.html
68 lines (62 loc) · 4.76 KB
/
galyleo_jupyterlab_client.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module galyleo_jupyterlab_client</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>galyleo_jupyterlab_client</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/rick/Projects/engageLively/el-galyleo-client/galyleo/galyleo_jupyterlab_client.py">/Users/rick/Projects/engageLively/el-galyleo-client/galyleo/galyleo_jupyterlab_client.py</a></font></td></tr></table>
<p><tt># BSD 3-Clause License</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="galyleo_jupyterlab_client.html#GalyleoClient">GalyleoClient</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="GalyleoClient">class <strong>GalyleoClient</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The Dashboard Client. This is the client which sends the tables to the dashboard<br>
and handles requests coming from the dashboard for tables.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="GalyleoClient-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Initialize the client. No parameters. This initializes communications with the JupyterLab Galyleo Communications Manager</tt></dd></dl>
<dl><dt><a name="GalyleoClient-send_data_to_dashboard"><strong>send_data_to_dashboard</strong></a>(self, galyleo_table, dashboard_name: str = None) -> None</dt><dd><tt>The routine to send a GalyleoTable to the dashboard, optionally specifying a specific <br>
dashboard to send the data to. If None is specified, sends to all the dashboards.<br>
The table must not have more than galyleo_constants.MAX_NUMBER_ROWS, nor be (in JSON form) > galyleo_constants.MAX_DATA_SIZE. <br>
If either of these conditions apply, a DataSizeExceeded exception is thrown.<br>
NOTE: this sends data to one or more open dashboard editors in JupyterLab. If there are no dashboard editors open, it will have no effect.<br>
<br>
Args:<br>
galyleo_table: the table to send to the dashboard<br>
dashboard_name: name of the dashboard editor to send it to (if None, sent to all)</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>MAX_DATA_SIZE</strong> = 16777216<br>
<strong>MAX_TABLE_ROWS</strong> = 1000000</td></tr></table>
</body></html>