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

geomStep

class geomStep(val data: Map<*, *>? = null, val stat: StatOptions = Stat.identity, val position: PosOptions = positionIdentity, val showLegend: Boolean = true, val inheritAes: Boolean? = null, val manualKey: Any? = null, val sampling: SamplingOptions? = null, val tooltips: TooltipOptions? = null, direction: String? = null, val x: Number? = null, val y: Number? = null, val alpha: Number? = null, val color: Any? = null, val linetype: Any? = null, val size: Number? = null, val colorBy: String? = null, mapping: LineMapping.() -> Unit = {}) : Layer, LineAesthetics, WithColorOption

Connects observations in the order in which they appear in the data by stairs.

Notes

To hide axis tooltips, set "blank" or the result of elementBlank() to the axisTooltip or axisTooltipX parameter of the theme().

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.

inheritAes

default = true. false - do not combine the layer aesthetic mappings with the plot shared mappings.

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. Set tooltips = tooltipsNone to hide tooltips from the layer.

direction

"hv" or "HV" stands for horizontal then vertical (default); "vh" or "VH" stands for vertical then horizontal.

X-axis value.

Y-axis value.

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.

linetype

Type of the line. Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"), a hex string (up to 8 digits for dash-gap lengths), or a pattern offset to listOf(dash, gap, ...) / listOf(dash, gap, ...). For more info see: aesthetics.html#line-types.

size

Line width.

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

geomStep

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