Box

class Box : Trace, SelectedPoints

Types

Companion

common

object Companion : SchemeSpec<Box>

Functions

axis

common

fun axis(axisName: String): TraceValues

colorbar

common

fun colorbar(block: ColorBar.() -> Unit)

domain

common

fun domain(block: Domain.() -> Unit)

error_x

common

fun error_x(block: Error.() -> Unit)

error_y

common

fun error_y(block: Error.() -> Unit)

getItem

common

open override fun getItem(name: Name): MetaItem?

hoverlabel

common

fun hoverlabel(block: Hoverlabel.() -> Unit)

labels

common

fun labels(array: Iterable<Any>)

line

common

fun line(block: LayoutLine.() -> Unit)

lowerfence

common

fun lowerfence(array: Iterable<Any>)

marker

common

fun marker(block: Marker.() -> Unit)

mean

common

fun mean(array: Iterable<Any>)

median

common

fun median(array: Iterable<Any>)

notchspan

common

fun notchspan(array: Iterable<Any>)

onChange

common

open override fun onChange(owner: Any?, action: (Name, MetaItem?, MetaItem?) -> Unit)

common

fun q1(array: Iterable<Any>)

common

fun q3(array: Iterable<Any>)

removeListener

common

open override fun removeListener(owner: Any?)

common

fun sd(array: Iterable<Any>)

selected

common

fun selected(block: SelectPoints.() -> Unit)

setItem

common

open override fun setItem(name: Name, item: MetaItem?)

textfont

common

fun textfont(block: Font.() -> Unit)

toMeta

common

open override fun toMeta(): Laminate

unselected

common

fun unselected(block: SelectPoints.() -> Unit)

upperfence

common

fun upperfence(array: Iterable<Any>)

validateItem

common

open fun validateItem(name: Name, item: MetaItem?): Boolean

values

common

fun values(array: Iterable<Any>)

Properties

axis

common

val axis: ReadOnlyProperty<Scheme, TraceValues>

boxmean

common

var boxmean: BoxMean

If "true", the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es).

boxpoints

common

var boxpoints: BoxPoints

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.

cliponaxis

common

var cliponaxis: Boolean?

Determines whether or not markers and text nodes are clipped about the subplot axes.

colorbar

common

var colorbar: ColorBar

colorscale

common

var colorscale: Value?

Sets the colorscale.

connectgaps

common

var connectgaps: Boolean?

Determines whether or not gaps (i.e.

defaultLayer

common

open val defaultLayer: Meta

descriptor

common

override var descriptor: NodeDescriptor?

domain

common

var domain: Domain

common

var dx: Number

Sets the x coordinate step.

common

var dy: Number

Sets the y coordinate step.

error_x

common

var error_x: Error

error_y

common

var error_y: Error

fillcolor

common

val fillcolor: Color

Sets the fill color if contours.type is "constraint".

hoverinfo

common

var hoverinfo: String?

Flaglist string.

hoverlabel

common

var hoverlabel: Hoverlabel

hoveron

common

var hoveron: BoxHoveron

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

jitter

common

var jitter: Double

Sets the amount of jitter in the sample points drawn.

labels

common

var labels: List<Value>

Data array.

legendgroup

common

var legendgroup: String?

Sets the legend group for this trace.

line

common

var line: LayoutLine

lowerfence

common

var lowerfence: List<Value>

Sets the lower fence values.

marker

common

var marker: Marker

mean

common

var mean: List<Value>

Sets the mean values.

median

common

var median: List<Value>

Sets the median values.

name

common

var name: String?

Sets the trace name.

notched

common

var notched: Boolean?

Determines whether or not notches are drawn.

notchspan

common

var notchspan: List<Value>

Sets the notch span from the boxes' median values.

notchwidth

common

var notchwidth: Double

Sets the width of the notches relative to the box' width.

opacity

common

var opacity: Number

Sets the opacity of the trace.

orientation

common

var orientation: Orientation

Sets the orientation of the plot(s).

pointpos

common

var pointpos: Double

Sets the position of the sample points in relation to the violins.

common

var q1: List<Value>

Sets the Quartile 1 values.

common

var q3: List<Value>

Sets the Quartile 3 values.

quartilemethod

common

var quartilemethod: QuartileMethod

Sets the method used to compute the sample's Q1 and Q3 quartiles.

reversescale

common

var reversescale: Boolean?

Reverses the color mapping if true.

scalegroup

common

var scalegroup: String?

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.

common

var sd: List<Value>

Sets the standard deviation values.

selected

common

open override var selected: SelectPoints

selectedpoints

common

open override var selectedpoints: List<Number>

Array containing integer indices of selected points.

showlegend

common

var showlegend: Boolean?

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

showscale

common

var showscale: Boolean?

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

text

common

var text: TraceValues

Sets text elements associated with each (x,y) pair.

textfont

common

var textfont: Font

Sets the text font.

textposition

common

var textposition: TextPosition

Sets the position of the text elements with respects to the (x,y) coordinates.

textpositionsList

common

var textpositionsList: List<Value>

Sets the positions of the text elements with respects to the (x,y) coordinates.

transpose

common

var transpose: Boolean?

Transposes the z data.

type

common

var type: TraceType

unselected

common

open override var unselected: SelectPoints

upperfence

common

var upperfence: List<Value>

Sets the upper fence values.

values

common

var values: List<Value>

Data array.

visible

common

var visible: Visible

Enumerated , one of ( true | false | "legendonly" ) Determines whether or not this trace is visible.

whiskerwidth

common

var whiskerwidth: Double

Sets the width of the whiskers relative to the box' width.

width

common

var width: Number

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.

common

val x: TraceValues

Sets the x coordinates.

common

var x0: Value?

Alternate to x.

xcalendar

common

var xcalendar: Calendar

Sets the calendar system to use with x date data.

common

val y: TraceValues

Sets the y coordinates.

common

var y0: Value?

Alternate to y.

ycalendar

common

var ycalendar: Calendar

Sets the calendar system to use with y date data.

common

var z: TraceValues

Z coordinates

zauto

common

var zauto: Boolean?

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.

zmax

common

var zmax: Number?

Sets the upper bound of the color domain.

zmid

common

var zmid: Number?

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point.

zmin

common

var zmin: Number?

Sets the lower bound of the color domain.