Angular LinearGauge - tooltip

Configures tooltips.

Type: viz/gauges/base_gauge:BaseGaugeTooltip

A tooltip is a miniature rectangle displaying the value of a gauge's indicator. A tooltip appears when the end-user hovers the cursor over an indicator. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.

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

Type:

template

Template Data:
Name Type Description
valueText

String

The formatted value converted to a string.
value

Number

The raw value.
Default Name: undefined

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 the appearance of specified tooltips.

Type:

Function

| undefined
Function parameters:
scaleValue:

Object

Information on the scale value.

Object structure:
Name Type Description
valueText

String

The formatted value converted to a string.
value

Number

The raw value.
Return Value:

Object

Tooltip configuration.

Default Value: undefined

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. LinearGauge 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.
LinearGauge 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.
NOTE
As an alternative to the function’s parameter you can use the this keyword.
See Also

enabled

Enables tooltips.

Type:

Boolean

Default Value: false

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.