Library Documentation

Class: TermStructure

CIQ.Renderer. TermStructure

new TermStructure(config)

Creates a term structure renderer.

See CIQ.Renderer#construct for parameters required by all renderers.

This renderer does not allow panning and zooming interaction with the chart except for the y-axis.

Requires the TermStructure plugin.

Parameters:
Name Type Description
config Object

Configuration for the renderer.

Properties
Name Type Argument Description
params Object <optional>

Parameters to control the renderer itself.

Properties
Name Type Argument Description
type String <optional>

Specifies the term structure rendering type.
Since:

  • 7.3.0

See:

Methods

createXAxis( [chart])

Creates the x-axis representation for the term structure chart.

This function is invoked by chart internals as part of the draw loop if the term structure plug-in has been initialized. The function should rarely if ever be called directly.

Parameters:
Name Type Argument Description
chart CIQ.ChartEngine <optional>

The chart object.
Since:

  • 7.3.0

Returns:

The x-axis representation.

Type
Array

determineMax( [dataSegment])

Determines the minimum and maximum values for the term structure y-axis. Called by CIQ.ChartEngine#initializeChart. As a guard against possible jumpiness, min and max values are cached, and the y-axis range will only be changed if the current values differ significantly from the cached values.

This function is invoked by chart internals as part of the draw loop if the term structure plug-in has been initialized. The function should rarely if ever be called directly.

Parameters:
Name Type Argument Description
dataSegment Array <optional>

The chart engine's data segment.
Since:

  • 7.3.0

drawIndividualSeries(chart)

Draws a term structure chart and the corresponding shading (if selected in the user interface) and invokes the crosshairs handler.

This function is invoked by chart internals as part of the draw loop if the term structure plug-in has been initialized. The function should rarely if ever be called directly.

Parameters:
Name Type Argument Description
chart Object

Rendering parameters.
params.panel CIQ.ChartEngine.Panel <optional>

Panel where the chart and shading are rendered.
Since:

  • 7.3.0

updateCrosshairs( [epX] [, epY])

Crosshairs handler for the term structure chart. Crosshairs follow the mouse except when in proximity to a curve point, in which case the crosshairs snap to the point.

This function is invoked by chart internals as part of the draw loop or in response to mouse movement if the term structure plug-in has been initialized. The function should rarely if ever be called directly.

Parameters:
Name Type Argument Description
epX Number <optional>

The x-coordinate of the cursor.
epY Number <optional>

The y-coordinate of the cursor.
Since:

  • 7.3.0