geomYDotplot

class geomYDotplot(val data: Map<*, *>? = null, val showLegend: Boolean = true, val inheritAes: Boolean? = null, val manualKey: Any? = null, val sampling: SamplingOptions? = null, val tooltips: TooltipOptions? = null, val orientation: String? = null, val x: Number? = null, val y: Any? = null, val bins: Int? = null, val center: Number? = null, val boundary: Number? = null, val method: String? = null, var binWidth: Number? = null, var stackSize: Number? = null, val stackDir: String? = null, val stackRatio: Number? = null, val dotSize: Number? = null, val stackGroups: Boolean? = null, val stroke: Number? = null, val alpha: Number? = null, val color: Any? = null, val fill: Any? = null, val colorBy: String? = null, val fillBy: String? = null, mapping: YDotplotMapping.() -> Unit = {}) : Layer, YDotplotAesthetics, YDotplotParameters, YDotplotStatAesthetics, YDotplotStatParameters, WithColorOption, WithFillOption

Y-dotplot represents individual observations in a batch of data with circular dots. The diameter of a dot corresponds to the maximum width or bin width, depending on the binning algorithm. geomYDotplot() is an obvious blend of geomViolin() and geomDotplot().

Notes

With "dotdensity" binning, the bin positions are determined by the data and binwidth, which is the maximum width of each bin. With "histodot" binning, the bins have fixed positions and fixed widths, much like a histogram.

Computed variables:

  • ..count.. : number of points with y-axis coordinate in the same bin.

  • ..binwidth.. : max width of each bin if method is "dotdensity"; width of each bin if method is "histodot".

To hide axis tooltips, set "blank" or the result of elementBlank() to the axisTooltip, axisTooltipX or axisTooltipY parameter of the theme().

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.

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.

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.

x

X-axis coordinates.

y

Y-axis coordinates.

bins

When method is "histodot", this specifies number of bins (default = 30). Overridden by binWidth.

center

When method is "histodot", this specifies x-value to align bin centers to.

boundary

When method is "histodot", this specifies x-value to align bin boundary (i.e. point between bins) to.

method

default = "dotdensity". Use "dotdensity" for dot-density binning, or "histodot" for fixed bin widths (like in geomHistogram()).

binWidth

When method is "dotdensity", this specifies maximum bin width. When method is "histodot", this specifies bin width.

stackDir

default = "up". Which direction to stack the dots. Values: "up", "down", "center", "centerwhole".

stackRatio

default = 1.0. How close to stack the dots. Use smaller values for closer, overlapping dots.

dotSize

default = 1.0. The diameter of the dots relative to binwidth.

stackGroups

Whether dots should be stacked across groups. In effect is replacemets for option position = positionStack(). Note: unlike other geoms, dotplot doesn't have position option.

stroke

Width of the dot border.

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.

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, showLegend: Boolean = true, inheritAes: Boolean? = null, manualKey: Any? = null, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, orientation: String? = null, x: Number? = null, y: Any? = null, bins: Int? = null, center: Number? = null, boundary: Number? = null, method: String? = null, binWidth: Number? = null, stackSize: Number? = null, stackDir: String? = null, stackRatio: Number? = null, dotSize: Number? = null, stackGroups: Boolean? = null, stroke: Number? = null, alpha: Number? = null, color: Any? = null, fill: Any? = null, colorBy: String? = null, fillBy: String? = null, mapping: YDotplotMapping.() -> 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 var binWidth: Number?
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 dotSize: Number? = 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
Link copied to clipboard
val manualKey: Any? = null
Link copied to clipboard
val mapping: <Error class: unknown class>
Link copied to clipboard
open override val method: String? = 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
val sampling: SamplingOptions? = null
Link copied to clipboard
Link copied to clipboard
open override val stackDir: String? = null
Link copied to clipboard
open override val stackGroups: Boolean? = null
Link copied to clipboard
open override val stackRatio: Number? = null
Link copied to clipboard
open override var stackSize: Number?
Link copied to clipboard
val stat: StatOptions
Link copied to clipboard
open override val stroke: Number? = null
Link copied to clipboard
Link copied to clipboard
open override val x: Number? = null
Link copied to clipboard
open override val y: Any? = null