Interface ChartOverlayXYProps

Hierarchy

  • ChartOverlayXYProps

Properties

height onMouseMove? onMouseOut? timeseriesList width xScale yScale

Properties

height

height: number

Height of the overlay area.

Optional onMouseMove

onMouseMove?: ((pointInfo: HoveredPointInfo) => void)

Type declaration

    • (pointInfo: HoveredPointInfo): void

    • Callback fired when the cursor moves over the overlay.

      Parameters

      Returns void

Optional onMouseOut

onMouseOut?: (() => void)

Type declaration

    • (): void

    • Callback fired when the cursor leaves the overlay area.

      Returns void

timeseriesList

timeseriesList: Timeseries<number>[]

Array of timeseries objects that contain the hoverable points. The component receives a list of timeseries to make it easier to know which series was hovered (not only which point).

width

width: number

Width of the overlay area.

xScale

xScale: ScaleTime<number, number, never>

d3-scale to convert between date points and pixel positions.

yScale

yScale: ScaleLinear<number, number, never>

d3-scale to convert between numerical points and pixel positions.

Settings

Member Visibility

Theme

Generated using TypeDoc