API Documentation¶

General¶

glue_jupyter Package¶

Functions¶

`jglue`(\args, \\*kwargs)	Create a new Jupyter-based glue application.
`example_data_xyz`([seed, N, loc, scale, label])	Create an example dataset with three attributes x, y, and z set to random values.
`example_image`([shape, limits])	Creates a test 2-d dataset containing an image.
`example_volume`([shape, limits])	Creates a test 3-d dataset containing a ball.
`set_layout_factory`(func)	Set the function to use to generate the viewer layout.
`get_layout_factory`()	Get the current layout factory.

Classes¶

JupyterApplication([data_collection, session])

The main Glue application object for the Jupyter environment.

glue_jupyter.app Module¶

Classes¶

JupyterApplication([data_collection, session])

The main Glue application object for the Jupyter environment.

glue_jupyter.link Module¶

Functions¶

`calculation`(inputs[, output, initial_calulation])
`link_component_id_to_select_widget`(state, …)
`on_change`(inputs[, initial_call, once])

Classes¶

`dlink`(source, target[, f1])
`link`(source, target[, f1, f2])

glue_jupyter.view Module¶

Classes¶

`IPyWidgetView`(args, *kwargs)
`IPyWidgetLayerArtistContainer`()

glue_jupyter.common.state3d Module¶

Classes¶

`ViewerState3D`(**kwargs)	A common state object for all 3D viewers
`VolumeViewerState`(**kwargs)
`Scatter3DViewerState`(**kwargs)

glue_jupyter.common.state_widgets Package¶

Classes¶

`HistogramLayerStateWidget`(layer_state)
`HistogramViewerStateWidget`(viewer_state)
`ImageLayerStateWidget`(layer_state)
`ImageSubsetLayerStateWidget`(layer_state)
`ImageViewerStateWidget`(viewer_state)
`ProfileLayerStateWidget`(layer_state)
`ProfileViewerStateWidget`(viewer_state)
`ScatterLayerStateWidget`(layer_state)
`ScatterViewerStateWidget`(viewer_state)

glue_jupyter.compat Module¶

Classes¶

LayerArtist(viewer_state[, layer_state, layer])

bqplot viewers¶

glue_jupyter.bqplot.common Package¶

Classes¶

BqplotBaseView(session[, state])

glue_jupyter.bqplot.histogram Package¶

Classes¶

`BqplotHistogramLayerArtist`(view, viewer_state)
`BqplotHistogramView`(session[, state])

glue_jupyter.bqplot.image Package¶

Classes¶

`BqplotImageLayerArtist`(axes, viewer_state[, …])
`BqplotImageSubsetLayerArtist`(view, viewer_state)
`BqplotImageView`(session)

glue_jupyter.bqplot.profile Package¶

Classes¶

`BqplotProfileLayerArtist`(view, viewer_state)
`BqplotProfileView`(session[, state])

glue_jupyter.bqplot.scatter Package¶

Classes¶

`BqplotScatterLayerArtist`(view, viewer_state)
`BqplotScatterLayerState`([viewer_state, layer])
`BqplotScatterView`(session[, state])

ipyvolume viewers¶

glue_jupyter.ipyvolume.common Package¶

Classes¶

`IpyvolumeBaseView`(args, *kwargs)
`Viewer3DStateWidget`(viewer_state)

glue_jupyter.ipyvolume.scatter Package¶

Classes¶

`IpyvolumeScatterLayerArtist`(view, …)
`IpyvolumeScatterView`(args, *kwargs)
`Scatter3DLayerState`([viewer_state, layer])
`Scatter3DLayerStateWidget`(layer_state)

glue_jupyter.ipyvolume.volume Package¶

Classes¶

`IpyvolumeVolumeView`(args, *kwargs)
`Volume3DLayerStateWidget`(layer_state)
`VolumeLayerState`([layer])