commonMain.org.jetbrains.letsPlot.stat.stat_density2df.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lets-plot-kotlin-kernel Show documentation
Show all versions of lets-plot-kotlin-kernel Show documentation
Lets-Plot Kotlin API without dependencies.
/*
* Copyright (c) 2021. JetBrains s.r.o.
* Use of this source code is governed by the MIT license that can be found in the LICENSE file.
*/
package org.jetbrains.letsPlot.stat
import org.jetbrains.letsPlot.Stat
import org.jetbrains.letsPlot.intern.GeomKind
import org.jetbrains.letsPlot.intern.Options
import org.jetbrains.letsPlot.intern.layer.GeomOptions
import org.jetbrains.letsPlot.intern.Layer
import org.jetbrains.letsPlot.intern.layer.PosOptions
import org.jetbrains.letsPlot.intern.layer.SamplingOptions
import org.jetbrains.letsPlot.intern.layer.WithColorOption
import org.jetbrains.letsPlot.intern.layer.WithFillOption
import org.jetbrains.letsPlot.intern.layer.geom.Density2dfMapping
import org.jetbrains.letsPlot.intern.layer.geom.PolygonAesthetics
import org.jetbrains.letsPlot.intern.layer.stat.Density2dStatAesthetics
import org.jetbrains.letsPlot.intern.layer.stat.Density2dStatParameters
import org.jetbrains.letsPlot.pos.positionIdentity
@Suppress("ClassName")
/**
* Displays filled contour bands.
*
* @param 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][org.jetbrains.letsPlot.letsPlot].
* @param geom The geometry to display the density stat for this layer, default is filled 2D density,
* see [Geom][org.jetbrains.letsPlot.Geom].
* @param position Position adjustment: `positionIdentity`, `positionStack()`, `positionDodge()`, etc.
* see [Position](https://lets-plot.org/kotlin/-lets--plot--kotlin/org.jetbrains.letsPlot.pos/).
* @param showLegend default = true.
* false - do not show legend for this layer.
* @param sampling Result of the call to the `samplingXxx()` function.
* To prevent any sampling for this layer pass value `samplingNone`.
* For more info see [sampling.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/sampling.md).
* @param x X-axis coordinates of the center of rectangles, forming a tessellation.
* @param y Y-axis coordinates of the center of rectangles, forming a tessellation.
* @param size Lines width.
* @param linetype The type of the line.
* Codes and names: 0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash",
* 5 = "longdash", 6 = "twodash".
* @param color Color of geometry.
* String in the following formats:
* - RGB/RGBA (e.g. "rgb(0, 0, 255)")
* - HEX (e.g. "#0000FF")
* - color name (e.g. "red")
* - role name ("pen", "paper" or "brush")
*
* Or an instance of the `java.awt.Color` class.
* @param fill Color of a geometry bands.
* String in the following formats:
* - RGB/RGBA (e.g. "rgb(0, 0, 255)")
* - HEX (e.g. "#0000FF")
* - color name (e.g. "red")
* - role name ("pen", "paper" or "brush")
*
* Or an instance of the `java.awt.Color` class.
* @param alpha Transparency level of a layer.
* Understands numbers between 0 and 1.
* @param weight Used by the stat to compute weighted density.
* @param bw The method (or exact value) of bandwidth. Either a String (choose among "nrd0" and "nrd"),
* or a Double array of length 2.
* @param kernel The kernel used to calculate the density function. Choose among "gaussian", "cosine", "optcosine",
* "rectangular" (or "uniform"), "triangular", "biweight" (or "quartic"), "epanechikov" (or "parabolic").
* @param n The number of sampled points for plotting the function (on x and y direction correspondingly).
* @param adjust Adjusts the value of bandwidth by multiplying it. Changes how smooth the frequency curve is.
* @param contour If true, contour the results of the 2d density estimation.
* @param bins Number of levels.
* @param binWidth Distance between levels.
* @param colorBy default = "color" ("fill", "color", "paint_a", "paint_b", "paint_c").
* Defines the color aesthetic for the geometry.
* @param fillBy default = "fill" ("fill", "color", "paint_a", "paint_b", "paint_c").
* Defines the fill aesthetic for the geometry.
* @param mapping Set of aesthetic mappings.
* Aesthetic mappings describe the way that variables in the data are
* mapped to plot "aesthetics".
*/
class statDensity2DFilled(
data: Map<*, *>? = null,
geom: GeomOptions = GeomOptions(GeomKind.DENSITY2DF),
position: PosOptions = positionIdentity,
showLegend: Boolean = true,
sampling: SamplingOptions? = null,
override val x: Number? = null,
override val y: Number? = null,
override val size: Number? = null,
override val linetype: Any? = null,
override val color: Any? = null,
override val fill: Any? = null,
override val alpha: Number? = null,
override val weight: Number? = null,
override val bw: Any? = null,
override val kernel: String? = null,
override val n: Int? = null,
override val adjust: Number? = null,
override val contour: Boolean? = null,
override val bins: Int? = null,
override val binWidth: Number? = null,
override val colorBy: String? = null,
override val fillBy: String? = null,
mapping: Density2dfMapping.() -> Unit = {}
) : PolygonAesthetics,
Density2dStatAesthetics,
Density2dStatParameters,
WithColorOption,
WithFillOption,
Layer(
mapping = Density2dfMapping().apply(mapping).seal(),
data = data,
geom = geom,
stat = Stat.density2DFilled(),
position = position,
showLegend = showLegend,
sampling = sampling
) {
override fun seal(): Options {
return super.seal() +
super.seal() +
super.seal() +
super.seal() +
super.seal()
}
}