Lets-Plot-Kotlin/org.jetbrains.letsPlot.geom/geomHistogram/geomHistogram

geomHistogram

constructor(data: Map<*, *>? = null, stat: StatOptions = Stat.bin(), position: PosOptions = positionStack(), showLegend: Boolean = true, inheritAes: Boolean? = null, manualKey: Any? = null, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, labels: AnnotationOptions? = null, orientation: String? = 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 = {})

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.

stat

default = Stat.bin(). The statistical transformation to use on the data for this layer. Supported transformations: Stat.identity, Stat.bin(), Stat.count(), etc. see Stat.

position

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

showLegend

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

inheritAes

default = true. false - do not combine the layer aesthetic mappings with the plot shared mappings.

manualKey

String or result of the call to the layerKey() function. The key to show in the manual legend. Specifies the text for the legend label or advanced settings using the layerKey() function.

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.

tooltips

Result of the call to the layerTooltips() function. Specifies appearance, style and content. Set tooltips = tooltipsNone to hide tooltips from the layer.

labels

Result of the call to the layerLabels() function. Specifies style and content of the annotations.

orientation

Specifies the axis that the layer's stat and geom should run along, default = "x". Possible values: "x", "y".

x

X-axis value (this value will produce cases or bins for bars).

y

Y-axis value (this value will be used to multiply the bar heights), setting y to "..density.." produces normalized (density) histogram.

alpha

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

color

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

fill

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

size

Defines bar line width.

weight

Used by Stat.bin() 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".