API Reference
Namespaces
Classes
Events
Global
Externals

Class: Simple

CIQ.Marker. Simple


new Simple(params)

Creates simple HTML nodes that can be used with a CIQ.Marker

See Markers tutorials for additional implementation instructions.

Parameters:
Name Type Description
params Object

Parameters to describe the marker

Properties
Name Type Argument Description
type string

The marker type to be drawn.
Available options are:

  • "circle"
  • "square"
  • "callout"
headline string

The headline text to pop-up when clicked.

category string <optional>

The category class to add to your marker.
Available options are:

  • "news"
  • "earningsUp"
  • "earningsDown"
  • "dividend"
  • "filing"
  • "split"
story string <optional>

The story to pop-up when clicked.

pinnable boolean <optional>

Allow marker to be "pinned". Requires js/extras/pinnedMarkers.js, which is part of the ChartIQ Extras Package. This flag is false by default. See CIQ.Marker.prototype.makePinnable for instructions on using this flag.

Since:
  • 9.1.0 Added pinnable parameter, which makes all new markers pinnable. This feature requires js/extras/pinnedMarkers.js, which is part of the ChartIQ Extras Package.
Example
var datum = {
		type: "circle",
		headline: "This is a Marker for a Split",
		category: "split",
		story: "This is the story of a split"
};

	var mparams = {
		stx: stxx,
		label: "Sample Events",
		xPositioner: "date",
		x: aDate,
		pinnable: true, //Requires ChartIQ Extras Package
		node: new CIQ.Marker.Simple(datum)
	};

	var marker = new CIQ.Marker(mparams);

Methods


click(params)

Click event handler for simple markers when they are clicked. Adds or removes the marker's pop-up expansion div to the chart, depending on whether it has already been activated.

Parameters:
Name Type Description
params object

Configuration parameters.

Properties
Name Type Description
cx number

Client x-coordinate of click.

cy number

Client y-coordinate of click.

marker CIQ.Marker

Marker that was clicked.

panel CIQ.ChartEngine.Panel

Panel where the click occurred.

Since:
  • 9.1.0


remove(marker)

Hides a marker's expanded text.

Parameters:
Name Type Description
marker CIQ.Marker

The marker to which this node belongs.

Since:
  • 9.1.0