Interface ChartOverlayXProps

Hierarchy

  • ChartOverlayXProps

Properties

height offset? onMouseLeave onMouseMove width xScale

Properties

height

height: number

Height of the overlay area.

Optional offset

offset?: number

Offset of the overlay relative to the containing SVG element.

Default

0

onMouseLeave

onMouseLeave: (() => void)

Type declaration

    • (): void

    • Callback fired when the cursor leaves the overlay area.

      Returns void

onMouseMove

onMouseMove: ((date: {
    date: Date;
}) => void)

Type declaration

    • (date: {
          date: Date;
      }): void

    • Callback fired when the cursor moves over the overlay.

      Parameters

      • date: {
            date: Date;
        }

        The date being hovered.

        • date: Date

      Returns void

width

width: number

Width of the overlay area.

xScale

xScale: ScaleTime<number, number, never>

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

Settings

Member Visibility

Theme

Generated using TypeDoc