React PolarChart - valueAxis.constantLines

Defines an array of the value axis constant lines.

Type:

Array<Object>

Cannot be used in themes.

A constant line is a straight line that can be used to display, for example, an asymptote of a graph. To display constant lines on a chart, assign an array of objects specifying the options of each constant line to the constantLines field. It is necessary to set the value option within these objects. The other options can be set if required.

You can customize the appearance of all the value axis constant lines at once. For this purpose, use the valueAxis.constantLineStyle configuration object. Note that the options that are set within the valueAxis.constantLine object override the corresponding options that are set within the valueAxis.constantLineStyle object.

color

Specifies a color for a constant line.

Type:

String

Default Value: '#000000'

This option supports the following colors:

dashStyle

Specifies a dash style for a constant line.

Type:

String

Default Value: 'solid'
Accepted Values: 'dash' | 'dot' | 'longDash' | 'solid'

The following values are available.

  • solid
    Displays a solid, continuous constant line.
  • longDash
    Displays a constant line using long dashes.
  • dash
    Displays a constant line using dashes.
  • dot
    Displays a constant line using dots.
  • Any combination of 'longDash', 'dash' and 'dot'
    Displays a constant line by repeating the specified combination. For instance, 'dashdotdash'.

Use the DashStyle enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Solid, LongDash, Dash, and Dot.

label

An object defining constant line label options.

Type:

Object

A constant line label shows information on the constant line. You can configure label appearance using the label object. Within this object, you can set font options, a position and text using corresponding fields. In addition, you can specify the horizontal and vertical alignments for the label.

You can set the label options for all the value axis constant lines together. For this purpose, use the valueAxis.constantLineStyle.label object. Note that the options that are set within the valueAxis.constantLine.label object override the corresponding options that are set within the valueAxis.constantLineStyle.label object.

value

Specifies a value to be displayed by a constant line.

Type:

Number

|

Date

|

String

Default Value: undefined

width

Specifies a constant line width in pixels.

Type:

Number

Default Value: 1