Bins

class Bins : Scheme

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion : SchemeSpec<Bins>

Properties

Link copied to clipboard
override var descriptor: MetaDescriptor?
Link copied to clipboard
var end: Number?

Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by size from start until we reach or exceed end. Defaults to the maximum data value. Like start, for dates use a date string, and for category data end is based on the category serial numbers.

Link copied to clipboard
override val meta: ObservableMutableMeta
Link copied to clipboard

Sets the size of each x axis bin. Default behavior: If nbinsx is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If nbinsx is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or "M" for months, as in axis.dtick. For category data, the number of categories to bin together (always defaults to 1).

Link copied to clipboard

Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a size of 5 would have a default start of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and start should be a date string. For category data, start is based on the category serial numbers, and defaults to -0.5.

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