geomHistogram

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

Examples

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.

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.

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. 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.

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.

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

Link copied to clipboard
constructor(data: Map<*, *>? = null, stat: StatOptions = Stat.bin(), position: PosOptions = positionStack(), showLegend: Boolean = true, 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, colorBy: String? = null, fillBy: String? = null, mapping: HistogramMapping.() -> Unit = {})

Properties

Link copied to clipboard
open override val alpha: Number? = null
Link copied to clipboard
open override val bins: Int? = null
Link copied to clipboard
open override val binWidth: Number? = null
Link copied to clipboard
open override val boundary: Number? = null
Link copied to clipboard
open override val center: Number? = null
Link copied to clipboard
open override val color: Any? = null
Link copied to clipboard
open override val colorBy: String? = null
Link copied to clipboard
val data: Map<*, *>? = null
Link copied to clipboard
open override val fill: Any? = null
Link copied to clipboard
open override val fillBy: String? = null
Link copied to clipboard
val geom: GeomOptions
Link copied to clipboard
Link copied to clipboard
val mapping: <Error class: unknown class>
Link copied to clipboard
val orientation: String? = null
Link copied to clipboard
val parameters: <Error class: unknown class>
Link copied to clipboard
val position: PosOptions?
Link copied to clipboard
val sampling: SamplingOptions? = null
Link copied to clipboard
Link copied to clipboard
open override val size: Number? = null
Link copied to clipboard
val stat: StatOptions
Link copied to clipboard
Link copied to clipboard
open override val weight: Any? = null
Link copied to clipboard
open override val x: Number? = null
Link copied to clipboard
open override val y: Number? = null