React Chart - crosshair.horizontalLine

Configures the horizontal crosshair line individually.

Type:

Object

|

Boolean

Crosshair lines can be configured using the following objects.

  • crosshair.horizontalLine
    Configures the horizontal crosshair line only.

  • crosshair.verticalLine
    Configures the vertical crosshair line only.

  • crosshair
    Configures both the crosshair lines.

Options declared in the horizontalLine and verticalLine objects override the options declared in the crosshair object.

NOTE
Instead of an object, you can assign a Boolean value to the horizontalLine field. This value will control the visibility of the horizontal crosshair line.

color

Specifies the color of the horizontal crosshair line.

Type:

String

Default Value: '#f05b41'

This option supports the following colors:

dashStyle

Specifies the dash style of the horizontal crosshair line.

Type:

String

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

This option accepts one of the following values.

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

When using the widget as an ASP.NET MVC Control, specify this option using the DashStyle enum. This enum accepts the following values: Solid, LongDash, Dash and Dot.

label

Configures the label that belongs to the horizontal crosshair line.

Type:

Object

Crosshair labels can be configured using the following objects.

  • crosshair.horizontalLine.label
    Configures the label of the horizontal crosshair line only.

  • crosshair.verticalLine.label
    Configures the label of the vertical crosshair line only.

  • crosshair.label
    Configures both the labels.

These objects have identical structure, but the label settings declared in the horizontalLine or verticalLine object override the label settings declared directly in the crosshair object.

See Also
  • crosshair.verticalLine.label - configures the label that belongs to the vertical crosshair line.

opacity

Specifies how transparent the horizontal crosshair line should be.

Type:

Number

Default Value: undefined

This option accepts a value from 0 to 1, where 0 makes the horizontal crosshair line completely transparent, and 1 makes it opaque.

visible

Specifies whether to show the horizontal crosshair line or not.

Type:

Boolean

Default Value: true

See Also
  • crosshair.enabled - enables the crosshair feature.

width

Specifies the width of the horizontal crosshair line in pixels.

Type:

Number

Default Value: 1