trajan.animation.Animation.overlay_variable#
- animation.Animation.overlay_variable(data, cmap='viridis', alpha=0.5, vmin=None, vmax=None, label=None)#
Overlay an animated gridded variable as a background field.
- Parameters:
data (
xarray.DataArray) – Must have atimedimension andlat/lon(orlatitude/longitude) coordinates.cmap (
strorColormap, optional)alpha (
float, optional)vmin, vmax (
float, optional)label (
str, optional) – Colorbar label.
- Returns:
self