plot-api / jetbrains.letsPlot.geom / geom_rect

geom_rect

class geom_rect : RectAesthetics, WithSpatialParameters, LayerBase

Display a rectangle defined by the four corners (xmin, xmax, 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.

map - SpatialDataset. Data-structure containing series of planar shapes and, optionally, associates data series (for example: names of States and their boundaries).

mapJoin - pair of names or pair of lists of names Specifies column names to join the 'data' and the 'map' coordinates on. Pair.first: column name or list of column names in the 'data' dataframe. Pair.second: column name or list of column names in the 'map' dataframe.

xmin - x-axis value.

xmax - x-axis value.

ymin - y-axis value.

ymax - y-axis value.

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 rectangle defined by the four corners (xmin, xmax, ymin and ymax).

geom_rect(data: Map<*, *>? = null, stat: StatOptions = Stat.identity, position: PosOptions = identity, showLegend: Boolean = true, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, map: SpatialDataset? = null, mapJoin: Pair<Any, Any>? = null, xmin: Double? = null, xmax: Double? = null, ymin: Double? = null, ymax: Double? = null, alpha: Number? = null, color: Any? = null, linetype: Any? = null, size: Number? = null, fill: Any? = null, mapping: RectMapping.() -> 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?

map

SpatialDataset. Data-structure containing series of planar shapes and, optionally, associates data series (for example: names of States and their boundaries).

val map: SpatialDataset?

mapJoin

pair of names or pair of lists of names Specifies column names to join the 'data' and the 'map' coordinates on. Pair.first: column name or list of column names in the 'data' dataframe. Pair.second: column name or list of column names in the 'map' dataframe.

val mapJoin: Pair<Any, Any>?

size

lines width.

val size: Number?

xmax

x-axis value.

val xmax: Double?

xmin

x-axis value.

val xmin: Double?

ymax

y-axis value.

val ymax: Double?

ymin

y-axis value.

val ymin: Double?

Extension Functions

toSpec

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