Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TooltipOptions

Hierarchy

Index

Properties

Properties

Optional customHTML

customHTML: Function

custom function for returning tooltip HTML passed an array or object with the data, and then the default tooltip markup

Optional datapoint

datapoint: object

options to configure the datapoint tooltip

Type declaration

  • Optional enabled?: boolean

    toggles on/off datapoint tooltips.

  • Optional horizontalOffset?: number

    offset of the tooltip from the mouse position

  • Optional verticalOffset?: number

    vertical offset for tooltip placement

Optional formatter

formatter: Function

a function to format the tooltip values

Optional title

title: object

Type declaration

  • Optional verticalOffset?: number

    vertical offset for title tooltip placement. < 0 will shift the tooltip above title, > 0 shifts vertically down

  • Optional width?: number

    max width of title tooltip relative to the width of the chart-svg (percentage should be < 1)

Generated using TypeDoc