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

statBin2D

class statBin2D(val data: Map<*, *>? = null, val geom: GeomOptions = Geom.tile(), val position: PosOptions = positionIdentity, val showLegend: Boolean = true, val sampling: SamplingOptions? = null, val x: Number? = null, val y: Number? = null, val width: Number? = null, val height: Number? = null, val alpha: Number? = null, val color: Any? = null, val fill: Any? = null, val linetype: Any? = null, val size: Number? = null, val weight: Any? = null, val bins: <Error class: unknown class><Int, Int>? = null, val binWidth: <Error class: unknown class><Number?, Number?>? = null, val drop: Boolean? = null, val colorBy: String? = null, val fillBy: String? = null, mapping: Bin2dMapping.() -> Unit = {}) : Layer, TileAesthetics, Bin2dStatAesthetics, Bin2dStatParameters, WithColorOption, WithFillOption

Displays a 2d distribution by dividing the plane into a grid and counting the number of observations in each rectangle.

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 bin2D stat for this layer, default is Geom.tile(), 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.md.

X-axis value.

Y-axis value.

width

Width of a bin.

height

Height of a bin.

alpha

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

color

Color of the geometry. String in the following formats:

RGB/RGBA (e.g. "rgb(0, 0, 255)")
HEX (e.g. "#0000FF")
color name (e.g. "red")
role name ("pen", "paper" or "brush")

Or an instance of the java.awt.Color class.

fill

Fill color. String in the following formats:

RGB/RGBA (e.g. "rgb(0, 0, 255)")
HEX (e.g. "#0000FF")
color name (e.g. "red")
role name ("pen", "paper" or "brush")

Or an instance of the java.awt.Color class.

linetype

Type of the line. Codes and names: 0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash".

size

Lines width.

weight

Used by Stat.bin2D()stat to compute weighted sum instead of simple count.

bins

default = Pair(30, 30). Number of bins in both directions, vertical and horizontal. Overridden by binWidth.

binWidth

The width of the bins in both directions, vertical and horizontal. Overrides bins. The default is to use bin widths that cover the entire range of the data.

drop

default = true. Specifies whether to remove all bins with 0 counts.

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

statBin2D

constructor(data: Map<*, *>? = null, geom: GeomOptions = Geom.tile(), position: PosOptions = positionIdentity, showLegend: Boolean = true, sampling: SamplingOptions? = null, x: Number? = null, y: Number? = null, width: Number? = null, height: Number? = null, alpha: Number? = null, color: Any? = null, fill: Any? = null, linetype: Any? = null, size: Number? = null, weight: Any? = null, bins: <Error class: unknown class><Int, Int>? = null, binWidth: <Error class: unknown class><Number?, Number?>? = null, drop: Boolean? = null, colorBy: String? = null, fillBy: String? = null, mapping: Bin2dMapping.() -> Unit = {})