API Reference
Namespaces
Classes
Events
Global
Externals

Namespace: Favorites

CIQ.Studies. Favorites

Methods

add(study)

Add study to favorite list

Parameters:
Name Type Description
study string | object

Name or definition of a study

addToChart(studyName, stx)

Adds study from favorite list to the chart

Parameters:
Name Type Description
studyName string

Name of study
stx CIQ.ChartEngine

Chart engine

getList()

Return list of favorites

Returns:

Favorite list

Type
Array.<string>

includes(studyName)

Returns first found favorite of name specified

Parameters:
Name Type Description
studyName string

Name of study
Returns:

First match in favorite list

Type
object | undefined

remove(studyName)

Remove study from favorite list

Parameters:
Name Type Description
studyName string

Name of study to remove

retrieveList(stx, cb)

Retrieve favorite list from persistent storage

Parameters:
Name Type Description
stx CIQ.ChartEngine

Chart engine
cb function

Callback function

save(stx, cb)

Save favorite list to persistent storage

Parameters:
Name Type Description
stx CIQ.ChartEngine

Chart engine
cb function

Callback function