geomAreaRidges

constructor(data: Map<*, *>? = null, stat: StatOptions = Stat.densityRidges(), position: PosOptions = positionIdentity, showLegend: Boolean = true, inheritAes: Boolean? = null, manualKey: Any? = null, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, x: Number? = null, y: Number? = null, height: Number? = null, quantile: Number? = null, alpha: Number? = null, color: Any? = null, fill: Any? = null, linetype: Any? = null, size: Number? = null, weight: Number? = null, scale: Number? = null, minHeight: Number? = null, quantileLines: Boolean? = null, tailsCutoff: Number? = null, quantiles: List<Number>? = null, bw: Any? = null, kernel: String? = null, n: Int? = null, trim: Boolean? = null, adjust: Number? = null, fullScanMax: Int? = null, colorBy: String? = null, fillBy: String? = null, mapping: AreaRidgesMapping.() -> 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.densityRidges(). The statistical transformation to use on the data for this layer. Supported transformations: Stat.identity, Stat.bin(), Stat.count(), etc. see Stat.

position

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.

x

X-axis coordinates.

y

Y-axis coordinates.

height

Height of the ridge. Assumed to be between 0 and 1, though this is not required.

quantile

Quantile values to draw quantile lines and fill quantiles of the geometry by color.

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.

linetype

Type of the line of border. Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"), a hex string (up to 8 digits for dash-gap lengths), or a pattern offset to listOf(dash, gap, ...) / listOf(dash, gap, ...). For more info see: aesthetics.html#line-types.

size

Defines line width.

weight

Used by Stat.densityRidges() stat to compute weighted density.

scale

default = 1.0 A multiplicative factor applied to height aesthetic. If scale = 1.0, the heights of a ridges are automatically scaled such that the ridge with height = 1.0 just touches the one above.

minHeight

default = 0.0. A height cutoff on the drawn ridges. All values that fall below this cutoff will be removed.

quantileLines

default = false. Shows the quantile lines.

tailsCutoff

Extends domain of each ridge on tailsCutoff * bw if trim = false. tailsCutoff = null (default) extends domain to maximum (domain overall ridges).

quantiles

default = listOf(0.25, 0.5, 0.75). Draws horizontal lines at the given quantiles of the density estimate.

bw

String or Double. The method (or exact value) of bandwidth. Either a string (choose among "nrd0" and "nrd") or a double.

kernel

The kernel we use to calculate the density function. Choose among "gaussian", "cosine", "optcosine", "rectangular" (or "uniform"), "triangular", "biweight" (or "quartic"), "epanechikov" (or "parabolic").

n

The number of sampled points for plotting the function.

trim

default = false. Trims the tails of the ridges to the range of the data.

adjust

Adjusts the value of bandwidth by multiplying it. Changes how smooth the frequency curve is.

fullScanMax

Maximum size of data to use density computation with "full scan". For bigger data, less accurate but more efficient density computation is applied.

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