plot-api / jetbrains.letsPlot.geom / geom_hline

geom_hline

class geom_hline : HLineAesthetics, LayerBase

Add a straight horizontal 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.

tooltips - result of the call to the layer_tooltips() function. Specifies appearance, style and content.

yintercept - line y-intercept The value of y at the point where the line crosses the y 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 - line width.

linetype - type of the line of tile's border. 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 horizontal line to the plot.

geom_hline(data: Map<*, *>? = null, stat: StatOptions = Stat.identity, position: PosOptions = identity, showLegend: Boolean = true, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, yintercept: Number? = null, alpha: Number? = null, color: Any? = null, linetype: Any? = null, size: Number? = null, mapping: HLineMapping.() -> 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 of tile's border. Codes and names: 0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash".

val linetype: Any?

size

line width.

val size: Number?

yintercept

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

val yintercept: Number?

Extension Functions

toSpec

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