commonMain.org.jetbrains.letsPlot.geom.geom_blank.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.geom
import org.jetbrains.letsPlot.Geom.blank
import org.jetbrains.letsPlot.Geom.point
import org.jetbrains.letsPlot.Stat
import org.jetbrains.letsPlot.intern.Layer
import org.jetbrains.letsPlot.intern.layer.*
import org.jetbrains.letsPlot.intern.layer.geom.PointAesthetics
import org.jetbrains.letsPlot.intern.layer.geom.PointMapping
import org.jetbrains.letsPlot.pos.positionIdentity
import org.jetbrains.letsPlot.spatial.SpatialDataset
import org.jetbrains.letsPlot.tooltips.TooltipOptions
@Suppress("ClassName")
/**
* 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.
*
* @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 stat The statistical transformation to use on the data for this layer.
* Supported transformations: `Stat.identity`, `Stat.bin()`, `Stat.count()`, etc. see [Stat][org.jetbrains.letsPlot.Stat].
* @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 inheritAes default = false.
* false - do not combine the layer aesthetic mappings with the plot shared mappings.
* @param 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.
* @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.html](https://lets-plot.org/kotlin/sampling.html).
* @param tooltips Result of the call to the `layerTooltips()` function.
* Specifies appearance, style and content.
* @param orientation Specifies the axis that the layer's stat and geom should run along, default = "x".
* Possible values: "x", "y".
* @param 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.
* @param 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.
* @param 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).
* @param x X-axis value.
* @param y Y-axis value.
* @param alpha Transparency level of a layer. Understands numbers between 0 and 1.
* @param color Color of the geometry.
* For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
* @param 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](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
* @param shape Shape of the point.
* For more info see: [aesthetics.html#point-shapes](https://lets-plot.org/kotlin/aesthetics.html#point-shapes).
* @param size Size of the point.
* @param stroke Width of the shape border. Applied only to the shapes having border.
* @param angle Rotation angle of the shape, in degrees.
* @param 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.
* @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 geomBlank(
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,
override val map: SpatialDataset? = null,
override val mapJoin: Pair? = null,
override val useCRS: String? = null,
override val x: Number? = null,
override val y: Number? = null,
override val alpha: Number? = null,
override val color: Any? = null,
override val fill: Any? = null,
override val shape: Any? = null,
override val size: Number? = null,
override val stroke: Number? = null,
override val angle: Number? = null,
override val sizeUnit: String? = null,
override val colorBy: String? = null,
override val fillBy: String? = null,
mapping: PointMapping.() -> Unit = {}
) : PointAesthetics,
WithSizeUnitOption,
WithSpatialParameters,
WithColorOption,
WithFillOption,
Layer(
mapping = PointMapping().apply(mapping).seal(),
data = data,
geom = blank,
stat = stat,
position = position,
showLegend = showLegend,
inheritAes = inheritAes ?: false,
manualKey = manualKey,
sampling = sampling,
tooltips = tooltips,
orientation = orientation
) {
override fun seal() = super.seal() +
super.seal() +
super.seal() +
super.seal()
}