Class

SpotfireTooltip

SpotfireTooltip(tooltipDescription)

Represent the tooltip section

Constructor

new SpotfireTooltip(tooltipDescription)

Parameters:
Name Type Description
tooltipDescription SpotfireTooltipDescription ▼

The description of the tooltip to be added.

tooltipItems Array.<TooltipItemDescription> ▼
[].expression string

the expression to be used to create the tooltip item

[].size number

the size of the tooltip item

[].renderer RendererDescription ▼

the renderer description to be used

type string

the type of renderer to be used

[ urlTemplate ] string

the url template for "Image from URL" renderer

displayItems Array.<String>

Specifies which tooltip items will be shown by their names (specified by "as [tooltip name]" in the expression field).
Note: You can use the axis names such as "X", "Category axis", "Color by", "Size by", etc. to display default tooltips.

format SpotfireTooltipFormats ▼

Specifies whether or not the name of the tooltip value should be included along with the value itself.

valueNamesAndValues String
visualizationPropertiesAndValues String