Packages

object PlotOptionsWaterfallTooltip

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlotOptionsWaterfallTooltip
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def apply(dateTimeLabelFormats: UndefOr[Object] = js.undefined, followPointer: UndefOr[Boolean] = js.undefined, followTouchMove: UndefOr[Boolean] = js.undefined, footerFormat: UndefOr[String] = js.undefined, headerFormat: UndefOr[String] = js.undefined, hideDelay: UndefOr[Double] = js.undefined, padding: UndefOr[Double] = js.undefined, pointFormat: UndefOr[String] = js.undefined, pointFormatter: UndefOr[Function] = js.undefined, split: UndefOr[Boolean] = js.undefined, valueDecimals: UndefOr[Double] = js.undefined, valuePrefix: UndefOr[String] = js.undefined, valueSuffix: UndefOr[String] = js.undefined, xDateFormat: UndefOr[String] = js.undefined): PlotOptionsWaterfallTooltip

    dateTimeLabelFormats

    For series on a datetime axes, the date format in the tooltip's header will by default be guessed based on the closest data points. This member gives the default string representations used for each unit. For an overview of the replacement codes, see dateFormat.. . Defaults to:. 

    {.     millisecond:"%A, %b %e, %H:%M:%S.%L",.     second:"%A, %b %e, %H:%M:%S",.     minute:"%A, %b %e, %H:%M",.     hour:"%A, %b %e, %H:%M",.     day:"%A, %b %e, %Y",.     week:"Week from %A, %b %e, %Y",.     month:"%B %Y",.     year:"%Y". }

    followPointer

    Whether the tooltip should follow the mouse as it moves across columns, pie slices and other point types with an extent. By default it behaves this way for scatter, bubble and pie series by override in the plotOptions for those series types. . For touch moves to behave the same way, followTouchMove must be true also.

    followTouchMove

    Whether the tooltip should follow the finger as it moves on a touch device. If this is true and chart.panning is set,followTouchMove will take over one-finger touches, so the user needs to use two fingers for zooming and panning.

    footerFormat

    A string to append to the tooltip format.

    headerFormat

    The HTML of the tooltip header line. Variables are enclosed by curly brackets. Available variables are point.key, series.name, series.color and other members from the point and series objects. The point.key variable contains the category name, x value or datetime string depending on the type of axis. For datetime axes, the point.key date format can be set using tooltip.xDateFormat.. . Defaults to <span style="font-size: 10px">{point.key}</span><br/>

    hideDelay

    The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.

    padding

    Padding inside the tooltip, in pixels.

    pointFormat

    The HTML of the point's line in the tooltip. Variables are enclosed by curly brackets. Available variables are point.x, point.y, series.name and series.color and other properties on the same form. Furthermore, point.y can be extended by the tooltip.valuePrefix and tooltip.valueSuffix variables. This can also be overridden for each series, which makes it a good hook for displaying units.. In styled mode, the dot is colored by a class name rather than the point color.

    pointFormatter

    A callback function for formatting the HTML output for a single point in the tooltip. Like the pointFormat string, but with more flexibility.

    split

    Split the tooltip into one label per series, with the header close to the axis. This is recommended over shared tooltips for charts with multiple line series, generally making them easier to read.

    valueDecimals

    How many decimals to show in each series' y value. This is overridable in each series' tooltip options object. The default is to preserve all decimals.

    valuePrefix

    A string to prepend to each series' y value. Overridable in each series' tooltip options object.

    valueSuffix

    A string to append to each series' y value. Overridable in each series' tooltip options object.

    xDateFormat

    The format for the date in the tooltip header if the X axis is a datetime axis. The default is a best guess based on the smallest distance between points in the chart.