plotlykt-core/space.kscience.plotly.models/Error

Error

class Error : Scheme

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion : SchemeSpec<Error>

Properties

Link copied to clipboard
var array: List<Number>

Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

Link copied to clipboard
var arrayminus: List<Number>

Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars. Values are plotted relative to the underlying data.

Link copied to clipboard
val color: Color

Sets the stoke color of the error bars.

Link copied to clipboard
override var descriptor: MetaDescriptor?
Link copied to clipboard
override val meta: ObservableMutableMeta
Link copied to clipboard
var symmetric: Boolean?

Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

Link copied to clipboard
var thickness: Number

Sets the thickness (in px) of the error bars. Default: 2.

Link copied to clipboard
var traceref: Int

Integer greater than or equal to 0. Default: 0.

Link copied to clipboard
var tracerefminus: Int

Integer greater than or equal to 0. Default: 0.

Link copied to clipboard
var type: ErrorType

Enumerated , one of ("percent" | "constant" | "sqrt" | "data") Determines the rule used to generate the error bars. If "constant, the bar lengths are of a constant value. Set this constant in value. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in value. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set array`. Default: constant.

Link copied to clipboard
var value: Number

Number greater than or equal to 0. Sets the value of either the percentage (if type is set to "percent") or the constant (if type is set to "constant") corresponding to the lengths of the error bars. Default: 10.

Link copied to clipboard
var valueminus: Number

Number greater than or equal to 0. Sets the value of either the percentage (if type is set to "percent") or the constant (if type is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars. Default: 10.

Link copied to clipboard
var visible: Boolean?

Determines whether or not this set of error bars is visible.

Link copied to clipboard
var width: Number

Sets the width (in px) of the cross-bar at both ends of the error bars.

Functions

Link copied to clipboard
fun Scheme.color(key: Name? = null): ReadOnlyProperty<Scheme, Color>
Link copied to clipboard
open operator override fun get(name: Name): MutableMeta?
Link copied to clipboard
open override fun getValue(name: Name): Value?
Link copied to clipboard
fun Scheme.numberGreaterThan(minValue: Number, default: Number = minValue, key: Name? = null): ReadWriteProperty<Any?, Number>

A safe Number ray

Link copied to clipboard
fun Scheme.numberInRange(range: ClosedRange<Double>, key: Name? = null): ReadWriteProperty<Any?, Number>

A safe Number range

Link copied to clipboard
open operator override fun set(name: Name, node: Meta?)
Link copied to clipboard
open override fun setValue(name: Name, value: Value?)
Link copied to clipboard
fun Scheme.toJsonString(): String

Convert any type-safe configurator to json string

Link copied to clipboard
open override fun toMeta(): Laminate
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open fun validate(name: Name, meta: Meta?): Boolean