class SeriesAreaTooltip extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
series<area>-tooltip
- Alphabetic
- By Inheritance
- SeriesAreaTooltip
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new SeriesAreaTooltip()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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" }
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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
3.0
-
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
3.0.1
-
val
footerFormat: UndefOr[String]
A string to append to the tooltip format.
A string to append to the tooltip format.
- Since
2.2
Example: -
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
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 thepoint
andseries
objects. Thepoint.key
variable contains the category name, x value or datetime string depending on the type of axis. For datetime axes, thepoint.key
date format can be set using tooltip.xDateFormat.Defaults to
<span style="font-size: 10px">{point.key}</span><br/>
Example: -
val
hideDelay: UndefOr[Double]
The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.
The number of milliseconds to wait until the tooltip is hidden when mouse out from a point or chart.
- Since
3.0
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
val
padding: UndefOr[Double]
Padding inside the tooltip, in pixels.
Padding inside the tooltip, in pixels.
- Since
5.0.0
-
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, series.name and series.color and other properties on the same form. Furthermore, point.y can be extended by the
tooltip.valuePrefix
andtooltip.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.
- Since
2.2
-
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
4.1.0
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
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.
- Since
5.0.0
Example: -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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.
- Since
2.2
-
def
valueOf(): Any
- Definition Classes
- Object
-
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.
- Since
2.2
-
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.
- Since
2.2
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
xDateFormat: UndefOr[String]
The format for the date in the tooltip header if the X axis is a datetime axis.
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.
Example: