Lets-Plot-Kotlin/org.jetbrains.letsPlot.stat/statBin

statBin

class statBin(val data: Map<*, *>? = null, val geom: GeomOptions = Geom.histogram(), val position: PosOptions = positionStack(), val showLegend: Boolean = true, val manualKey: Any? = null, val sampling: SamplingOptions? = null, val x: Number? = null, val y: Number? = null, val alpha: Number? = null, val color: Any? = null, val fill: Any? = null, val size: Number? = null, val weight: Any? = null, val bins: Int? = null, val binWidth: Number? = null, val center: Number? = null, val boundary: Number? = null, val threshold: Number? = null, val colorBy: String? = null, val fillBy: String? = null, mapping: HistogramMapping.() -> Unit = {}) : Layer, HistogramAesthetics, BinStatAesthetics, BinStatParameters, WithColorOption, WithFillOption

Displays a 1d distribution by dividing variable mapped to x-axis into bins and counting the number of observations in each bin.

Notes

Computed variables:

..count.. : number of points with x-axis coordinate in the same bin.
..density.. : normalised number of points so that plot area is 1.
..sumprop.. : normalised number of points so that sum of y-values is 1.
..sumpct.. : normalised number of points so that sum of y-values is 100.
..binwidth.. : width of each bin.

Parameters

data

The data to be displayed in this layer. If null, the default, the data is inherited from the plot data as specified in the call to letsPlot.

geom

The geometry to display the bin stat for this layer, default is Geom.histogram(), see Geom.

position

Position adjustment: positionIdentity, positionStack(), positionDodge(), etc. see Position.

showLegend

default = true. false - do not show legend for this layer.

sampling

Result of the call to the samplingXxx() function. To prevent any sampling for this layer pass value samplingNone. For more info see sampling.html.

X-axis coordinates.

Y-axis coordinates.

alpha

Transparency level of a layer. Understands numbers between 0 and 1.

color

Color of the geometry. For more info see: aesthetics.html#color-and-fill.

fill

Fill color. For more info see: aesthetics.html#color-and-fill.

size

Lines width.

weight

Used to compute weighted sum instead of simple count.

bins

Number of bins. Overridden by binWidth.

binWidth

The width of the bins. The default is to use bin widths that cover the entire range of the data. You should always override this value, exploring multiple widths to find the best to illustrate the stories in your data.

center

Specifies x-value to align bin centers to.

boundary

Specifies x-value to align bin boundary (i.e. point between bins) to.

threshold

default = null Only bins with a ..count.. greater than the threshold will be displayed. This is useful for free scales in facets - use threshold=0 to make the plot take up the entire panel space.

colorBy

default = "color" ("fill", "color", "paint_a", "paint_b", "paint_c"). Defines the color aesthetic for the geometry.

fillBy

default = "fill" ("fill", "color", "paint_a", "paint_b", "paint_c"). Defines the fill aesthetic for the geometry.

mapping

Set of aesthetic mappings. Aesthetic mappings describe the way that variables in the data are mapped to plot "aesthetics".

Constructors

statBin

constructor(data: Map<*, *>? = null, geom: GeomOptions = Geom.histogram(), position: PosOptions = positionStack(), showLegend: Boolean = true, manualKey: Any? = null, sampling: SamplingOptions? = null, x: Number? = null, y: Number? = null, alpha: Number? = null, color: Any? = null, fill: Any? = null, size: Number? = null, weight: Any? = null, bins: Int? = null, binWidth: Number? = null, center: Number? = null, boundary: Number? = null, threshold: Number? = null, colorBy: String? = null, fillBy: String? = null, mapping: HistogramMapping.() -> Unit = {})