Skip to main content
Version: Next

ChartDataRollingOptionsSchema

centerboolean

Should the label be at the center of the window.Default: false

Example: false
min_periodsinteger

The minimum amount of periods required for a row to be included in the result set.

Example: 7
rolling_typestringrequired

Type of rolling window. Any numpy function will work.

Possible values: [average, argmin, argmax, cumsum, cumprod, max, mean, median, nansum, nanmin, nanmax, nanmean, nanmedian, nanpercentile, min, percentile, prod, product, std, sum, var]

Example: percentile
rolling_type_optionsobject

Optional options to pass to rolling method. Needed for e.g. quantile operation.

Example: {}
win_typestring

Type of window function. See [SciPy window functions](https://docs.scipy.org/doc/scipy/reference /signal.windows.html#module-scipy.signal.windows) for more details. Some window functions require passing additional parameters to rolling_type_options. For instance, to use gaussian, the parameter std needs to be provided.

Possible values: [boxcar, triang, blackman, hamming, bartlett, parzen, bohman, blackmanharris, nuttall, barthann, kaiser, gaussian, general_gaussian, slepian, exponential]

windowintegerrequired

Size of the rolling window in days.

Example: 7
ChartDataRollingOptionsSchema
{
"center": false,
"min_periods": 7,
"rolling_type": "percentile",
"rolling_type_options": {},
"win_type": "boxcar",
"window": 7
}