ActiveUI

ActiveUI

  • User Guide
  • Developer Documentation

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

PropertyTypeDescription
colorstringThe color of the regression line.
formatteranyA 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.
timeFormatteranyA formatter used for the time in the tooltip, from the types.chartTimeFormatter plugin.
valuenumberThe value to use for the regression line. Defaults to 0.
  • ConstantChartOverlayParameters interface
  • Properties
Copyright © 2019 ActiveViam