API Reference
Namespaces
Classes
Events
Global
Externals

Class: Tooltip

CIQ. Tooltip


new Tooltip(tooltipParams)

Add-on that creates a detailed tooltip as the user's mouse hovers over data points on the chart. The tooltip contains information such as the open, high, low, and close prices of stock quotes.

Tooltip example:

Note: Prior to version 8.2.0, the tooltip was directly linked to the crosshairs. The crosshairs had to be active for the tooltip to be displayed.

Requires addOns.js and markers.js, or the bundle standard.js.

There can be only one CIQ.Tooltip per chart.

Color and layout can be customized by overriding the CSS rule-sets defined for the stx-hu-tooltip and related type selectors in stx-chart.css. Do not modify stx-chart.css; create a separate style sheet file that overrides stx-chart.css in the CSS cascade. See the example below.

CIQ.Tooltip automatically creates its own HTML inside the chart container. Here is an example of the structure (there will be one field tag per displayed element):

<stx-hu-tooltip>
    <stx-hu-tooltip-field>
        <stx-hu-tooltip-field-name></stx-hu-tooltip-field-name>
        <stx-hu-tooltip-field-value></stx-hu-tooltip-field-value>
    </stx-hu-tooltip-field>
</stx-hu-tooltip>

By default, the stx-hu-tooltip-field elements are inserted in the following order:

  • DT
  • Open
  • High
  • Low
  • Close
  • Volume
  • series
  • studies

But the default layout can be changed. You can override the order of fields or change the labels by manually inserting the HTML that the tooltip would otherwise have created for that field. If no override HTML is found for a particular field, the default is used. Note: This HTML must be placed inside the chart container.

All of the code is provided in addOns.js and can be fully customized by copying the source code from the library and overriding the functions with your changes. Be sure to never modify a library file, as this will hinder upgrades.

For example, concatenating the field name (e.g., "Jaw") with the study name (e.g., "Alligator" ) is the default behavior of the tooltip for displaying the value title. Feel free to override this behavior by creating your own custom version of the renderFunction() for the CIQ.Tooltip. To do this, copy the entire CIQ.Tooltip code (found in addOns.js) and make the changes to your custom version. Load your custom version instead. Specifically, look for the following code in the renderFunction() that pushes out the text for each study field:

let newFieldName = document.createElement("stx-hu-tooltip-field-name");
newFieldName.innerHTML = this.translateIf(fieldName);
newField.appendChild(newFieldName);

Replace fieldName with anything you want to use as the field title and push that instead.

Visual Reference:
stx-hu-tooltip

Parameters:
Name Type Description
tooltipParams object

The constructor parameters.

Properties
Name Type Argument Default Description
stx CIQ.ChartEngine <optional>

The chart object.

ohl boolean <optional>

Set to true to show OHL data (Close is always shown).

volume boolean <optional>

Set to true to show Volume.

series boolean <optional>

Set to true to show value of series.

studies boolean <optional>

Set to true to show value of studies.

showOverBarOnly boolean <optional>

Set to true to show the tooltip only when the mouse is over the primary line/bars.

change boolean <optional>

Set to true to show the change in daily value when the internal chart periodicity is a daily interval (see CIQ.ChartEngine.isDailyInterval).

interpolation boolean <optional>

Set to true to show the estimated value when there is no data between bars. Note: A value of null is not considered missing data.

useDataZone boolean <optional>

Set to true to show the date in the dataZone time zone; false, to use the displayZone time zone (see CIQ.ChartEngine#setTimeZone).

showBarHighlight boolean <optional>
true

Specifies whether the bar (data point) the mouse is hovering over is highlighted. Applies to the floating tooltip only (the dynamic tooltip points to the bar). If the crosshairs are active, this parameter is ignored.

Since:
  • 09-2016-19
  • 5.0.0 Now tooltipParams.showOverBarOnly is available to show tooltip only when over the primary line/bars.
  • 5.1.1 tooltipParams.change set to true to show the change in daily value when displaying a daily interval.
  • 6.2.5 New tooltipParams.interpolation flag to show estimated value for missing series data points.
  • 7.0.0 New tooltipParams.useDataZone flag to show the date in either the dataZone or displayZone date/time.
  • 8.2.0 Decoupled CIQ.Tooltip from the crosshairs and added highlighting of the data point (or bar) the mouse is hovering over. The new tooltipParams.showBarHighlight parameter enables or disables the highlighting.
Examples

Add a tooltip to a chart:

// First declare your chart engine.
const stxx = new CIQ.ChartEngine({ container: document.querySelector(".chartContainer")[0] });

// Then link the tooltip to that chart.
// Note how we've enabled OHL, Volume, Series and Studies.
new CIQ.Tooltip({ stx: stxx, ohl: true, volume: true, series: true, studies: true });

Customize the order, layout, or text in tooltip labels:

// In this example, we've rearranged the HTML to display the Close field first, then the DT.
// We are also labeling the DT 'Date/Time' and the Close 'Last'.
// The rest of the fields are displayed in their default order.

<stx-hu-tooltip>
	<stx-hu-tooltip-field field="Close">
		<stx-hu-tooltip-field-name>Last</stx-hu-tooltip-field-name>
		<stx-hu-tooltip-field-value></stx-hu-tooltip-field-value>
	</stx-hu-tooltip-field>
	<stx-hu-tooltip-field field="DT">
		<stx-hu-tooltip-field-name>Date/Time</stx-hu-tooltip-field-name>
		<stx-hu-tooltip-field-value></stx-hu-tooltip-field-value>
	</stx-hu-tooltip-field>
</stx-hu-tooltip>

Customize the CSS for the tooltip (see stx-chart.css):

stx-hu-tooltip {
	position: absolute;
	left: -50000px;
	z-index: 30;
	white-space: nowrap;
	padding: 6px;
	border: 1px solid gray;
	background-color: rgba(42, 81, 208, 0.5);
	color: white;
}

stx-hu-tooltip-field {
	display: table-row;
}

stx-hu-tooltip-field-name {
	display: table-cell;
	font-weight: bold;
	padding-right: 5px;
}

stx-hu-tooltip-field-name:after {
	content: ":";
}

stx-hu-tooltip-field-value {
	display: table-cell;
	text-align: right;
}