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

geomBand

class geomBand(val data: Map<*, *>? = null, val stat: StatOptions = Stat.identity, val position: PosOptions = positionIdentity, val showLegend: Boolean = true, val manualKey: Any? = null, val sampling: SamplingOptions? = null, val tooltips: TooltipOptions? = null, val xmin: Number? = null, val xmax: Number? = null, val ymin: Number? = null, val ymax: Number? = null, val alpha: Number? = null, val color: Any? = null, val fill: Any? = null, val size: Number? = null, val linetype: Any? = null, val colorBy: String? = null, val fillBy: String? = null, mapping: BandMapping.() -> Unit = {}) : Layer, BandAesthetics, WithColorOption, WithFillOption

Add a straight vertical or horizontal band to the plot.

Examples

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

default = Stat.count(). 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.

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.

xmin

Lower bound for the vertical band.

xmax

Upper bound for the vertical band.

ymin

Lower bound for the horizontal band.

ymax

Upper bound for the horizontal band.

alpha

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

color

Color of the band border. For more info see: aesthetics.html#color-and-fill.

fill

Fill color. For more info see: aesthetics.html#color-and-fill.

size

Defines band border width.

linetype

Type of the line. Codes and names: 0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash". For more info see: aesthetics.html#line-types.

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

geomBand

constructor(data: Map<*, *>? = null, stat: StatOptions = Stat.identity, position: PosOptions = positionIdentity, showLegend: Boolean = true, manualKey: Any? = null, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, xmin: Number? = null, xmax: Number? = null, ymin: Number? = null, ymax: Number? = null, alpha: Number? = null, color: Any? = null, fill: Any? = null, size: Number? = null, linetype: Any? = null, colorBy: String? = null, fillBy: String? = null, mapping: BandMapping.() -> Unit = {})