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(*args, **kwargs)

Utility method to interactively add datasets to the data_collection.

do(command)

get_setting(key)

Fetch the value of an application setting

load_data(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(viewer_class[, data, state])

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

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.

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.

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

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(command)[source]
get_setting(key)[source]

Fetch the value of an application setting

load_data(paths, auto_merge=False, **kwargs)[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, state=None)[source]

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

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

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)[source]

Reload a previously-saved session

Parameters
pathstr

Path to the file to load

Returns
appApplication

The loaded application

save_session(path, include_data=False, absolute_paths=True)[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]