ChartIQ SDK Documentation

Events namespace. Contains functions related to Events.

Since:

EventMarkersConfig

Turns on the display of event markers on the chart. Note that events need to come from an external source, either a data file or a feed.

Name	Type	Argument	Description
`backgroundColor`	string	<optional>	Event marker background color (when expanded).
`colorMap`	Record.<string, (string\|undefined)>	<optional>	Event marker color by marker key type (usually symbol).

Since:

EventParameters

Parameters passed to CompactChart#addEvents function.

Name	Type	Argument	Description
`data`	Array.<EventRecord>	<optional>	Static data to be added, in proper market data format.
`tryQuoteFeed`	boolean	<optional>	If false, bypass any attempt at supplementing data from quotefeed.
`type`	string	<optional>	Type of event.
`yPositioner`	YPositioner	<optional>	Where to place the event marker.
`includeSource`	boolean	<optional>	True to include the event data source.
`size`	string	<optional>	Marker size.
`color`	string	<optional>	Marker color.

Since:

EventRecord

Defines an object representing the event details at a specific time.

Name	Type	Argument	Description
`DT`	Date \| string		Date of record as JS Date or ISO string.
`data`	object	<nullable>	Details of record.
`id`	string		Event id.
`category`	string		Category of event to which this record belongs.
`headline`	string		Event headline.
`story`	string	<optional>	Event body. This would be the description of the event.
`url`	string	<optional>	URL to embed in event body, to link to a story on another page.
`source`	string	<optional>	Source of data.

Since:

Namespace: Events