Global

Methods


$$(id [, source])

Shorthand for getElementById(). Equivalent to prototype style $() which is faster but less powerful than jquery style $()

Parameters:
Name Type Argument Description
id string

An ID tag for a valid DOM object

source object <optional>

An optional valid DOM node to search within. If not provided then the entire document will be searched.

Returns:

The DOM node associated with the id or null if it is not found

Type
object

$$$(selector [, source])

Functional equivalent of querySelector(). Functionally equivalent to jquery $(). This uses querySelectorAll in order to maintain compatibility with IE 9. Note that if multiple objects match the selector then only the first will be returned.

Parameters:
Name Type Argument Description
selector string

CSS style selector

source object <optional>

Optional node to select within. If not provided then entire document will be searched.

Returns:

The first object to match the selector

Type
object

Type Definitions


doubleTapEventListener(data)

Called when a user doubletaps a touchscreen device

Parameters:
Name Type Description
data object
Properties
Name Type Description
stx CIQ.ChartEngine
finger number

Which finger double tapped

x number

The crosshair x position

y number

The crosshair y position

Since:
  • 4.0.0

drawingEventListener(data)

Called when a change occurs in the chart layout.

Parameters:
Name Type Description
data object

Data relevant to the "drawing" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

symbol string

The current chart symbol

symbolObject object

The symbol's value and display label (CIQ.ChartEngine.chart.symbolObject)

layout object

The chart's layout object (CIQ.ChartEngine.layout)

drawingObjects array

The chart's current drawings (CIQ.ChartEngine.drawingObjects)


HTMLElement


layoutEventListener(data)

Called when a change occurs in the chart layout.

Parameters:
Name Type Description
data object

Data relevant to the "layout" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

symbol string

The current chart symbol

symbolObject object

The symbol's value and display label (CIQ.ChartEngine.chart.symbolObject)

layout object

The chart's layout object (CIQ.ChartEngine.layout)

drawingObjects array

The chart's current drawings (CIQ.ChartEngine.drawingObjects)


longholdEventListener(data)

Called when the mouse is clicked on the chart and held down.

Parameters:
Name Type Description
data object

Data relevant to the "longhold" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

panel string

The panel being tapped

x number

The crosshair x position

y number

The crosshair y position


minMax

Type:
  • object
Properties:
Name Type Description
min number

The minimum data point

max number

The maximum data point


moveEventListener(data)

Called when the crosshair moves.

Parameters:
Name Type Description
data object

Data relevant to the "move" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

panel string

The panel being moved

x number

The crosshair x position

y number

The crosshair y position

grabbingScreen boolean

True if the screen is being touched or clicked


newChartEventListener(data)

Called when the quoteFeed fetches a new series.

Parameters:
Name Type Description
data object

Data relevant to the "newChart" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

symbol string

The current chart symbol

symbolObject object

The symbol's value and display label (CIQ.ChartEngine.chart.symbolObject)

moreAvailable boolean

True if quotefeed~dataCallback reports that more data is available

quoteDriver object

The quoteFeed driver


preferencesEventListener(data)

Called when preferences are changed.

Parameters:
Name Type Description
data object

Data relevent to the "preferences" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

symbol string

The current chart symbol

symbolObject object

The symbol's value and display label (CIQ.ChartEngine.chart.symbolObject)

layout object

The chart's layout object (CIQ.ChartEngine.layout)

drawingObjects array

The chart's current drawings (CIQ.ChartEngine.drawingObjects)


rightClickEventListener(data, panel)

Called on "mouseup" after the chart is right-clicked.

Parameters:
Name Type Description
data object

Data relevant to the "rightClick" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

panel string

The panel that was clicked on

data.x number

The crosshair x position

data.y number

The crosshair y position


Selector


studyDescriptor

Type:
  • object
Properties:
Name Type Description
name string

The study's id

inputs object

Keys for each possible study input with descriptors for the set and default values

min number

The minimum data point

max number

The maximum data point

outputs object

Keys for each possible study output option

panel string

ID of the panel element the study is attached to

parameters parameters

Keys for each of the study's possible plot parameters

type string

The study type


studyOverlayEditEventListener(data)

Called when an overlay-type study is edited

Parameters:
Name Type Description
data object

Data relevant to the "studyOverlayEdit" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

sd object

The study object studyDescriptor

inputs object

The inputs from the studyDescriptor

outputs object

The outputs from the studyDescriptor

parameters object

The parameters from the studyDescriptor


studyPanelEditEventListener(data)

Called when a panel-type study is edited

Parameters:
Name Type Description
data object

Data relevant to the "studyPanelEdit" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

sd object

The study object studyDescriptor

inputs object

The inputs from the studyDescriptor

outputs object

The outputs from the studyDescriptor

parameters object

The parameters from the studyDescriptor


symbolChangeEventListener(data)

Called when the chart's symbol changes.

Parameters:
Name Type Description
data object

Data relevant to the "symbolChange" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

symbol string

The new chart symbol

symbolObject object

The symbol's value and display label (CIQ.ChartEngine.chart.symbolObject)

action string

An action type being performed on the symbol. Possible options:

- `add-series` - A series was added
- `master` - The master symbol was changed
- `remove-series` - A series was removed

symbolImportEventListener(data)

Called when a symbol is imported into the layout. It is not called by other types of symbol changes

Parameters:
Name Type Description
data object

Data relevant to the "symbolImport" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

symbol string

The new chart symbol

symbolObject object

The symbol's value and display label (CIQ.ChartEngine.chart.symbolObject)

action string

An action type being performed on the symbol. Possible options:

  • add-series - A series was added
  • master - The master symbol was changed
  • remove-series - A series was removed

tapEventListener(data)

Called when the chart is tapped.

Parameters:
Name Type Description
data object

Data relevant to the "tap" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

panel string

The panel being tapped

x number

The crosshair x position

y number

The crosshair y position


themeEventListener(data)

Called when a change occurs in the chart layout.

Parameters:
Name Type Description
data object

Data relevant to the "theme" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

symbol string

The current chart symbol

symbolObject object

The symbol's value and display label (CIQ.ChartEngine.chart.symbolObject)

layout object

The chart's layout object (CIQ.ChartEngine.layout)

drawingObjects array

The chart's current drawings (CIQ.ChartEngine.drawingObjects)


undoStampEventListener(data)

Called when an undo stamp is created for drawing events.

Parameters:
Name Type Description
data object

Data relevant to the "undoStamp" event

Properties
Name Type Description
stx CIQ.ChartEngine

The chart engine instance

before array

The chart's array of drawingObjects before the change

after array

The chart's array of drawingsObjects after the change