geomBin2D

class geomBin2D(val data: Map<*, *>? = null, val stat: StatOptions = Stat.bin2D(), 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 x: Number? = null, val y: Number? = null, val width: Number? = null, val height: Number? = null, val alpha: Number? = null, val color: Any? = null, val fill: Any? = null, val linetype: Any? = null, val size: Number? = null, val weight: Any? = null, val bins: <Error class: unknown class><Int, Int>? = null, val binWidth: <Error class: unknown class><Number?, Number?>? = null, val drop: Boolean? = null, val colorBy: String? = null, val fillBy: String? = null, mapping: Bin2dMapping.() -> Unit = {}) : Layer, TileAesthetics, Bin2dStatAesthetics, Bin2dStatParameters, WithColorOption, WithFillOption

Divides the plane into a grid and color the bins by the count of cases in them.

By default, this geom uses coordFixed(). However, this may not be the best choice when the values on the X/Y axis have significantly different magnitudes. In such cases, try using coordCartesian().

Notes

Computed variables:

  • ..count.. : number of points with coordinates in the same bin.

To hide axis tooltips, set "blank" or the result of elementBlank() to the axisTooltip, axisTooltipX or axisTooltipY parameter of the theme().

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

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

bins

default = Pair(30, 30). Number of bins in both directions, vertical and horizontal. Overridden by binwidth.

binWidth

The width of the bins in both directions, vertical and horizontal. Overrides bins. The default is to use bin widths that cover the entire range of the data.

drop

default = true. Specifies whether to remove all bins with 0 counts.

x

X-axis value.

y

Y-axis value.

width

Width of a tile.

height

Height of a tile.

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

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

linetype

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

size

Line width, default = 0 (i.e. tiles outline initially is not visible).

weight

Used by Stat.bin2D()stat to compute weighted sum instead of simple count.

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.bin2D(), position: PosOptions = positionIdentity, showLegend: Boolean = true, inheritAes: Boolean? = null, manualKey: Any? = null, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, x: Number? = null, y: Number? = null, width: Number? = null, height: Number? = null, alpha: Number? = null, color: Any? = null, fill: Any? = null, linetype: Any? = null, size: Number? = null, weight: Any? = null, bins: <Error class: unknown class><Int, Int>? = null, binWidth: <Error class: unknown class><Number?, Number?>? = null, drop: Boolean? = null, colorBy: String? = null, fillBy: String? = null, mapping: Bin2dMapping.() -> Unit = {})

Properties

Link copied to clipboard
open override val alpha: Number? = null
Link copied to clipboard
open override val bins: <Error class: unknown class><Int, Int>? = null
Link copied to clipboard
open override val binWidth: <Error class: unknown class><Number?, 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 drop: Boolean? = 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
open override val height: Number? = null
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
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 weight: Any? = null
Link copied to clipboard
open override val width: Number? = null
Link copied to clipboard
open override val x: Number? = null
Link copied to clipboard
open override val y: Number? = null