geomDensity

class geomDensity(val data: Map<*, *>? = null, val stat: StatOptions = Stat.density(), val position: PosOptions = positionIdentity, val showLegend: Boolean = true, val sampling: SamplingOptions? = null, val tooltips: TooltipOptions? = 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 linetype: Any? = null, val size: Number? = null, val weight: Any? = null, val bw: Any? = null, val kernel: String? = null, val n: Int? = null, val trim: Boolean? = null, val adjust: Number? = null, val fullScanMax: Int? = null, val quantiles: List<Number>? = null, quantileLines: Boolean? = null, val colorBy: String? = null, val fillBy: String? = null, mapping: DensityMapping.() -> Unit = {}) : Layer, AreaAesthetics, DensityStatAesthetics, DensityStatParameters, WithColorOption, WithFillOption

Displays a density estimate, which is a smoothed version of the histogram.

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.density(). 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.

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.

orientation

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

x

X-axis coordinates.

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.

size

Line width.

linetype

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

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.

weight

Used by "density" stat to compute weighted density.

bw

The method (or exact value) of bandwidth. Can be String ("nrd0" or "nrd") or Double.

kernel

The kernel used 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 If false, each density is computed on the full range of the data. If true, each density is computed over the range of that group.

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.

quantiles

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

quantileLines

default = false. Shows the quantile lines.

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.density(), position: PosOptions = positionIdentity, showLegend: Boolean = true, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, orientation: String? = null, x: Number? = null, y: Number? = null, alpha: Number? = null, color: Any? = null, fill: Any? = null, linetype: Any? = null, size: Number? = null, weight: Any? = null, bw: Any? = null, kernel: String? = null, n: Int? = null, trim: Boolean? = null, adjust: Number? = null, fullScanMax: Int? = null, quantiles: List<Number>? = null, quantileLines: Boolean? = null, colorBy: String? = null, fillBy: String? = null, mapping: DensityMapping.() -> Unit = {})

Properties

Link copied to clipboard
open override val adjust: Number? = null
Link copied to clipboard
open override val alpha: Number? = null
Link copied to clipboard
open override val bw: Any? = 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
open override val fullScanMax: Int? = null
Link copied to clipboard
val geom: GeomOptions
Link copied to clipboard
open override val kernel: String? = null
Link copied to clipboard
Link copied to clipboard
open override val linetype: Any? = null
Link copied to clipboard
val mapping: <Error class: unknown class>
Link copied to clipboard
open override val n: Int? = null
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
open override val quantiles: List<Number>? = null
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 trim: Boolean? = null
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