Experimental
rerun.experimental
Experimental features for Rerun.
These features are not yet stable and may change in future releases without going through the normal deprecation cycle.
class ViewerClient
A connection to an instance of a Rerun viewer.
Warning
This API is experimental and may change or be removed in future versions.
def __init__(addr='127.0.0.1:9876')
Create a new viewer client connection.
| PARAMETER | DESCRIPTION |
|---|---|
addr
|
The address of the viewer to connect to, in the format "host:port". Defaults to "127.0.0.1:9876" for a local viewer.
TYPE:
|
def save_screenshot(file_path, view_id=None)
Save a screenshot to a file.
Warning
This API is experimental and may change or be removed in future versions.
| PARAMETER | DESCRIPTION |
|---|---|
file_path
|
The path where the screenshot will be saved. Important This path is relative to the viewer's filesystem, not the client's. If your viewer runs on a different machine, the screenshot will be saved there.
TYPE:
|
view_id
|
Optional view ID to screenshot. If None, screenshots the entire viewer. |
def send_table(name, table)
Send a table to the viewer.
A table is represented as a dataframe defined by an Arrow record batch.
| PARAMETER | DESCRIPTION |
|---|---|
name
|
The table name. Note The table name serves as an identifier. If you send a table with the same name twice, the second table will replace the first one.
TYPE:
|
table
|
The Arrow RecordBatch containing the table data to send.
TYPE:
|