Packages

class SeriesAreaTooltip extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: series<area>-tooltip

Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SeriesAreaTooltip
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SeriesAreaTooltip()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val changeDecimals: UndefOr[Double]

    How many decimals to show for the point.change value when the series.compare option is set.

    How many decimals to show for the point.change value when the series.compare option is set. This is overridable in each series' tooltip options object. The default is to preserve all decimals.

    Since

    1.0.1

  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val dateTimeLabelFormats: UndefOr[Object]

    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.

    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"
}

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. val followPointer: UndefOr[Boolean]

    Whether the tooltip should follow the mouse as it moves across columns, pie slices and other point types with an extent.

    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.

    Since

    1.3

  12. val followTouchMove: UndefOr[Boolean]

    Whether the tooltip should follow the finger as it moves on a touch device.

    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.

    Since

    1.3.1

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  14. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  16. val headerFormat: UndefOr[String]

    The HTML of the tooltip header line.

    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/>

    Example:

    1. A HTML table in the tooltip

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  22. val padding: UndefOr[Double]

    Padding inside the tooltip, in pixels.

    Padding inside the tooltip, in pixels.

    Since

    5.0.0

  23. val pointFormat: UndefOr[String]

    The HTML of the point's line in the tooltip.

    The HTML of the point's line in the tooltip. Variables are enclosed by curly brackets. Available variables are point.x, point.y, point.change, 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.

  24. val pointFormatter: UndefOr[Function]

    A callback function for formatting the HTML output for a single point in the tooltip.

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

    Since

    2.1.0

  25. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  26. val shape: UndefOr[String]

    The name of a symbol to use for the border around the tooltip.

    The name of a symbol to use for the border around the tooltip. In Highstock 1.x, the shape was square.

    Since

    2.0

  27. val split: UndefOr[Boolean]

    Split the tooltip into one label per series, with the header close to the axis.

    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.

    Example:

    1. Split tooltip

    Since

    5.0.0

  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toLocaleString(): String
    Definition Classes
    Object
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. val valueDecimals: UndefOr[Double]

    How many decimals to show in each series' y value.

    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.

    Example:

    1. Set decimals, prefix and suffix for the value

    Since

    1.2

  32. def valueOf(): Any
    Definition Classes
    Object
  33. val valuePrefix: UndefOr[String]

    A string to prepend to each series' y value.

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

    Example:

    1. Set decimals, prefix and suffix for the value

    Since

    1.2

  34. val valueSuffix: UndefOr[String]

    A string to append to each series' y value.

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

    Example:

    1. Set decimals, prefix and suffix for the value

    Since

    1.2

  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. val xDateFormat: UndefOr[String]

    The format for the date in the tooltip header.

    The format for the date in the tooltip header. If data grouping is used, the default is a smart guess based on how close the closest points are. It is pulled from the #plotOptions.dataGrouping.dateTimeLabelFormats array.

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped