API Reference
Namespaces
Classes
Events
Global
Externals

Class: SidePanelPlugin

CIQ.UI. SidePanelPlugin

Abstract class for Side Panel Plugin. Adds a "panel" area either on the top or the right side of the chart to contain plug-in markup. Do not construct this directly; instead, extend it to your own class. You will need to define render and unrender functions on your class to place your markup (and remove it). These functions are respectively called when the toggle button is pressed.

new SidePanelPlugin(params)

Parameters:
Name Type Description
params object

Parameters for setting up the plug-in.

Properties
Name Type Argument Default 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.
container HTMLElement | string

The DOM element to which the plugin toggle is attached.
markup string

A markup string to use for the button that toggles the plug-in.
location string <optional>
 "top"

Where the plugin appears, "top" and "right" supported.
Since:

  • 9.5.0