xrview.notebook.NotebookTimeseriesViewer

class xrview.notebook.NotebookTimeseriesViewer(data, x, overlay='dims', glyphs='line', tooltips=None, tools=None, figsize=600, 300, ncols=1, palette=None, ignore_index=False, resolution=4, max_workers=10, lowpass=False, verbose=0, **fig_kwargs)

A notebook time-series viewer.

__init__(data, x, overlay='dims', glyphs='line', tooltips=None, tools=None, figsize=600, 300, ncols=1, palette=None, ignore_index=False, resolution=4, max_workers=10, lowpass=False, verbose=0, **fig_kwargs)

Constructor.

Parameters

dataxarray DataArray or Dataset

The data to display.

xstr

The name of the dimension in data that contains the x-axis values.

glyphsstr, BaseGlyph or iterable, default ‘line’

The glyph to use for plotting.

figsizeiterable, default (600, 300)

The size of the figure in pixels.

ncolsint, default 1

The number of columns of the layout.

overlay‘dims’ or ‘data_vars’, default ‘dims’

If ‘dims’, make one figure for each data variable and overlay the dimensions. If ‘data_vars’, make one figure for each dimension and overlay the data variables. In the latter case, all variables must have the same dimensions.

tooltipsdict, optional

Names of tooltips mapping to glyph properties or source columns, e.g. {‘datetime’: ‘@index{%F %T.%3N}’}.

toolsstr, optional

bokeh tool string.

paletteiterable, optional

The palette to use when overlaying multiple glyphs.

ignore_indexbool, default Falseh

If True, replace the x-axis values of the data by an appropriate evenly spaced index.

resolutionint, default 4

The number of points to render for each pixel.

max_workersint, default 10

The maximum number of workers in the thread pool to perform the down-sampling.

lowpassbool, default False

If True, filter the values with a low-pass filter before down-sampling.

verboseint, default 0

The level of verbosity.

Methods

__init__(data, x[, overlay, glyphs, …])	Constructor.
add_annotation(annotation[, onto])	Add an annotation to a figure in the layout.
add_figure(data[, glyphs, coords, name, …])	Add a figure to the layout.
add_interaction(interaction)	Add an interaction to the layout.
add_overlay(data[, glyphs, coords, name, …])	Add an overlay to a figure in the layout.
copy([with_data])	Create a copy of this instance.
export(filename[, mode])	Export the layout as as png or svg file.
make_doc()	Make the document.
make_layout()	Make the layout.
modify_figures(modifiers[, figures])	Modify the attributes of a figure.
on_reset(event)	Callback for reset event.
on_selected_points_change(attr, old, new)	Callback for selection event.
on_xrange_change(attr, old, new)	Callback for xrange change event.
reset_handlers()	Reset handlers.
show([notebook_url, port, remake_layout, …])	Show the app in a jupyter notebook.
update_handler(handler)	Update a single handler.
update_handlers([handlers])	Update handlers.
update_inplace(other)	Update this instance with the properties of another layout.

Attributes

default_tools