xarray.IndexVariable.cumsum#
- IndexVariable.cumsum(dim=None, axis=None, skipna=None, **kwargs)[source]#
Apply cumsum along some dimension of IndexVariable.
- Parameters:
dim (
str
or sequence ofstr
, optional) – Dimension over which to apply cumsum.axis (
int
or sequence ofint
, optional) – Axis over which to apply cumsum. Only one of the ‘dim’ and ‘axis’ arguments can be supplied.skipna (
bool
, optional) – If True, skip missing values (as marked by NaN). By default, only skips missing values for float dtypes; other dtypes either do not have a sentinel missing value (int) or skipna=True has not been implemented (object, datetime64 or timedelta64).keep_attrs (
bool
, optional) – If True, the attributes (attrs) will be copied from the original object to the new one. If False (default), the new object will be returned without attributes.**kwargs (
dict
) – Additional keyword arguments passed on to cumsum.
- Returns:
cumvalue (
IndexVariable
) – New IndexVariable object with cumsum applied to its data along the indicated dimension.