Application

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

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(self, \*args, \*\*kwargs)	Add data to the session.
add_datasets(self, \*args, \*\*kwargs)	Utility method to interactively add datasets to the data_collection.
do(self, command)
get_setting(self, key)	Fetch the value of an application setting
load_data(self, paths[, auto_merge])	Given a path to a file, load the file as a Data object and add it to the current session.
new_data_viewer(self, viewer_class[, data, …])	Create a new data viewer, add it to the UI, and populate with data
redo(self)
report_error(self, message, detail)	Report an error message to the user.
restore_session(path)	Reload a previously-saved session
save_session(self, path[, include_data, …])	Save the data collection and hub to file.
set_data_color(self, color, alpha)	Reset all the data colors to that specified.
set_setting(self, key, value)	Set the value of an application setting
undo(self)

Attributes Documentation

data_collection

session

settings

Iterate over settings

viewers

Return a tuple of tuples of viewers currently open.

Methods Documentation

add_data(self, *args, **kwargs)

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.

add_datasets(self, *args, **kwargs)

Utility method to interactively add datasets to the data_collection.

Parameters

datasetsData or list of Data

One or more Data instances.

Adds datasets to the collection in the application.

do(self, command)

get_setting(self, key)

Fetch the value of an application setting

load_data(self, paths, auto_merge=False, **kwargs)

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(self, viewer_class, data=None, state=None)

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

redo(self)

report_error(self, message, detail)

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

Parameters

messagestr

The message to display

detailstr

Longer context about the error

static restore_session(path)

Reload a previously-saved session

Parameters

pathstr

Path to the file to load

Returns

appApplication

The loaded application

save_session(self, path, include_data=False, absolute_paths=True)

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(self, color, alpha)

Reset all the data colors to that specified.

set_setting(self, key, value)

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(self)