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

StudyParameter

sealed class StudyParameter : Parcelable

A base class of active study parameter

Inheritors

Types

Checkbox

data class Checkbox(val heading: String, val name: String, val parameterType: StudyParameterType, val defaultValue: Boolean, val value: Boolean) : StudyParameter

A boolean parameter of active study Study

Color

data class Color(val heading: String, val name: String, val parameterType: StudyParameterType, val defaultValue: String, val value: String) : StudyParameter

A color parameter of active study Study

Number

data class Number(val heading: String, val name: String, val parameterType: StudyParameterType, val defaultValue: Double, val value: Double) : StudyParameter

A number parameter of active study Study

Select

data class Select(val heading: String, val name: String, val parameterType: StudyParameterType, val defaultValue: String, val value: String, val options: Map<String, String>) : StudyParameter

A parameter of active study Study that has a limited list of possible options

StudyParameterNamePostfix

enum StudyParameterNamePostfix : Enum<StudyParameter.StudyParameterNamePostfix>

A set of postfixes supported by the library

Text

data class Text(val heading: String, val name: String, val parameterType: StudyParameterType, val defaultValue: String, val value: String) : StudyParameter

A text parameter of active study Study

TextColor

data class TextColor(val heading: String, val name: String, val parameterType: StudyParameterType, val defaultValue: Double, val value: Double?, val defaultColor: String, val color: String?) : StudyParameter

A parameter of active study Study that contains a number and a color

Properties

heading

abstract val heading: String

A user-friendly name of the parameter

name

abstract val name: String

A name of a parameter to be used as identifier of a parameter

parameterType

abstract val parameterType: StudyParameterType

A parameter type