Home > @activeviam/activeui-sdk > ConstantChartOverlayParameters
ConstantChartOverlayParameters interface
An overlay that displays a line of constant value. Only available on charts with an x and y axis, and with y being a numerical axis.
Signature:
export interface ConstantChartOverlayParameters
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. |
timeFormatter | any | A formatter used for the time in the tooltip, from the types.chartTimeFormatter plugin. |
value | number | The value to use for the regression line. Defaults to 0. |