ChartIQ SDK/com.chartiq.sdk.model.study/Study

Study

data class Study(val name: String, val attributes: Map<String, Any>?, val centerLine: Double, val customRemoval: Boolean, val deferUpdate: Boolean, val display: String?, var inputs: Map<String, Any>?, var outputs: Map<String, Any>?, val overlay: Boolean, var parameters: Map<String, Any>, val range: String?, val shortName: String, val type: String?, val underlay: Boolean, val yAxis: Map<String, Any>?, val signalIQExclude: Boolean) : Parcelable

Encapsulates parameters with additional information for Study. ChartIQ uses the term “study” to refer to any indicator, oscillator, average, or signal that results from technical analysis of chart data.

Constructors

Study

constructor(name: String, attributes: Map<String, Any>?, centerLine: Double, customRemoval: Boolean, deferUpdate: Boolean, display: String?, inputs: Map<String, Any>?, outputs: Map<String, Any>?, overlay: Boolean, parameters: Map<String, Any>, range: String?, shortName: String, type: String?, underlay: Boolean, yAxis: Map<String, Any>?, signalIQExclude: Boolean)

Properties

attributes

val attributes: Map<String, Any>?

Attributes of the study

centerLine

val centerLine: Double

A center line od the study

customRemoval

val customRemoval: Boolean

A custom removal of the study

deferUpdate

val deferUpdate: Boolean

A defer update of the study

display

val display: String?

A display name of the study

inputs

var inputs: Map<String, Any>?

Names and values of input fields

name

val name: String

The study's ID. Includes ZWNJ characters. Please note: To facilitate study name translations, study names use zero-width non-joiner (unprintable) characters to delimit the general study name from the specific study parameters. Example: "\u200c"+"Aroon"+"\u200c"+" (14)".

outputs