plot-api / jetbrains.letsPlot.geom / geom_vline

geom_vline

class geom_vline : VLineAesthetics, LayerBase

Add a straight vertical line to the plot.

Parameters

data - dictionary or pandas DataFrame, optional. The data to be displayed in this layer. If None, the default, the data is inherited from the plot data as specified in the call to lets_plot.

stat - string, optional. The statistical transformation to use on the data for this layer, as a string. Supported transformations: "identity" (leaves the data unchanged), "count" (counts number of points with same x-axis coordinate), "bin" (counts number of points with x-axis coordinate in the same bin), "smooth" (performs smoothing - linear default)

position - string, optional. Position adjustment, either as a string ("identity", "stack", "dodge", ...), or the result of a call to a position adjustment function.

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 - (colour) color of a geometry lines. Can be continuous or discrete. For continuous value this will be a color gradient between two colors.

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".

mapping - set of aesthetic mappings. Aesthetic mappings describe the way that variables in the data are mapped to plot "aesthetics".

Constructors

<init>

Add a straight vertical line to the plot.

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

Properties

alpha

transparency level of a layer Understands numbers between 0 and 1.

val alpha: Number?

color

(colour) color of a geometry lines. Can be continuous or discrete. For continuous value this will be a color gradient between two colors.

val color: Any?

linetype

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

val linetype: Any?

size

lines width.

val size: Number?

xintercept

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

val xintercept: Number?

Extension Functions

toSpec

fun Layer.toSpec(): MutableMap<String, Any>