Class: HeadsUp

CIQ.UI. HeadsUp


new HeadsUp(node, context [, params] [, autoStart] [, followMouse] [, staticNode] [, showClass])

UI Helper that keeps the "head's up" display operating. There are three modes: params.followMouse=true - The head's up display will follow the mouse params.staticNode=true - The head's up will simply update a DOM node managed by you default - The head's up will be a marker within the chart, positioned in the chart panel unless overidden

Parameters:
Name Type Argument Default Description
node HtmlElement

The node which should be the template for the head's up.

context CIQ.UI.Context

The context

params Object <optional>

Optional parameters

autoStart Boolean <optional>
true

If true then start the head's up on construction

followMouse boolean <optional>
false

If true then the head's up will follow the mouse. In this case, the node should be a template that will be removed from the document and then added dynamically into the chart container.

staticNode Boolean <optional>
false

If true then the node will not be added as a marker

showClass string <optional>
"stx-show"

The class that will be added to display the head's up

Since:

Methods


begin()

Begins the head's up operation. This uses injections to manage the contents and location of the display. See CIQ.UI.HeadsUp#end to stop the head's up.


calculateMaxVolume(appending)

Parameters:
Name Type Description
appending boolean

end()

Stops the head's up from operating by removing injections and hiding. You can start it again by calling CIQ.UI.HeadsUp#begin.