geomPointDensity

constructor(data: Map<*, *>? = null, stat: StatOptions = Stat.pointDensity(), position: PosOptions = positionIdentity, showLegend: Boolean = true, inheritAes: Boolean? = null, manualKey: Any? = null, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, method: String? = null, kernel: String? = null, adjust: Number? = null, bw: Any? = null, n: Int? = null, map: SpatialDataset? = null, mapJoin: Pair<Any, Any>? = null, useCRS: String? = null, x: Number? = null, y: Number? = null, alpha: Number? = null, color: Any? = null, fill: Any? = null, shape: Any? = null, angle: Number? = null, size: Number? = null, stroke: Number? = null, weight: Any? = null, colorBy: String? = null, fillBy: String? = null, mapping: PointDensityMapping.() -> Unit = {})

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.pointDensity(). 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.

x

X-axis coordinates.

alpha

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

color

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

size

Line width.

fill

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

weight

Used by "density" stat to compute weighted density.

method

default = "auto" ("auto", "neighbours", "kde2d"). Method to compute the density estimate:

  • "neighbours" - estimates density from the number of nearby points.

  • "kde2d" - estimates density using a smoothed 2D kernel density.

  • "auto" - automatically selects an estimation method based on data size.

kernel

The kernel used for KDE. One of "gaussian", "cosine", "optcosine", "rectangular"/"uniform", "triangular", "biweight"/"quartic", "epanechikov"/"parabolic". Only used when method = "kde2d".

bw

The method (or exact value) of bandwidth. Either a String (choose among "nrd0" and "nrd"), or a Double array of length 2. Only used when method = "kde2d".

adjust

For "neighbours", adjusts the radius in which to count neighbours. For "kde2d", adjust the value of bandwidth by multiplying it.

n

Number of sampled points for plotting the function (on x and y, respectively). Only used when method = "kde2d".

map

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

Supported shapes: Polygon and MultiPolygon. 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).

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