geomBlank

class geomBlank(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 orientation: String? = null, val map: SpatialDataset? = null, val mapJoin: <Error class: unknown class><Any, Any>? = null, val useCRS: String? = null, val x: Number? = null, val y: Number? = null, val alpha: Number? = null, val color: Any? = null, val fill: Any? = null, val shape: Any? = null, val size: Number? = null, val stroke: Number? = null, val angle: Number? = null, val sizeUnit: String? = null, val colorBy: String? = null, val fillBy: String? = null, mapping: PointMapping.() -> Unit = {}) : Layer, PointAesthetics, WithSizeUnitOption, WithSpatialParameters, WithColorOption, WithFillOption

Draws nothing, but can be a useful way of ensuring common scales between different plots (see expandLimits()). Also, can help to avoid the "No layers in plot" error when building plots using automated tools.

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 = false. 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.

orientation

Specifies the axis that the layer's stat and geom should run along, default = "x". Possible values: "x", "y".

map

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

Supported shapes: Point and MultiPoint. 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).

x

X-axis value.

y

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.

fill

Color to paint shape's inner points. Is applied only to the points of shapes having inner points. For more info see: aesthetics.html#color-and-fill.

shape

Shape of the point. For more info see: aesthetics.html#point-shapes.

size

Size of the point.

stroke

Width of the shape border. Applied only to the shapes having border.

angle

Rotation angle of the shape, in degrees.

sizeUnit

Relates the size of the point to the length of the unit step along one of the axes. Possible values: "x", "y". If not specified, no fitting is performed.

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, orientation: String? = null, map: SpatialDataset? = null, mapJoin: <Error class: unknown class><Any, Any>? = null, useCRS: String? = null, x: Number? = null, y: Number? = null, alpha: Number? = null, color: Any? = null, fill: Any? = null, shape: Any? = null, size: Number? = null, stroke: Number? = null, angle: Number? = null, sizeUnit: String? = null, colorBy: String? = null, fillBy: String? = null, mapping: PointMapping.() -> Unit = {})

Properties

Link copied to clipboard
open override val alpha: Number? = null
Link copied to clipboard
open override val angle: 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
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
open override val shape: Any? = null
Link copied to clipboard
Link copied to clipboard
open override val size: Number? = null
Link copied to clipboard
open override val sizeUnit: String? = null
Link copied to clipboard
val stat: StatOptions
Link copied to clipboard
open override val stroke: Number? = null
Link copied to clipboard
Link copied to clipboard
open override val useCRS: String? = null
Link copied to clipboard
open override val x: Number? = null
Link copied to clipboard
open override val y: Number? = null