Packages

object PlotOptionsOhlcTooltip

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

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. def apply(changeDecimals: UndefOr[Double] = js.undefined, dateTimeLabelFormats: UndefOr[Object] = js.undefined, followPointer: UndefOr[Boolean] = js.undefined, followTouchMove: UndefOr[Boolean] = js.undefined, headerFormat: UndefOr[String] = js.undefined, padding: UndefOr[Double] = js.undefined, pointFormat: UndefOr[String] = js.undefined, pointFormatter: UndefOr[Function] = js.undefined, shape: UndefOr[String] = 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): PlotOptionsOhlcTooltip

    changeDecimals

    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.

    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.

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

    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, 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.

    pointFormatter

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

    shape

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

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

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped