Class: VisualEarnings

CIQ. VisualEarnings


new VisualEarnings(params)

Adds an instance of the Visual Earnings plug-in to the chart and creates the Visual Earnings drop-down menu.

Parameters:
Name Type Description
params object

Parameters for setting up the Visual Earnings plug-in.

Properties
Name Type Description
stx CIQ.ChartEngine

A reference to the chart to which the plug-in is added.

context CIQ.UI.Context

A reference to the user interface context.

menuContainer HTMLElement

The DOM element to which the Visual Earnings drop-down menu is attached.

markup string

A custom markup string to use instead of the default markup specified by the markup property in the plugins/visualearnings/config.js file.

menu Array.<object>

A custom menu item array to use instead of the default array specified by the menu property in the plugins/visualearnings/config.js file.

Since:
  • 8.1.0 Added params.markup and params.menu.