Files
superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartdatarollingoptionsschema.Schema.json

80 lines
2.2 KiB
JSON

{
"schema": {
"properties": {
"center": {
"description": "Should the label be at the center of the window.Default: `false`",
"example": false,
"type": "boolean"
},
"min_periods": {
"description": "The minimum amount of periods required for a row to be included in the result set.",
"example": 7,
"type": "integer"
},
"rolling_type": {
"description": "Type of rolling window. Any numpy function will work.",
"enum": [
"average",
"argmin",
"argmax",
"cumsum",
"cumprod",
"max",
"mean",
"median",
"nansum",
"nanmin",
"nanmax",
"nanmean",
"nanmedian",
"nanpercentile",
"min",
"percentile",
"prod",
"product",
"std",
"sum",
"var"
],
"example": "percentile",
"type": "string"
},
"rolling_type_options": {
"description": "Optional options to pass to rolling method. Needed for e.g. quantile operation.",
"example": {},
"type": "object"
},
"win_type": {
"description": "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.",
"enum": [
"boxcar",
"triang",
"blackman",
"hamming",
"bartlett",
"parzen",
"bohman",
"blackmanharris",
"nuttall",
"barthann",
"kaiser",
"gaussian",
"general_gaussian",
"slepian",
"exponential"
],
"type": "string"
},
"window": {
"description": "Size of the rolling window in days.",
"example": 7,
"type": "integer"
}
},
"required": ["rolling_type", "window"],
"type": "object",
"title": "ChartDataRollingOptionsSchema"
},
"schemaType": "response"
}