Class: PinnedTooltip

Members

---

<static> enable :boolean|Object

Controls whether the tooltip can be pinned. Use an object to enable pinned tooltips based on plot type (series or study). Use a boolean to enable them unconditionally. (See examples.)

NOTE: currently only series plot is supported.

Requires "js/extras/pinnedMarkers.js"

Type:

• boolean | Object

Version:

• ChartIQ Extras Package

Since:

• 9.1.2

Examples

Universally allowed

CIQ.Marker.PinnedTooltip.enable = true;

Universally disallowed

CIQ.Marker.PinnedTooltip.enable = false;

Allowed for series plots only

CIQ.Marker.PinnedTooltip.enable = {
	series: true
};

---

<static> includeAllSeries :boolean

Controls whether the other series appearing on the panel, besides the one clicked on, are included in the tooltip.

Requires "js/extras/pinnedMarkers.js"

Type:

• boolean

Version:

• ChartIQ Extras Package

Since:

• 9.1.0

---

<static> layout :string

Layout of tooltip.

• columns: Each series appears in a column on the tooltip, with the fields appearing one per row.
• rows: Each field appears as a column on the tooltip, with the series appearing one per row.

Requires "js/extras/pinnedMarkers.js"

Type:

• string

Version:

• ChartIQ Extras Package

Since:

• 9.1.0

Examples

Columns

|-----------------------------|
|          IBM     GE    MSFT |
| Close      3      4       5 |
| Open       4      5       6 |
| High       6      7       8 |
| Low        1      2       3 |
|-----------------------------|

Rows

|------------------------------------|
|        Close   Open    High    Low |
| IBM        3      4       6      1 |
| GE         4      5       7      2 |
| MSFT       5      6       8      3 |
|------------------------------------|

Methods

---

<static> create(params)

Creates a tooltip in the form of a marker when a tap occurs on a plot which is highlighted. The tooltip can contain all the data relevant to the curve (Close, Open, High, Low) and persists in session storage. It will contain data for all series found on the panel.

Requires "js/extras/pinnedMarkers.js"

Parameters:

Name	Type	Description
params	Object	Properties Name Type Argument Description stx CIQ.ChartEngine Chart engine instance. field string <optional> Plot field name. This is the id of the series the marker is attached to. Leave blank for main series. record Object Data segment record for the marker's position. panel CIQ.ChartEngine.Panel <optional> Panel on which marker is found. Defaults to chart panel. x Date Date where marker is to be oriented. y number Value where marker is to be oriented. candleOffset number <optional> Multiple of candles left or right of the x value

Version:

• ChartIQ Extras Package

Since:

• 9.1.0

Returns:

Tooltip marker if created, otherwise undefined

Type

CIQ.Marker.PinnedTooltip