Lets-Plot-Kotlin/org.jetbrains.letsPlot.geom/geomVLine

geomVLine

class geomVLine(val data: Map<*, *>? = null, val stat: StatOptions = Stat.identity, val position: PosOptions = positionIdentity, val showLegend: Boolean = true, val manualKey: Any? = null, val sampling: SamplingOptions? = null, val tooltips: TooltipOptions? = null, val orientation: String? = null, val xintercept: Number? = null, val alpha: Number? = null, val color: Any? = null, val linetype: Any? = null, val size: Number? = null, val colorBy: String? = null, mapping: VLineMapping.() -> Unit = {}) : Layer, VLineAesthetics, WithColorOption

Adds a straight vertical line to the plot.

Examples

lines.ipynb

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.

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.

orientation

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

xintercept

Line x-intercept. The value of x at the point where the line crosses the x-axis.

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.

size

Lines width.

linetype

Type of the line. Codes and names: 0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash". For more info see: aesthetics.html#line-types.

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

geomVLine

constructor(data: Map<*, *>? = null, stat: StatOptions = Stat.identity, position: PosOptions = positionIdentity, showLegend: Boolean = true, manualKey: Any? = null, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, orientation: String? = null, xintercept: Number? = null, alpha: Number? = null, color: Any? = null, linetype: Any? = null, size: Number? = null, colorBy: String? = null, mapping: VLineMapping.() -> Unit = {})