plopp.slicer#
- plopp.slicer(obj, *, keep=None, autoscale='auto', coords=None, vmin=None, vmax=None, **kwargs)[source]#
Plot a multi-dimensional object by slicing one or more of the dimensions. This will produce one slider per sliced dimension, below the figure.
- Parameters:
obj (
Union
[Variable
,DataArray
,Dataset
,DataGroup
,ndarray
,Node
,Dict
[str
,Union
[Variable
,DataArray
,Dataset
,DataGroup
,ndarray
,Node
]]]) – The object to be plotted.keep (
Optional
[List
[str
]], default:None
) – The dimensions to be kept, all remaining dimensions will be sliced. This should be a list of dims. If no dims are provided, the last dim will be kept in the case of a 2-dimensional input, while the last two dims will be kept in the case of higher dimensional inputs.autoscale (
Literal
['auto'
,'grow'
,'fixed'
], default:'auto'
) – The behavior of the y-axis (1d plots) and color range (2d plots) limits. Ifauto
, the limits automatically adjusts every time the data changes. Ifgrow
, the limits are allowed to grow with time but they do not shrink. Iffixed
, the limits are fixed to the full data range and do not change with time.coords (
Optional
[List
[str
]], default:None
) – If supplied, use these coords instead of the input’s dimension coordinates.vmin (
Union
[Variable
,DataArray
,Dataset
,DataGroup
,int
,float
,None
], default:None
) – The minimum value of the y-axis (1d plots) or color range (2d plots).vmax (
Union
[Variable
,DataArray
,Dataset
,DataGroup
,int
,float
,None
], default:None
) – The maximum value of the y-axis (1d plots) or color range (2d plots).**kwargs – See
plopp.plot()
for the full list of figure customization arguments.
- Return type:
FigureLike