Vue Sparkline - tooltip

Configures the tooltip.

Type: viz/sparklines/base_sparkline:BaseSparklineTooltip

A tooltip is a miniature rectangle displaying UI component data. The tooltip appears when the end-user hovers the cursor over the UI component. 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 UI component's container. If you plan to use the tooltip, make sure there is enough space around your UI component to display it. For example, you can apply a margin to the UI component's container to reserve the area around the UI component 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 property supports the following colors:

This property 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

|

HTMLElement | jQuery

| undefined
Default Value: undefined

contentTemplate

Specifies a custom template for tooltips.

Type:

template

Template Data:

Object

Information on the points that belong to the series that is pressed or hovered over.

Default Name: undefined

You can access the following pointsInfo fields:

Field name Description
originalFirstValue The first value of a sparkline specified in the dataSource.
firstValue The first value of a sparkline with formatting applied if the format property is specified.
originalLastValue The last value of a sparkline as it is specified in the dataSource.
lastValue The last value of a sparkline with applied formatting if the format property is specified.
originalMinValue The minimum value of a sparkline as it is specified in the dataSource.
minValue The minimum value of a sparkline with applied formatting if the format property is specified.
originalMaxValue The maximum value of a sparkline as it is specified in the dataSource.
maxValue The maximum value of a sparkline with applied formatting if the format property is specified.

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

Field name Description
originalThresholdValue The threshold value of a winloss sparkline as it is assigned to the winlossThreshold property.
thresholdValue The threshold value of a winloss sparkline with applied formatting if the format property is specified.

cornerRadius

Makes all the tooltip's corners rounded.

Type:

Number

Default Value: 0, 4 (Fluent, Material)

The following table demonstrates how the corner's curvature depends on the cornerRadius value:

cornerRadius Result
cornerRadius: 0 DevExtreme Chart: tooltip with cornerRadius set to 0
cornerRadius: 15 DevExtreme Chart: tooltip with cornerRadius set to 15
cornerRadius: 35 DevExtreme Chart: tooltip with cornerRadius set to 35

customizeTooltip

Allows you to change tooltip appearance.

Type:

Function

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

Assign a function to this property that returns an object with the following fields:

Field name Description
text Tooltip text. The component evaluates inline HTML and CSS in this field's value to style rendered text. Sparkline transforms evaluated HTML elements into tspan SVG elements and does not render inline HTML directly. The component also discards all attributes except style and class.
To encode and render this field's value as plain text, enable encodeHtml.
html The HTML markup displayed in a tooltip.
Sparkline evaluates the markup. Make sure that it does not contain malicious code. Refer to the following help topic for more information: Potentially Vulnerable API - customizeTooltip.
To use external resources (images, etc.) in the markup, specify the size of the area they occupy beforehand.
color Tooltip color.
fontColor Tooltip text color.
borderColor Tooltip border color.

You can access the following fields of the Sparkline:

Field name Description
originalFirstValue The first value of a sparkline as it is specified in a dataSource
firstValue The first value of a sparkline with applied formatting if the format property is specified.
originalLastValue The last value of a sparkline as it is specified in a data source.
lastValue The last value of a sparkline with applied formatting if the format property is specified.
originalMinValue The minimum value of a sparkline as it is specified in a data source.
minValue The minimum value of a sparkline with applied formatting if the format property is specified.
originalMaxValue The maximum value of a sparkline as it is specified in a data source.
maxValue The maximum value of a sparkline with applied formatting if the format property is specified.

The following fields are available for a sparkline of the "winloss" type only:

Field name Description
originalThresholdValue The threshold value of a winloss sparkline as it is assigned to the winlossThreshold property.
thresholdValue The threshold value of a winloss sparkline with applied formatting if the format property is specified.

To access the fields above, use the function's parameter and the this object.

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

enabled

Specifies whether a tooltip is enabled.

Type:

Boolean

Default Value: true

font

Specifies tooltips' font properties.

Type:

Object

format

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

Type:

Format

| undefined
Default Value: undefined

See the format section for information on accepted values.

See Also

interactive

Allows users to interact with the tooltip content.

Type:

Boolean

Default Value: false

opacity

Specifies tooltips' transparency.

Type:

Number

| undefined
Default Value: undefined

This property 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

shadow

Configures a tooltip's shadow.

Type:

Object

zIndex

Specifies a tooltip's z-index.

Type:

Number

| undefined
Default Value: undefined

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