Application

class glue.core.application_base.Application(data_collection=None, session=None)[source]

Bases: glue.core.hub.HubListener

Attributes Summary

data_collection
session
settings Iterate over settings
viewers Return a tuple of tuples of viewers currently open

Methods Summary

add_data(*args, **kwargs) Add data to the session.
add_datasets(data_collection, datasets[, …]) Utility method to interactively add datasets to a
add_widget(widget[, label, tab])
close_tab()
do(command)
get_setting(key) Fetch the value of an application setting
load_data(path) Given a path to a file, load the file as a Data object and add it to the current session.
new_data_viewer(viewer_class[, data]) Create a new data viewer, add it to the UI,
new_tab()
redo()
report_error(message, detail) Report an error message to the user.
restore_session(path) Reload a previously-saved session
save_session(path[, include_data]) Save the data collection and hub to file.
set_data_color(color, alpha) Reset all the data colors to that specified.
set_setting(key, value) Set the value of an application setting
undo()

Attributes Documentation

data_collection[source]
session[source]
settings[source]

Iterate over settings

viewers[source]

Return a tuple of tuples of viewers currently open The i’th tuple stores the viewers in the i’th close_tab

Methods Documentation

add_data(*args, **kwargs)[source]

Add data to the session.

Positional arguments are interpreted using the data factories, while keyword arguments are interpreted using the same infrastructure as the qglue command.

This returns a list of added Data objects.

classmethod add_datasets(data_collection, datasets, auto_merge=False)[source]

Utility method to interactively add datasets to a data_collection

Parameters:

data_collection : DataCollection

datasets : Data or list of Data

One or more Data instances

Adds datasets to the collection

add_widget(widget, label=None, tab=None)[source]
close_tab()[source]
do(command)[source]
get_setting(key)[source]

Fetch the value of an application setting

load_data(path)[source]

Given a path to a file, load the file as a Data object and add it to the current session.

This returns the added Data object.

new_data_viewer(viewer_class, data=None)[source]

Create a new data viewer, add it to the UI, and populate with data

new_tab()[source]
redo()[source]
report_error(message, detail)[source]

Report an error message to the user. Must be implemented in a subclass

Parameters:

message : str

The message to display

detail : str

Longer context about the error

static restore_session(path)[source]

Reload a previously-saved session

Parameters:

path : str

Path to the file to load

Returns:

app : Application

The loaded application

save_session(path, include_data=False)[source]

Save the data collection and hub to file.

Can be restored via restore_session

Note: Saving of client is not currently supported. Thus, restoring this session will lose all current viz windows

set_data_color(color, alpha)[source]

Reset all the data colors to that specified.

set_setting(key, value)[source]

Set the value of an application setting

Raises a KeyError if the setting does not exist Raises a ValueError if the value is invalid

undo()[source]