Box

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion : SchemeSpec<Box>

Properties

Link copied to clipboard
Link copied to clipboard

If "true", the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If "sd" the standard deviation is also drawn. Defaults to "true" when mean is set. Defaults to "sd" when sd is set Otherwise defaults to "false".

Link copied to clipboard

If "outliers", only the sample points lying outside the whiskers are shown If "suspectedoutliers", the outlier points are shown and points either less than 4"Q1-3"Q3 or greater than 4"Q3-3"Q1 are highlighted (see outliercolor) If "all", all sample points are shown If "false", only the box(es) are shown with no sample points Defaults to "suspectedoutliers" when marker.outliercolor or marker.line.outliercolor is set. Defaults to "all" under the q1/median/q3 signature. Otherwise defaults to "outliers".

Link copied to clipboard

Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to "below traces".

Link copied to clipboard
Link copied to clipboard
var colorscale: Value?

Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string.

Link copied to clipboard

Determines whether or not gaps (i.e. {nan} or missing values) in the z data are filled in. It is defaulted to true if z is a one dimensional array and zsmooth is not false; otherwise it is defaulted to false.

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

Sets the x coordinate step. See x0 for more info. Default: 1.

Link copied to clipboard
var dy: Number

Sets the y coordinate step. See y0 for more info. Default: 1.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Sets the fill color if contours.type is "constraint". Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

Link copied to clipboard

Flaglist string. Any combination of "x", "y", "z", "text", "name" joined with a "+" OR "all" or "none" or "skip". Examples: "x", "y", "x+y", "x+y+z", "all", default: "all". Determines which trace information appear on hover. If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

Link copied to clipboard
Link copied to clipboard

Do the hover effects highlight individual boxes or sample points or both?

Link copied to clipboard

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace hoverinfo must contain a "text" flag.

Link copied to clipboard

Sets the amount of jitter in the sample points drawn. If "0", the sample points align along the distribution axis. If "1", the sample points are drawn in a random jitter of width equal to the width of the violins.

Link copied to clipboard
var labels: List<Value>

Data array. Sets the sector labels. If labels entries are duplicated, we sum associated values or simply count occurrences if values is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

Link copied to clipboard

Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items. Default: ""

Link copied to clipboard
Link copied to clipboard
var lowerfence: List<Value>

Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If lowerfence is not provided but a sample (in y or x) is set, we compute the lower as the last sample point below 1.5 times the IQR.

Link copied to clipboard
Link copied to clipboard
var mean: List<Value>

Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If mean is not provided but a sample (in y or x) is set, we compute the mean for each box using the sample values.

Link copied to clipboard
var median: List<Value>

Sets the median values. There should be as many items as the number of boxes desired.

Link copied to clipboard
override val meta: ObservableMutableMeta
Link copied to clipboard
var name: String?

Sets the trace name. The trace name appear as the legend item and on hover.

Link copied to clipboard

Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 " IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes' notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home/notched-box-plots for more info. Defaults to "false" unless notchwidth or notchspan is set.

Link copied to clipboard
var notchspan: List<Value>

Sets the notch span from the boxes' median values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If notchspan is not provided but a sample (in y or x) is set, we compute it as 1.57 " IQR / sqrt(N), where N is the sample size.

Link copied to clipboard

Sets the width of the notches relative to the box' width. For example, with 0, the notches are as wide as the box(es). Default: 0.25.

Link copied to clipboard

Sets the opacity of the trace. Default: 1.

Link copied to clipboard

Sets the orientation of the plot(s). If "vertical" ("horizontal"), the data is visualized along the vertical (horizontal).

Link copied to clipboard

Sets the position of the sample points in relation to the violins. If "0", the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.

Link copied to clipboard
var q1: List<Value>

Sets the Quartile 1 values. There should be as many items as the number of boxes desired.

Link copied to clipboard
var q3: List<Value>

Sets the Quartile 3 values. There should be as many items as the number of boxes desired.

Link copied to clipboard

Sets the method used to compute the sample's Q1 and Q3 quartiles. The "linear" method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://www.amstat.org/publications/jse/v14n3/langford.html). The "exclusive" method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The "inclusive" method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.

Link copied to clipboard

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

Link copied to clipboard

If there are multiple violins that should be sized according to some metric (see scalemode), link them by providing a non-empty group id here shared by every trace in the same group. If a violin's width is undefined, scalegroup will default to the trace's name. In this case, violins with the same names will be linked together. Default: ""

Link copied to clipboard
var sd: List<Value>

Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If sd is not provided but a sample (in y or x) is set, we compute the standard deviation for each box using the sample values.

Link copied to clipboard
open override var selected: SelectPoints
Link copied to clipboard
open override var selectedpoints: List<Number>

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

Link copied to clipboard

Determines whether or not an item corresponding to this trace is shown in the legend. Default: true

Link copied to clipboard

Determines whether or not a colorbar is displayed for this trace.

Link copied to clipboard

Sets text elements associated with each (x,y) pair. The same string appears over all the data points. If trace hoverinfo contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.

Link copied to clipboard

Sets the text font.

Link copied to clipboard

Sets the position of the text elements with respects to the (x,y) coordinates. Default: "middle center".

Link copied to clipboard

Sets the positions of the text elements with respects to the (x,y) coordinates. Default: "middle center".

Link copied to clipboard

Transposes the z data.

Link copied to clipboard
Link copied to clipboard
open override var unselected: SelectPoints
Link copied to clipboard
var upperfence: List<Value>

Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If upperfence is not provided but a sample (in y or x) is set, we compute the lower as the last sample point above 1.5 times the IQR.

Link copied to clipboard
var values: List<Value>

Data array. Sets the values of the sectors. If omitted, we count occurrences of each label.

Link copied to clipboard

Enumerated , one of ( true | false | "legendonly" ) Determines whether or not this trace is visible. If "legendonly", the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible). Default: true.

Link copied to clipboard

Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es). Default: 0.5.

Link copied to clipboard

Sets the width of the box in data coordinate If "0" (default value) the width is automatically selected based on the positions of other box traces in the same subplot.

Link copied to clipboard

Sets the x coordinates.

Link copied to clipboard
var x0: Value?

Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step. Default: 0.

Link copied to clipboard

Sets the calendar system to use with x date data.

Link copied to clipboard

Sets the y coordinates.

Link copied to clipboard
var y0: Value?

Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

Link copied to clipboard

Sets the calendar system to use with y date data.

Link copied to clipboard

Z coordinates

Link copied to clipboard

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

Link copied to clipboard
var zmax: Number?

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

Link copied to clipboard
var zmid: Number?

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

Link copied to clipboard
var zmin: Number?

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

Functions

Link copied to clipboard
fun Trace.appendXY(vararg pairs: Pair<Number, Number>)

Append trace values using given pairs of x-y number coordinates

fun Trace.appendXY(x: Number, y: Number, xErr: Number? = null, yErr: Number? = null)

Append x and y axis values to a trace with optional x error xErr and y error yErr

Link copied to clipboard
fun axis(axisName: String): TraceValues
Link copied to clipboard
fun Scheme.color(key: Name? = null): ReadOnlyProperty<Scheme, Color>
Link copied to clipboard
fun colorbar(block: ColorBar.() -> Unit)
Link copied to clipboard
fun domain(block: Domain.() -> Unit)
Link copied to clipboard
fun error_x(block: Error.() -> Unit)
Link copied to clipboard
fun error_y(block: Error.() -> Unit)
Link copied to clipboard
fun Trace.functionXY(xs: Iterable<Number>, function: (Double) -> Number)

Fill trace x and y with values based on given xs and a function for y values. Old values are erased.

fun Trace.functionXY(xRange: IntRange, function: (Int) -> Number)

Fill trace x and y with values based on a given integer xRange and a numeric function. Old values are erased.

fun Trace.functionXY(xRange: ClosedFloatingPointRange<Double>, step: Double = 1.0, function: (Double) -> Number)

Fill values in xRange with given step using given function. Old values are erased.

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 hoverlabel(block: Hoverlabel.() -> Unit)
Link copied to clipboard
fun labels(array: Iterable<Any>)
Link copied to clipboard
fun line(block: LayoutLine.() -> Unit)
Link copied to clipboard
fun lowerfence(array: Iterable<Any>)
Link copied to clipboard
fun marker(block: Marker.() -> Unit)
Link copied to clipboard
fun mean(array: Iterable<Any>)
Link copied to clipboard
fun median(array: Iterable<Any>)
Link copied to clipboard
fun notchspan(array: Iterable<Any>)
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
fun q1(array: Iterable<Any>)
Link copied to clipboard
fun q3(array: Iterable<Any>)
Link copied to clipboard
fun sd(array: Iterable<Any>)
Link copied to clipboard
fun selected(block: SelectPoints.() -> Unit)
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 textfont(block: Font.() -> Unit)
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
fun unselected(block: SelectPoints.() -> Unit)
Link copied to clipboard
fun upperfence(array: Iterable<Any>)
Link copied to clipboard
open fun validate(name: Name, meta: Meta?): Boolean
Link copied to clipboard
fun values(array: Iterable<Any>)