xrview.notebook.NotebookPlot.add_overlay¶
-
NotebookPlot.
add_overlay
(data, glyphs='line', coords=None, name=None, onto=None)¶ Add an overlay to a figure in the layout.
- Parameters
- dataxarray.DataArray
The data to display.
- glyphsstr, BaseGlyph or iterable thereof, default ‘line’
The glyph (or glyphs) to display.
- coordsiterable of str, optional
The coordinates of the DataArray to include. This is necessary for composite glyphs such as BoxWhisker.
- namestr, optional
The name of the DataArray which will be used to identify the overlay. If not provided, the name of the DataArray will be used.
- ontostr or int, optional
Title or index of the figure on which the element will be overlaid. By default, the element is overlaid on all figures.