geomViolin

class geomViolin(val data: Map<*, *>? = null, val stat: StatOptions = Stat.yDensity(), val position: PosOptions = positionDodge(), 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 violinWidth: Number? = null, val alpha: Number? = null, val color: Any? = null, val fill: Any? = null, val linetype: Any? = null, val size: Number? = null, val width: Number? = null, val weight: Number? = null, val scale: String? = null, val tailsCutoff: Number? = 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, val quantileLines: Boolean? = null, val showHalf: Number? = null, val colorBy: String? = null, val fillBy: String? = null, mapping: ViolinMapping.() -> Unit = {}) : Layer, ViolinAesthetics, ViolinParameters, YDensityStatAesthetics, YDensityStatParameters, WithColorOption, WithFillOption

A violin plot is a mirrored density plot with an additional grouping as for a boxplot.

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.yDensity(). The statistical transformation to use on the data for this layer. Supported transformations: Stat.identity, Stat.bin(), Stat.count(), etc. see Stat.

position

default = positionDodge(). 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. The default value (null) automatically determines the orientation based on the aesthetic mapping. If the automatic detection doesn't work, it can be set explicitly by specifying the "x" or "y" orientation.

quantiles

Draw horizontal lines at the given quantiles of the density estimate.

quantileLines

default = false. Show the quantile lines.

showHalf

default = 0.

  • If -1 then it's drawing only half of each violin.

  • If 1 then it's drawing other half.

  • If 0 then violins looking as usual.

x

X-axis coordinates.

y

Y-axis coordinates.

violinWidth

Density scaled for the violin plot, according to area, counts or to a constant maximum width.

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 of border. Codes and names: 0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash".

size

Lines width. Defines line width.

width

Width of violin bounding box.

weight

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

scale

default = "area".

  • If "area", all violins have the same area.

  • If "count", areas are scaled proportionally to the number of observations.

  • If "width", all violins have the same maximum width.

tailsCutoff

default = 3.0. Extends domain of each violin on tailsCutoff * bw if trim = false.

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 = true. Trims the tails of the violins 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".

Constructors

Link copied to clipboard
constructor(data: Map<*, *>? = null, stat: StatOptions = Stat.yDensity(), position: PosOptions = positionDodge(), showLegend: Boolean = true, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, orientation: String? = null, x: Number? = null, y: Number? = null, violinWidth: Number? = null, alpha: Number? = null, color: Any? = null, fill: Any? = null, linetype: Any? = null, size: Number? = null, width: Number? = null, weight: Number? = null, scale: String? = null, tailsCutoff: Number? = 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, showHalf: Number? = null, colorBy: String? = null, fillBy: String? = null, mapping: ViolinMapping.() -> 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 quantileLines: Boolean? = null
Link copied to clipboard
open override val quantiles: List<Number>? = null
Link copied to clipboard
val sampling: SamplingOptions? = null
Link copied to clipboard
open override val scale: String? = null
Link copied to clipboard
open override val showHalf: Number? = 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
open override val tailsCutoff: Number? = null
Link copied to clipboard
Link copied to clipboard
open override val trim: Boolean? = null
Link copied to clipboard
open override val violinWidth: Number? = null
Link copied to clipboard
open override val weight: Number? = null
Link copied to clipboard
open override val width: Number? = null
Link copied to clipboard
open override val x: Number? = null
Link copied to clipboard
open override val y: Number? = null