Home > @activeviam/activeui-sdk > LinearChartOverlayParameters
LinearChartOverlayParameters interface
An overlay displaying a line following the equation y = mx + b. Only available on charts with an x and y axis, and with y being a numerical axis.
Signature:
export interface LinearChartOverlayParameters
Properties
| Property | Type | Description |
|---|---|---|
| b | number | the b parameter, as in y = mx + b. Defaults to 0 |
| bStep | number | The step for the UI control for b. Defaults to 1 |
| 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. |
| m | number | the m parameter, as in y = mx + b. Defaults to 0 |
| mStep | number | The step for the UI control for m. Defaults to 0.1 |
| timeFormatter | any | A formatter used for the time in the tooltip, from the types.chartTimeFormatter plugin |