new CrossSection(config)
Creates a cross section 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 CrossSection plugin.
Parameters:
Name | Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
config |
object | Configuration for the renderer. Properties
|
- Since:
-
- 7.3.0
- 8.3.0 Renamed from
CIQ.Renderer.TermStructure
.
- See:
Members
-
noCurrentHR :boolean
-
Disables the current price y-axis label.
Type:
- boolean
Methods
-
createXAxis(chart)
-
Creates the x-axis representation for the cross section chart.
This function is invoked by chart internals as part of the draw loop if the cross section plug-in has been initialized. The function should rarely if ever be called directly.
Parameters:
Name Type Description chart
CIQ.ChartEngine.Chart The chart object.
- Since:
-
- 7.3.0
- 8.3.0 Renamed from
CIQ.Renderer.TermStructure.prototype.createXAxis
.
Returns:
The x-axis representation.
- Type
- Array.<object>
-
createXAxisRegular(chart, axisRepresentation, decimalPlaces)
-
Creates the regular x-axis representation for a cross-section chart.
This function is invoked by CIQ.Renderer.CrossSection#createXAxis if a regular x-axis is requested. It will replace the generated x-axis labels with linear, uniformly-numbered labels. Note this is different from uniformly-spaced labels, which are not linear. This will only regenerate x-axis labels if the x-axis is numeric and is set to scaled spacing type (not uniform).
Parameters:
Name Type Description chart
CIQ.ChartEngine.Chart The chart object.
axisRepresentation
Array.<CIQ.ChartEngine.XAxisLabel> Axis representation object created by createXAxis. This should be an array of axis labels.
decimalPlaces
number The number of decimal places to show on each label.
- Since:
-
8.9.0
-
determineMax(dataSegment)
-
Determines the minimum and maximum values for the cross section 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 cross section plug-in has been initialized. The function should rarely if ever be called directly.
Parameters:
Name Type Description dataSegment
Array.<object> The chart engine's data segment.
- Since:
-
- 7.3.0
- 8.3.0 Renamed from
CIQ.Renderer.TermStructure.prototype.determineMax
.
Returns:
A tuple with minumum, maximum range of plot values on y-axis
- Type
- Array.<number>
-
drawIndividualSeries(chart, parameters)
-
Draws a cross section 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 cross section plug-in has been initialized. The function should rarely if ever be called directly.
Parameters:
Name Type Description chart
CIQ.ChartEngine.Chart Chart object
parameters
object Rendering parameters
Properties
Name Type Argument Description panel
CIQ.ChartEngine.Panel <optional>
Panel where the chart and shading are rendered.
- Since:
-
- 7.3.0
- 8.3.0 Renamed from
CIQ.Renderer.TermStructure.prototype.drawIndividualSeries
.
-
updateCrosshairs( [epX] [, epY])
-
Crosshairs handler for the cross section 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 cross section 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
- 8.3.0 Renamed from
CIQ.Renderer.TermStructure.prototype.updateCrosshairs
.
-
<static> requestNew(featureList [, params])
-
Returns a new CrossSection renderer if the featureList calls for it FeatureList should contain "crosssection" or "termstructure". Called by CIQ.Renderer.produce to create a renderer for the main series
Parameters:
Name Type Argument Description featureList
Array.<string> List of rendering terms requested by the user, parsed from the chartType
params
object <optional>
Parameters used for the series to be created, used to create the renderer
Returns:
A new instance of the CrossSection renderer, if the featureList matches
- Type
- null | CIQ.Renderer.CrossSection