plot-api / jetbrains.letsPlot.geom / geom_ribbon

geom_ribbon

class geom_ribbon : RibbonAesthetics, LayerBase

Display a y interval defined by ymin and ymax.

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.

x - x-axis coordinates.

ymin - y-axis coordinates of the lower bound.

ymax - y-axis coordinates of the upper bound.

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 of tile's border. Codes and names: 0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash".

fill - color of geometry filling.

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

Constructors

<init>

Display a y interval defined by ymin and ymax.

geom_ribbon(data: Map<*, *>? = null, stat: StatOptions = Stat.identity, position: PosOptions = Pos.identity, showLegend: Boolean = true, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, x: Double? = null, ymin: Double? = null, ymax: Double? = null, size: Number? = null, linetype: Any? = null, color: Any? = null, fill: Any? = null, alpha: Number? = null, mapping: RibbonMapping.() -> 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?

fill

color of geometry filling.

val fill: 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

lines width.

val size: Number?

x

x-axis coordinates.

val x: Double?

ymax

y-axis coordinates of the upper bound.

val ymax: Double?

ymin

y-axis coordinates of the lower bound.

val ymin: Double?

Extension Functions

toSpec

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