Class: CrossSection

Classes

HUD

TimelineDateSelector

Methods

---

addCurve(symbol, date, params [, cb])

Adds a secondary curve to the cross section chart.

Parameters:

Name	Type	Argument	Description
symbol	string		Market symbol that identifies the instrument depicted by the secondary curve.
date	Date | string | object		Date for the secondary curve. Can be a Date object, a string acceptable by the Date.parse() method, an object that represents a relative date (for example, { timeUnit: "day", multiplier: -1 }, see timeUnit and multiplier below), or the value "live", which specifies the current date. When a cross section is "live", the chart can be reloaded at a later date and the cross section will be reconstructed for that date (the current date) regardless of when the cross section was created. Relative dates apply to historical curves, which are primary entity curves created for dates in the past. Properties Name Type Argument Description timeUnit string <optional> Unit of time by which a relative date is offset from the date of the main curve. See calculateRelativeDate for valid values. multiplier number <optional> Number of time units a relative date is offset from the date of the main curve. A negative number offsets the date into the past; a positive number, the future. Zero locks the date of the secondary curve to the date of the main curve.
params	object		Specifications for the secondary curve. Properties Name Type Argument Description color string <optional> Color of the secondary curve. Must be an RGB, RBGA, or six‑digit hexadecimal color number; for example, "rgb(255, 255, 255)", "rgba(255, 255, 255, 0.5)", or "#FFFFFF". Note: Three‑digit hexadecimal color numbers and CSS color keywords, such as "white", are not valid. noRecord boolean <optional> When true, prevents recording of the secondary curve data to the chart layout, CIQ.ChartEngine#layout. This parameter is set to true when importing curves (for example, when reloading a chart that has secondary curves), which prevents the state of the curve midway through loading from becoming the new source of layout data. display string <optional> Display value for the curve also provided to addSeries when available used for rendering symbol text symbolObject object <optional> Symbol object to pass to addSeries method
cb	function	<optional>	Function called when the curve has been added to the chart and the data for the curve is available.

Since:

• 7.5.0
• 8.2.0 Added date.timeUnit and date.multiplier parameters to enable relative dates. Added support for the value "live" when date is a string to enable specification of the current date.
• 8.3.0 Renamed from CIQ.TermStructure.prototype.addCurve.
• 9.6.0 Added params.display
• 9.6.0 Added params.symbolObject

---

animateUpdates()

Animates chart updates.

Since:

• 7.3.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.animateUpdates.

---

calculateInstrumentSpacing(chart, instruments, bufferPercent)

Calculates instrument spacing. If the CrossSection instance has a spacingType of "uniform", instruments are spaced uniformly. If spacingType is set to "scaled", the spacing is calculated from the "spacing units" returned from calling calculateScaledSpacingUnits.

Parameters:

Name	Type	Description
chart	object	The chart engine.
instruments	Array.<string>	An array of instruments for which the spacing units are calculated.
bufferPercent	number	The percentage by which the available display width for spacing instruments is reduced on both sides of the chart.

Since:

• 7.3.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.calculateInstrumentSpacing.

Returns:

An object containing the instrument spacing and curve width.

Type

object

---

calculateScaledSpacingUnits(instruments)

Calculates scaled spacing units. Because scaling the x-axis linearly with respect to time can result in a tight clustering of points at certain points along the axis, you may wish to "smooth" the differences. In the default version, this has been done by calculating the time between the previous and current instrument and raising that value to a 0.5 exponent.

You may wish to replace this with your own scaling. To do so, simply overwrite this method with your own version. It will be called with an array of instruments and should return an object with each instrument as a key corresponding to a unit spacing value. The relative differences between the units will be used to determine positioning along the x-axis. The first instrument should have a unit spacing of 0.

Parameters:

Name	Type	Description
instruments	Array.<string>	An array of instruments for which the scaled spacing is calculated.

Since:

• 7.3.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.calculateScaledSpacingUnits.

Returns:

An object containing the spacing units for the instruments.

Type

object

---

cancelUpdateAnimations()

Removes all active update animations. Call this function to programmatically stop the animations associated with data point updates. See CIQ.CrossSection#setUpdateAnimations.

Since:

• 7.4.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.cancelUpdateAnimations.

---

deselectCurvePoints( [curveId])

Deselects all data points that have been selected on a curve. Typically, data points are selected to show curve spreads (see CIQ.ChartEngine#drawCrossSectionSpreads).

Called whenever a curve is removed or substantively modified; for example, when a new date is selected for the curve.

Defaults to the main curve.

Parameters:

Name	Type	Argument	Default	Description
curveId	string	<optional>	"_main_curve"	Identifies the curve for which points are deselected. If not specified, points are deselected on the main curve.

Since:

• 7.5.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.deselectCurvePoints.

---

findExtrema(field)

Finds the maximum and minimum values of a field in the curve data.

Parameters:

Name	Type	Description
field	string	Field to check for maximum and minimum values.

Since:

• 8.3.0

Returns:

An object containing the maximum and minimum values of field; property names are max and min respectively.

Type

object

---

findHighlights(stx, isTap, clearOnly)

Determines whether the user has either tapped or moused over a data point and, if so, includes in the return object the time stamp of the last update of the data point. Called by CIQ.ChartEngine#findHighlights.

Parameters:

Name	Type	Description
stx	CIQ.ChartEngine	The chart engine instance.
isTap	boolean	If true, indicates that the user tapped the screen on a touch device, and thus a wider radius is used to determine which objects have been highlighted.
clearOnly	boolean	Clears highlights when set to true.

Since:

• 7.4.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.findHighlights.

Returns:

Object that specifies Boolean values for somethingChanged, anyHighlighted, and stickyArgs properties.

Type

object

---

formatTimeStamp(date)

Formats a date and time for the time stamp that appears when the user's mouse hovers over a data point on the chart. The time stamp shows the date and time when the data point was most recently updated.

Default formatting is "Updated YYYY-MM-dd HH:mm". Override this function to specify your own date/time formatting.

Parameters:

Name	Type	Description
date	Date | string | number	A Date object or a value that can be accepted by the Date constructor function.

Since:

• 7.4.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.formatTimeStamp.

Example

var dt = new Date(date);
return "Last update at: " + (dt.getMonth() + 1) + "/" + dt.getDate() + "/" + dt.getFullYear();

---

getCenter()

Gets center pixel values if center.x and center.y parameters in crossSection are available.

Since:

• 8.7.0

---

getInstrumentShadingColor(instrument)

Returns the shading color for an instrument. Called once for each instrument (or instrument shorthand) stored in instruments property of the defaultPlotField (e.g., "1 MO", "2 MO", etc. for treasury bills). By default, this method uses the canvasStyleengine method to find a CSS class with the namestx_shading_concatenated with the instrument or instrument shorthand with spaces removed (e.g.,stx_shading_1MO`). As a result, shading styles can be defined in your stylesheets.

Feel free to override this method with your own color method. The shading renderer calls getInstrumentShadingColor for each instrument and expects an RBGA color to be returned.

Parameters:

Name	Type	Description
instrument	string	The instrument identifier.

Since:

• 7.3.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.getInstrumentShadingColor.

Returns:

A color code.

Type

string

---

hideCurve(curveId)

Hides a curve.

Parameters:

Name	Type	Description
curveId	string	Identifies the curve to be hidden.

Since:

• 8.3.0

---

lockCurve(curveId)

Locks the specified curve to the main curve.

Limitation: The time difference between the locked curve and main curve will be a number of days, which may change the relative time difference of a previously unlocked curve. For example, if you add a curve locked at minus one month, then unlock it and re-lock it, the time difference from the main curve will now be a number of days instead of one month, which may not yield the same results.

Parameters:

Name	Type	Description
curveId	string	Identifies the curve to be locked.

Since:

• 8.3.0

---

modifyCurve(curveId [, params])

Modifies a curve on the cross section chart.

Parameters:

Name	Type	Argument	Description
curveId	string		Identifies the curve to be modified.
params	object	<optional>	Parameters that specify curve modifications. If this parameter is undefined, the function returns without doing anything. Properties Name Type Argument Description color string <optional> A new color to apply to the curve. Must be an RGB, RBGA, or six‑digit hexadecimal color number; for example, "rgb(255, 255, 255)", "rgba(255, 255, 255, 0.5)", or "#FFFFFF". Note: Three‑digit hexadecimal color numbers and CSS color keywords, such as "white", are not valid. noRecord boolean <optional> When true, prevents recording of the curve modifications to the chart layout, CIQ.ChartEngine#layout.

Since:

• 7.5.0
• 8.2.0 Added params.noRecord.
• 8.3.0 Renamed from CIQ.TermStructure.prototype.modifyCurve.

---

removeCurve( [curveId])

Removes a secondary curve from the cross section chart.

Parameters:

Name	Type	Argument	Description
curveId	string	<optional>	Identifies the curve to be removed. If the parameter is undefined or identifies the main curve, this function returns without doing anything.

Since:

• 7.5.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.removeCurve.

---

setChartType(type [, params])

Sets crossection chart render type.

Parameters:

Name	Type	Argument	Description
type	string		crosssection defaults to line rendering, other options are mountain and histogram
params	object	<optional>	Additonal parameters for rendering Properties Name Type Argument Description baseline object <optional> Baseline parameter applies to histogram rendering and will merge baseline parameters into the yAxis, unless set to null to remove baseline from the yAxis Properties Name Type Argument Description value number <optional> Baseline value color string <optional> Baseline color. Color needs to be defined for baseline to be drawn. lineWidth string <optional> Baseline line width pattern string <optional> Baseline pattern widthFactor number <optional> Histogaram bar width factor, expressed as a decimal value 0 to 1.

Since:

• 9.3.0

---

setCurveDate(date [, curve] [, params])

Sets the date for which a cross sectional curve is drawn. If the value specified in date is not found in masterData and, if useQuotefeed is set in this cross section, the function attempts to use the quote feed to load the requested date.

For cross sections that have multiple curves, the date is applied to the main curve if a value is not specified in curve.

Parameters:

Name	Type	Argument	Default	Description
date	Date | string | object			The date for which the cross section curve is created. Can be a Date object, a string acceptable by the Date.parse() method, an object that represents a relative date (for example, { timeUnit: "day", multiplier: -1 }, see timeUnit and multiplier below), or the value "live", which specifies the current date. When a cross section is "live", the chart can be reloaded at a later date and the cross section will be reconstructed for that date (the current date) regardless of when the cross section was created. Relative dates apply to historical curves, which are primary entity curves created for dates in the past. Properties Name Type Argument Description timeUnit string <optional> Unit of time by which a relative date is offset from the date of the main curve. See calculateRelativeDate for valid values. multiplier number <optional> Number of time units a relative date is offset from the date of the main curve. A negative number offsets the date into the past; a positive number, the future. Zero locks the date of the secondary curve to the date of the main curve.
curve	string	<optional>		Identifies the curve to which date applies. If this parameter is not provided, defaults to the main curve.
params	object	<optional>	{}	Curve specifications. Properties Name Type Argument Description noRecord boolean <optional> When true, prevents recording of the curve data to the chart layout, CIQ.ChartEngine#layout. This parameter is set to true when importing curves (for example, when reloading the chart), which prevents the state of the curve midway through loading from becoming the new source of layout data. noDraw boolean <optional> When true, prevents the chart from being redrawn when the curve date is set. noLayoutChange boolean <optional> When true, prevents a dispatch informing the chart of a layout change. This can be used to improve performance when calling setCurveDate on multiple curves sequentially.

Since:

• 7.3.0
• 7.5.0 Added params and params.noRecord parameters.
• 8.2.0 Added params.noDraw parameter. Added date.timeUnit and date.multiplier parameters to enable relative dates. Added support for the value "live" when date is a string to enable specification of the current date.
• 8.3.0 Renamed the function from CIQ.TermStructure.prototype.setCurveDate. Added the params.noLayoutChange parameter.
• 9.6.0 returns a Promise

Returns:

Type

Promise.<void>

Example

var datepicker = topNode.querySelector("cq-datepicker");
 if (datepicker && stx.crossSection) {
     datepicker.registerCallback(function(date) {
         stx.crossSection.setCurveDate(date);
     });
 }

---

setDataField(field)

Deprecated. Use CIQ.CrossSection#setYaxisField instead.

Sets the data field for which values are plotted on the y-axis of the chart and then triggers a redraw of the chart. Use this function instead of setting the data field manually. See CIQ.UI.Layout#setDataField.

Parameters:

Name	Type	Description
field	string	Defines the type of values plotted on the y-axis of the cross section graph; for example, instrument yield or volatility.

Since:

• 7.3.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.setDataField. Deprecated.

Deprecated:

• Use CIQ.CrossSection#setYaxisField.

---

setFilters(obj)

Sets criteria used to filter the data that defines the chart curves, and then triggers a redraw of the chart.

Use this function instead of setting the filtering manually.

Parameters:

Name	Type	Description
obj	object	Contains properties that filter the data that defines the chart curves.

Since:

• 8.3.0

---

setGroupField(field)

Sets the data field for which values are grouped together to create chart subcurves, and then triggers a redraw of the chart.

Use this function instead of setting the group field manually.

See also CIQ.UI.Layout#setGroupField.

Parameters:

Name	Type	Description
field	string	The field for which data values are grouped to create subcurves; for example, "strike" or "expiration" for the strike price and expiration date of options.

Since:

• 8.3.0

---

setPointFreshnessTimeout(number)

Sets the value of the chart engine layout parameter (see CIQ.ChartEngine) that specifies the amount of time after which data points go stale.

Parameters:

Name	Type	Description
number	number	The number of minutes for the time out.

Since:

• 7.4.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.setPointFreshnessTimeout.

---

setPointLabels(bool)

Sets the value of the point label display flag.

Parameters:

Name	Type	Description
bool	boolean	True if displaying labels for all points.

Since:

• 8.5.0

---

setShading(bool)

Sets the shading flag to the value of the bool parameter and triggers a redraw. Use this function instead of setting the value manually.

Parameters:

Name	Type	Description
bool	boolean	When true, a background color (shading) is drawn on the chart to highlight horizontal sections of the graph; when false, the background color is not drawn.

Since:

• 7.3.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.setShading.

Example

var shadingCheckbox = topNode.querySelector(".ciq-checkbox-shading");
if (shadingCheckbox) {
    shadingCheckbox.registerCallback(function(value) {
        stx.crossSection.setShading.call(stx.crossSection, value);
        shadingCheckbox.classList.toggle("ciq-active");
     });
    shadingCheckbox.currentValue = true; // Initially set check box to checked.
}

---

setShowUpdateStamp(value)

Sets the value of the chart engine layout parameter (see CIQ.ChartEngine) that specifies whether the update time stamp should appear for data points the user has tapped or moused over.

Parameters:

Name	Type	Description
value	boolean	If true, show the time stamp; otherwise, do not show the time stamp.

Since:

• 7.4.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.setShowUpdateStamp.

---

setShowcaseFreshPoints(value)

Sets the value of the chart engine layout parameter (see CIQ.ChartEngine) that indicates whether or not to highlight fresh data points.

Parameters:

Name	Type	Description
value	boolean	If true, highlight fresh data points; otherwise, do not highlight fresh data points.

Since:

• 7.4.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.setShowcaseFreshPoints.

---

setSpacingType(type)

Sets the spacing type and triggers a redraw. Use this instead of setting the value manually.

Parameters:

Name	Type	Description
type	string	Spacing type, should be either "scaled" or "uniform". If this parameter is undefined, the function returns without doing anything.

Since:

• 7.3.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.setSpacingType.

---

setTrailLength( [length])

Sets length of historic trails.

Parameters:

Name	Type	Argument	Description
length	number	<optional>	Length of historic trails. Defaults to plugin set trailLength

Since:

• 8.7.0

---

setUpdateAnimations(value)

Sets the value of the chart engine layout parameter (see CIQ.ChartEngine) that specifies whether to animate changes to data point values.

Parameters:

Name	Type	Description
value	boolean	If true, animate changes; otherwise, do not animate changes.

Since:

• 7.4.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.setUpdateAnimations.

---

setXaxisField(field)

Sets the data field that is plotted on the x-axis of the chart, and then triggers a redraw of the chart.

Use this function instead of setting the x-axis field manually.

See also CIQ.UI.Layout#setXaxisField.

Parameters:

Name	Type	Description
field	string	Specifies the type of values plotted on the x-axis of the chart; for example, "strike" or "expiration" for the strike price and expiration date of options.

Since:

• 8.3.0

---

setYaxisField(field [, aggOperator])

Sets the data field that is plotted on the y-axis of the chart, and then triggers a redraw of the chart.

Use this function instead of setting the y-axis field manually.

See also CIQ.UI.Layout#setYaxisField.

Parameters:

Name	Type	Argument	Description
field	string		Specifies the type of values plotted on the y-axis of the cross section chart; for example, "yield", "bid", or "ask", which are the interest rate and trading prices of instruments in a term structure of interest rates.
aggOperator	string	<optional>	Specifies how multiple values for the same record are aggregated. The value plotted on the y-axis is the result of the aggregation operation. Valid values include: "sum" — Adds the values to create a single result "newest" — Selects the most recent value chronologically "first" — Selects the first value in order of position in the set of values "last" — Selects the last value in order of position in the set of values "count" — Gets a count of the values "avg" — Averages the values "max" — Gets the value that has the greatest magnitude

Since:

• 8.3.0

---

showCurve(curveId [, doShow])

Shows or hides a curve.

Parameters:

Name	Type	Argument	Default	Description
curveId	string			Identifies the curve to be shown.
doShow	boolean	<optional>	true	The curve is shown by default. Pass false to hide the curve.

Since:

• 8.3.0

---

unlockCurve(curveId)

Unlocks a curve. Makes the curve no longer relative to the main curve. The curve can now be set independent of the main curve. The date of the curve will not change when the date of the main curve changes.

Parameters:

Name	Type	Description
curveId	string	Identifies the curve to be unlocked.

Since:

• 8.3.0

---

updateTitleDate()

Updates the date in the chart title with the time the most recent update was received.

Since:

• 7.3.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.updateTitleDate.

---

zoomSet(newCandleWidth, chart)

Zooms the chart in and out. Overrides the default CIQ.ChartEngine#zoomSet method. Called in response to user interaction.

Parameters:

Name	Type	Description
newCandleWidth	number	The new candleWidth
chart	CIQ.ChartEngine.Chart	The chart to zoom

Since:

• 7.4.0
• 8.3.0 Renamed from CIQ.TermStructure.prototype.zoomSet.

---

<static> calculateRelativeDate(params)

Calculates a date relative to a reference date. For example, calculates the date that is 10 days prior to the current date.

Parameters:

Name	Type	Description
params	object	Function parameters. Properties Name Type Description reference Date The date from which the relative date is calculated. timeUnit string The unit of time by which the relative date is offset from the reference date. Must be "day", "week", "month", or "year". multiplier number The number of time units the relative date is offset from the reference date. A negative number offsets the date into the past; for example, -10 specifies a date 10 time units (days, weeks, months, or years) in the past. A positive number offsets the date into the future; for example, 2 specifies a date two days, weeks, months, or years in the future. Zero makes the relative date the same as the reference date regardless of time unit.

Since:

• 8.2.0
• 8.3.0 Renamed from CIQ.TermStructure.calculateRelativeDate.

Returns:

The calculated relative date.

Type

Date

---

<static> sortInstruments(instruments)

Deprecated. Use config.plugins.crossSection.sortFunction, which is contained in the chart configuration object. See the sample-template-term-structure.html template for an example. See also the Chart Configuration tutorial.

Sorts cross section instruments by their names.

Instrument names take the form "n Category", where "n" is a number and "Category" is one of DY, WK, MO, YR, ST, MT, and LT (day, week, month, year, short term, medium term, and long term, respectively); for example, 30 DY, 3 MO, 10 YR.

Categories sort in the order shown above; DY is lower in the sort order than WK, which is lower than MO, and so forth. Within categories, instruments are sorted by the numerical portion of the instrument name.

The current sorting implementation supports yield curves and other common financial instruments. However, cross sections can include a wide variety of instruments and instrument naming conventions.

Depending on the instruments you are working with, you may wish to replace this function with your own custom sorting function. Expect the function to be called with an unsorted list of all instruments (no duplicates) from all active curves. Return an array sorted however you desire.

Parameters:

Name	Type	Description
instruments	Array.<string>	The instruments to be rendered.

Since:

• 8.0.0
• 8.3.0 Renamed from CIQ.TermStructure.sortInstruments. Deprecated.

Deprecated:

• Use config.plugins.crossSection.sortFunction, which is contained in the chart configuration object.

Returns:

The instruments in sorted order.

Type

Array.<string>