geomRibbon

class geomRibbon(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 y: Number? = null, val xmin: Number? = null, val xmax: Number? = null, val size: Number? = null, val linetype: Any? = null, val color: Any? = null, val fill: Any? = null, val alpha: Number? = null, val colorBy: String? = null, val fillBy: String? = null, mapping: RibbonMapping.() -> Unit = {}) : Layer, RibbonAesthetics, WithColorOption, WithFillOption

Displays a y interval defined by ymin and ymax. Draws a ribbon bounded by ymin and ymax, or a vertical ribbon, bounded by 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 horizontal ribbon.

ymin

Y-axis coordinates of the lower bound for horizontal ribbon.

ymax

Y-axis coordinates of the upper bound for horizontal ribbon.

y

Y-axis coordinates for vertical ribbon.

xmin

X-axis coordinates of the lower bound for vertical ribbon.

xmax

X-axis coordinates of the upper bound for vertical ribbon.

alpha

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

color

Color of the geometry. 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.

size

Lines width.

linetype

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

fill

Fill color. 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.

colorBy

default = "color" ("fill", "color", "paint_a", "paint_b", "paint_c"). Defines the color aesthetic for the geometry.

fillBy

default = "fill" ("fill", "color", "paint_a", "paint_b", "paint_c"). Defines the fill 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, y: Number? = null, xmin: Number? = null, xmax: Number? = null, size: Number? = null, linetype: Any? = null, color: Any? = null, fill: Any? = null, alpha: Number? = null, colorBy: String? = null, fillBy: String? = null, mapping: RibbonMapping.() -> 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
open override val fill: Any? = null
Link copied to clipboard
open override val fillBy: String? = null
Link copied to clipboard
val geom: GeomOptions
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 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