API Reference
Namespaces
Classes
Events
Global
Externals

Class: TimelineDateSelector

CIQ.CrossSection. TimelineDateSelector (params)

new TimelineDateSelector(params)

Creates a timeline date selector for a cross section chart, including the cq-timeline-controls and cq-curve-controls web components.

Parameters:
Name Type Description
params object

Constructor parameters.

Properties
Name Type Argument Default Description
crossSection CIQ.CrossSection

A reference to the cross section object.
height number <optional>
 95

The height in pixels to assign to the timeline date selector chart (which plots spreads over time).
useNotifications boolean <optional>
 true

Alerts the user to events using toast messages. Requires the cq-message-toaster web component.
glyphs object <optional>
 {}

Allows configuration override of image source paths. Currently the only valid property of this parameter is lockImg.
Since:

  • 8.3.0

    • 10.3.0 If dragOnlyMainCurve is set to true, only the main curve will be draggable in the timeline date selector. This is used for RRG where only the main curve should be draggable.

Methods

adjustRange()

Adjusts the visible range of the timeline date selector to display all curve handles. Called when the timeline date selector opens.

Since:

  • 8.3.0

display()

Shows, hides, or updates the timeline date selector.

Shows or hides the timeline date selector depending on the stx.layout.timelineDateSelector property. Shows the selector when the property is true; hides the selector, when the property is false.

Updates the timeline date selector in response to resize events and layout events such as a curve handle being dragged or a curve control (see cq-curve-controls) being selected.

Since:

  • 8.3.0

drawSelector()

Draws all of the draggable curve handles for the timeline date selector.

Since:

  • 8.3.0