Study

data class Study(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>?) : 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
Link copied to clipboard
fun Study(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>?)

Functions

component1
Link copied to clipboard
operator fun component1(): String
component10
Link copied to clipboard
operator fun component10(): Map<String, Any>
component11
Link copied to clipboard
operator fun component11(): String?
component12
Link copied to clipboard
operator fun component12(): String
component13
Link copied to clipboard
operator fun component13(): String?
component14
Link copied to clipboard
operator fun component14(): Boolean
component15
Link copied to clipboard
operator fun component15(): Map<String, Any>?
component2
Link copied to clipboard
operator fun component2(): Map<String, Any>?
component3
Link copied to clipboard
operator fun component3(): Double
component4
Link copied to clipboard
operator fun component4(): Boolean
component5
Link copied to clipboard
operator fun component5(): Boolean
component6
Link copied to clipboard
operator fun component6(): String?
component7
Link copied to clipboard
operator fun component7(): Map<String, Any>?
component8
Link copied to clipboard
operator fun component8(): Map<String, Any>?
component9
Link copied to clipboard
operator fun component9(): Boolean
copy
Link copied to clipboard
fun copy(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>?): Study
describeContents
Link copied to clipboard
abstract fun describeContents(): Int
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String
writeToParcel
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

attributes
Link copied to clipboard
val attributes: Map<String, Any>?
Attributes of the study
centerLine
Link copied to clipboard
val centerLine: Double
A center line od the study
customRemoval
Link copied to clipboard
val customRemoval: Boolean
A custom removal of the study
deferUpdate
Link copied to clipboard
val deferUpdate: Boolean
A defer update of the study
display
Link copied to clipboard
val display: String?
A display name of the study
inputs
Link copied to clipboard
var inputs: Map<String, Any>?
Names and values of input fields
name
Link copied to clipboard
val name: String
The study's ID.
outputs
Link copied to clipboard
var outputs: Map<String, Any>?
Names and values (colors) of outputs
overlay
Link copied to clipboard
val overlay: Boolean
parameters
Link copied to clipboard
var parameters: Map<String, Any>
Additional parameters that are unique to the particular study
range
Link copied to clipboard
val range: String?
A range of the study
shortName
Link copied to clipboard
val shortName: String
A shortName of the study
type
Link copied to clipboard
val type: String?
The type of study, which can be used as a look up in the StudyLibrary
underlay
Link copied to clipboard
val underlay: Boolean
An underlay value of the study
yAxis
Link copied to clipboard
val yAxis: Map<String, Any>?
Y-Axis value of the study