ChartIQ SDK Documentation

Class: Group

CIQ .Marker .TimeSpanEvent. Group

new Group(params)

Creates a marker group for Life Cycle Events. Markers within the group are determined automatically based on positioning. Applies only to single event markers.

Parameters:

Name Type Description

params

object

Configuration parameters.

Properties

Name	Type	Argument	Default	Description
`stx`	CIQ.ChartEngine			The chart engine.
`groupKey`	string	<optional>		The shared groupKey value for markers associated with this group
`x`	*			A valid date, tick, or bar (depending on the selected `xPositioner`) used to select a candle to which the marker is associated.
`y`	Number	<optional>		A valid value for positioning the marker on the y-axis (depending on selected `yPositioner`). If this value is not provided, the marker is set "above_candle" as long as a valid candle is selected by `params.x`.
`panelName`	string	<optional>	"timeSpanEventPanel"	The name of the panel to which the `node` is attached. Defaults to the main chart panel.
`xPositioner`	string	<optional>	"date"	Determines the x-axis position of the marker. Please refer to CIQ.Marker for other values.
`yPositioner`	string	<optional>	"value"	Determines the y-axis position of the marker. Please refer to CIQ.Marker for other values.
`noInteraction`	string	<optional>		Set to `true` to disable the marker's default click handler.

Since:

9.3.0

Methods

createNode(params)

Creates a CIQ.Marker.TimeSpanEvent.GroupNode object for use as the node of a group marker.

Parameters:

Name	Type	Description
`params`	object	Parameters to describe the marker

Since:

9.3.0

<static> placementFunction(params)

Determines the placement of time span event group markers.

Parameters:

Name Type Description

params

object

Parameters passed from the Marker render function.

Properties

Name	Type	Description
`stx`	CIQ.ChartEngine	A reference to the chart engine.
`panel`	object	The panel where the marker is being placed.

Since:

9.3.0