geomErrorBar

class geomErrorBar(val data: Map<*, *>? = null, val stat: StatOptions = Stat.identity, val position: PosOptions = positionIdentity, val showLegend: Boolean = true, val sampling: SamplingOptions? = null, val tooltips: TooltipOptions? = null, val x: Number? = null, val ymin: Number? = null, val ymax: Number? = null, val width: Number? = null, val y: Number? = null, val xmin: Number? = null, val xmax: Number? = null, val height: Number? = null, val alpha: Number? = null, val color: Any? = null, val linetype: Any? = null, val size: Number? = null, val colorBy: String? = null, mapping: ErrorBarMapping.() -> Unit = {}) : Layer, ErrorBarAesthetics, WithColorOption

Displays error bars defined by the upper and lower values. Represents a vertical interval, defined by x, ymin, ymax, or a horizontal interval, defined by y, xmin, xmax.

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

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.

x

X-axis coordinates for the vertical error bar.

ymin

Lower bound for the vertical error bar.

ymax

Upper bound for the vertical error bar.

width

Width of the whiskers of the vertical error bar. Typically ranges between 0 and 1. Values that are greater than 1 lead to overlapping of the bars.

y

Y-axis coordinates for the horizontal error bar.

xmin

Lower bound for the horizontal error bar.

xmax

Upper bound for the horizontal error bar.

height

Height of the whiskers of the horizontal error bar. Typically ranges between 0 and 1. Values that are greater than 1 lead to overlapping of the bars.

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.

linetype

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

size

Line width.

colorBy

default = "color" ("fill", "color", "paint_a", "paint_b", "paint_c"). Defines the color 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.identity, position: PosOptions = positionIdentity, showLegend: Boolean = true, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, x: Number? = null, ymin: Number? = null, ymax: Number? = null, width: Number? = null, y: Number? = null, xmin: Number? = null, xmax: Number? = null, height: Number? = null, alpha: Number? = null, color: Any? = null, linetype: Any? = null, size: Number? = null, colorBy: String? = null, mapping: ErrorBarMapping.() -> Unit = {})

Properties

Link copied to clipboard
open override val alpha: 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
val geom: GeomOptions
Link copied to clipboard
open override val height: Number? = 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
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 width: Number? = null
Link copied to clipboard
open override val x: Number? = null
Link copied to clipboard
open override val xmax: Number? = null
Link copied to clipboard
open override val xmin: Number? = null
Link copied to clipboard
open override val y: Number? = null
Link copied to clipboard
open override val ymax: Number? = null
Link copied to clipboard
open override val ymin: Number? = null