Vue Sparkline - tooltip

Configures the tooltip.

Type:

Object

A tooltip is a miniature rectangle displaying widget data. The tooltip appears when the end-user hovers the cursor over the widget. You can enable/disable the tooltip, change its appearance and format its text using fields of the tooltip configuration object.

NOTE
The tooltip is displayed outside the widget's container. If you plan to use the tooltip, make sure there is enough space around your widget to display it. For example, you can apply a margin to the widget's container to reserve the area around the widget for the tooltip.

arrowLength

Specifies the length of a tooltip's arrow in pixels.

Type:

Number

Default Value: 10

border

Configures a tooltip's border.

Type:

Object

color

Colors all tooltips.

Type:

String

Default Value: '#ffffff'

This option supports the following colors:

This option sets one color for all tooltips. You can specify a particular tooltip's color in the tooltip.customizeTooltip function.

container

Specifies the container in which to draw tooltips. The default container is the HTML DOM <body> element.

Type:

String

|

DOM Node

|

jQuery

Default Value: undefined

customizeTooltip

Allows you to change tooltip appearance.

Type:

Function

Function parameters:
pointsInfo:

Object

Information on the point being pressed or hovered over with the mouse pointer.

Return Value:

Object

The tooltip's text or markup and appearance settings.

Default Value: undefined
Cannot be used in themes.

This option should be assigned a function returning a specific object. The following fields can be specified in this object.

  • color
    Specifies the color of a tooltip.

  • text
    Specifies the text displayed by a tooltip.

  • html
    Specifies the HTML markup displayed by a tooltip.

    NOTE
    If you are going to use external resources (for example, images) in the markup, specify the size of the area they will occupy beforehand.

  • fontColor
    Specifies the color of the text displayed by a tooltip.

  • borderColor
    Specifies the color of the tooltip border.

When implementing a callback function for this option, you can access different types of values indicated by a sparkline. For this purpose, use the following fields of the this object.

  • originalFirstValue
    Contains the first value of a sparkline as it is specified in a data source.
  • firstValue
    Contains the first value of a sparkline with applied formatting if the format option is specified.
  • originalLastValue
    Contains the last value of a sparkline as it is specified in a data source.
  • lastValue
    Contains the last value of a sparkline with applied formatting if the format option is specified.
  • originalMinValue
    Contains the minimum value of a sparkline as it is specified in a data source.
  • minValue
    Contains the minimum value of a sparkline with applied formatting if the format option is specified.
  • originalMaxValue
    Contains the maximum value of a sparkline as it is specified in a data source.
  • maxValue
    Contains the maximum value of a sparkline with applied formatting if the format option is specified.

The following fields are available for a sparkline of the 'winloss' type only.

  • originalThresholdValue
    Contains the threshold value of a winloss sparkline as it is assigned to the winlossThreshold option.
  • thresholdValue
    Contains the threshold value of a winloss sparkline with applied formatting if the format option is specified.

To access the fields above, you can use the function's parameter as well as the this object.

To get general information on data formatting, refer to the Data Formatting topic.

enabled

Enables tooltips.

Type:

Boolean

Default Value: true

font

Specifies tooltips' font options.

Type:

Object

format

Formats a value before it is displayed it in a tooltip.

Type:

Format

Default Value: undefined

See the format section for details on accepted values.

See Also

horizontalAlignment Deprecated

Tooltip alignment is no longer useful because the tooltips are aligned automatically.

Specifies how a tooltip is horizontally aligned relative to the graph.

Type:

String

Default Value: undefined
Accepted Values: 'center' | 'left' | 'right'

opacity

Specifies tooltips' transparency.

Type:

Number

Default Value: undefined

This option accepts a value from 0 to 1, where 0 makes tooltips completely transparent, and 1 makes them opaque.

paddingLeftRight

Generates an empty space, measured in pixels, between a tooltip's left/right border and its text.

Type:

Number

Default Value: 18

DevExtreme HTML5 JavaScript Funnel Tooltips Left-Right Padding

paddingTopBottom

Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text.

Type:

Number

Default Value: 15

DevExtreme HTML5 JavaScript Funnel Tooltips Top-Bottom Padding

precision Deprecated

Use the tooltip.format.precision option instead.

Specifies the precision of formatted values in a tooltip.

Type:

Number

Default Value: undefined

shadow

Configures a tooltip's shadow.

Type:

Object

verticalAlignment Deprecated

Tooltip alignment is no longer useful because the tooltips are aligned automatically.

Specifies how a tooltip is vertically aligned relative to the graph.

Type:

String

Default Value: undefined
Accepted Values: 'bottom' | 'top'

zIndex

Specifies a tooltip's z-index.

Type:

Number

Default Value: undefined

If the widget's container has the CSS z-index property specified, and tooltips are displayed incorrectly, configure their z-index using this option.