geomRect

class geomRect(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, val map: SpatialDataset? = null, val mapJoin: <Error class: unknown class><Any, Any>? = null, val useCRS: String? = 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 linetype: Any? = null, val size: Number? = null, val fill: Any? = null, val colorBy: String? = null, val fillBy: String? = null, mapping: RectMapping.() -> Unit = {}) : Layer, RectAesthetics, WithSpatialParameters, WithColorOption, WithFillOption

Displays a rectangle defined by the four corners (xmin, xmax, ymin and ymax).

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.

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.

map

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

geomRect will draw rectangles using bounding boxes of shapes. All coordinates should be encoded as decimal degrees in WGS84 coordinate reference system.

Can be used with parameter mapJoin for joining data and map coordinates.

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.

useCRS

By default, all coordinates are converted into degrees of longitude and latitude, and these map coordinates are projected onto the screen coordinates using Mercator projection. Specify useCRS = "provided" to keep the SpatialDataset's original coordinate reference system (CRS).

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

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

size

Lines width.

linetype

Type of the line of border. 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.

fill

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

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, inheritAes: Boolean? = null, manualKey: Any? = null, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, map: SpatialDataset? = null, mapJoin: <Error class: unknown class><Any, Any>? = null, useCRS: String? = null, xmin: Number? = null, xmax: Number? = null, ymin: Number? = null, ymax: Number? = null, alpha: Number? = null, color: Any? = null, linetype: Any? = null, size: Number? = null, fill: Any? = null, colorBy: String? = null, fillBy: String? = null, mapping: RectMapping.() -> 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
Link copied to clipboard
open override val linetype: Any? = null
Link copied to clipboard
val manualKey: Any? = null
Link copied to clipboard
open override val map: SpatialDataset? = null
Link copied to clipboard
open override val mapJoin: <Error class: unknown class><Any, 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 useCRS: String? = 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 ymax: Number? = null
Link copied to clipboard
open override val ymin: Number? = null