Home > @activeviam/activeui-sdk > RegressionChartOverlayParameters
RegressionChartOverlayParameters interface
An overlay displaying a line following a regression of a given type, calculated from the values of the measure being used for the y axis.
Signature:
export interface RegressionChartOverlayParameters
Remarks
Only available on charts having a x and y axis, and with y being numerical and x being a continuous axis (numerical or time). Different types of regressions are available through the type parameter.
Properties
| Property | Type | Description |
|---|---|---|
| color | string | The color of the regression line. |
| formatter | any | A formatter specification understood by d3: https://github.com/d3/d3-format/blob/master/README.md#api-reference This formatter is used to format the equation coefs + r^2, and X and Y when the chart scales have no formatters. |
| regressionParam | string | any | some optional parameter for the regression. It is used to pass the degree of the polynomial regression. |
| timeFormatter | any | A formatter used for the time in the tooltip, from the types.chartTimeFormatter plugin |
| type | 'linear' | 'linear-through-origin' | 'exponential' | 'logarithmic' | 'power-law' | 'polynomial' | The type of regression to use. |