ChartIQ SDK/com.chartiq.sdk/ChartIQHandler

ChartIQHandler

class ChartIQHandler(chartIQUrl: String, context: Context) : ChartIQ, ChartIQStudy, JavaScriptHandler

Constructors

constructor(chartIQUrl: String, context: Context)

Properties

open override val chartView: View

A ChartIQ View that represents a ChartIQ UI

Functions

addChartAvailableListener

open override fun addChartAvailableListener(chartAvailableCallback: ChartAvailableCallback)

Adds a measure listener

addMeasureListener

open override fun addMeasureListener(measureCallback: MeasureCallback)

Adds a measure listener

open override fun addSeries(series: Series, isComparison: Boolean)

Adds the symbol from the series to the chart with its color.

open override fun addSignalStudy(name: String, callback: OnReturnCallback<Study>)

Add signal Signal to a list of active signals

open override fun addStudy(study: Study, forClone: Boolean)

Adds a study Study to a list of active studies

chartAvailableChange

open override fun chartAvailableChange(json: String)

open override fun clearDrawing()

Clears all the drawings from the chart canvas

open override fun cloneDrawing()

Clones the drawing that is selected on the chart

open override fun deleteDrawing()

Deletes the drawing that is selected on the chart

disableCrosshairs

open override fun disableCrosshairs()

Disables crosshairs

open override fun disableDrawing()

Deactivates drawing mode

open override fun drawingChange(json: String)

enableCrosshairs

open override fun enableCrosshairs()

Enables crosshairs

open override fun enableDrawing(type: DrawingTool)

Activates a selected drawing DrawingTool

getActiveSeries

open override fun getActiveSeries(callback: OnReturnCallback<List<Series>>)

Gets all active series on the chart.

getActiveSignals

open override fun getActiveSignals(callback: OnReturnCallback<List<Signal>>)

Gets a list of signals Signal

getActiveStudies

open override fun getActiveStudies(callback: OnReturnCallback<List<Study>>)

Gets a list of active/selected studies Study

getChartAggregationType

open override fun getChartAggregationType(callback: OnReturnCallback<ChartAggregationType?>)

Gets a selected aggregation chart type

getChartProperty

open override fun getChartProperty(property: String, callback: OnReturnCallback<String>)

Gets a property off the chart object

open override fun getChartScale(callback: OnReturnCallback<ChartScale>)

Gets a selected chart scale

open override fun getChartType(callback: OnReturnCallback<ChartType?>)

Gets a selected chart type

getDrawingParameters

open override fun getDrawingParameters(tool: DrawingTool, callback: OnReturnCallback<Map<String, Any>>)

Get a map of current parameters and settings for the requested drawing tool tool

getEngineProperty

open override fun getEngineProperty(property: String, callback: OnReturnCallback<String>)

Gets a property off the chart engine object

open override fun getHUDDetails(callback: OnReturnCallback<CrosshairHUD>)

Get HUD details

open override fun getInterval(callback: OnReturnCallback<String>)

Gets the chart's interval

getIsExtendedHours

open override fun getIsExtendedHours(callback: OnReturnCallback<Boolean>)

Gets a selected extended-hours visualization

getIsInvertYAxis

open override fun getIsInvertYAxis(callback: OnReturnCallback<Boolean>)

Gets a selected chart Y axis invertion

open override fun getPeriodicity(callback: OnReturnCallback<Int>)

Gets the chart's periodicity

open override fun getStudyList(callback: OnReturnCallback<List<Study>>)

Gets a list of available studies Study

getStudyParameters

open override fun getStudyParameters(study: Study, type: StudyParameterType, callback: OnReturnCallback<List<StudyParameter>>)

Gets a list of parameters StudyParameter of a selected study Study

open override fun getSymbol(callback: OnReturnCallback<String>)

Gets the chart's symbol

open override fun getTimeUnit(callback: OnReturnCallback<String>)

Gets the chart's time unit

getTranslations

open override fun getTranslations(languageCode: String, callback: OnReturnCallback<Map<String, String>>)

Returns a map of translations for a given language

isCrosshairsEnabled

open override fun isCrosshairsEnabled(callback: OnReturnCallback<Boolean>)

Checks if crosshair is enabled

open override fun layoutChange(json: String)

open override fun manageLayer(layer: ChartLayer)

Changes the layer of the drawing that is selected on the chart

open override fun measureChange(json: String)

pullInitialData

open override fun pullInitialData(symbol: String?, period: String?, interval: String?, start: String?, end: String?, meta: String?, callbackId: String?)

open override fun pullPagination(symbol: String?, period: String?, interval: String?, start: String?, end: String?, meta: String?, callbackId: String?)

open override fun pullUpdate(symbol: String?, period: String?, interval: String?, start: String?, meta: String?, callbackId: String?)

open override fun push(symbol: String, data: List<OHLCParams>)

Modifies a property of an existing series.

open override fun pushUpdate(data: List<OHLCParams>, useAsLastSale: Boolean)

Modifies a property of an existing series.

open override fun redoDrawing(callback: OnReturnCallback<Boolean>)

Redoes the last drawing change

open override fun removeSeries(symbolName: String)

Removes a selected symbol from the chart's series.

open override fun removeSignal(signal: Signal)

Removes a selected signal Signal from the list of active studies

open override fun removeStudy(study: Study)

Removes a selected study Study from the list of active studies

restoreDefaultDrawingConfig

open override fun restoreDefaultDrawingConfig(tool: DrawingTool, all: Boolean)

Restores the drawing tool to its default settings

open override fun saveSignal(signal: Signal, editMode: Boolean)

Add signal Signal to a list of active signals

setAggregationType

open override fun setAggregationType(aggregationType: ChartAggregationType)

Sets an Aggregation type for charts

setChartProperty

open override fun setChartProperty(property: String, value: Any)

Sets a value on the selected chart property

open override fun setChartScale(scale: ChartScale)

Sets an chart scale for charts

open override fun setChartStyle(obj: String, attribute: String, value: String)

Sets an chart style for charts

open override fun setChartType(chartType: ChartType)

Sets an chart type for charts

open override fun setDataMethod(method: DataMethod, symbol: String)

Sets data method and symbol to the chart

open override fun setDataSource(dataSource: DataSource)

Sets a DataSource for ChartIQ. Note that it should be set before calling ChartIQ.start

setDrawingParameter

open override fun setDrawingParameter(parameter: DrawingParameterType, value: String)

open override fun setDrawingParameter(parameterName: String, value: String)

Sets a value for the drawing tool parameter

setEngineProperty

open override fun setEngineProperty(property: String, value: Any)

Sets a value on the selected chart engine property

setExtendedHours

open override fun setExtendedHours(extended: Boolean)

Sets to turn on/off the extended-hours visualization.

setIsInvertYAxis

open override fun setIsInvertYAxis(inverted: Boolean)

Setting to true causes the y-axis and all linked drawings, series and studies to display inverted (flipped) from its previous state

open override fun setLanguage(languageCode: String)

Sets a language that should be used within the app

open override fun setPeriodicity(period: Int, interval: String, timeUnit: TimeUnit)

Sets periodicity to the chart

setRefreshInterval

open override fun setRefreshInterval(refreshInterval: Int)

Sets ChartIQ quotefeed refresh interval.

setSeriesParameter

open override fun setSeriesParameter(symbolName: String, parameterName: String, value: String)

Modifies a property of an existing series.

setStudyParameter

open override fun setStudyParameter(study: Study, parameter: StudyParameterModel)

Modifies a selected study Study with a single parameter

setStudyParameters

open override fun setStudyParameters(study: Study, parameters: List<StudyParameterModel>, callback: OnReturnCallback<StudySimplified>)

Modifies a selected study Study with a given list of parameters

open override fun setSymbol(symbol: String)

Sets a symbol to the chart

open override fun setTheme(theme: ChartTheme)

Sets a theme to the chart

open override fun start(onStartCallback: OnStartCallback)

Starts a ChartIQ WebClient initialization

open override fun toggleSignal(signal: Signal)

Toggle signal Signal

open override fun undoDrawing(callback: OnReturnCallback<Boolean>)

Undoes the last drawing change