commonMain.org.jetbrains.letsPlot.geom.geom_text.kt Maven / Gradle / Ivy
The newest version!
/*
* 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.text
import org.jetbrains.letsPlot.Stat
import org.jetbrains.letsPlot.intern.Layer
import org.jetbrains.letsPlot.intern.Options
import org.jetbrains.letsPlot.intern.layer.*
import org.jetbrains.letsPlot.intern.layer.geom.TextAesthetics
import org.jetbrains.letsPlot.intern.layer.geom.TextMapping
import org.jetbrains.letsPlot.intern.layer.geom.TextParameters
import org.jetbrains.letsPlot.pos.positionIdentity
import org.jetbrains.letsPlot.spatial.SpatialDataset
import org.jetbrains.letsPlot.tooltips.TooltipOptions
@Suppress("ClassName")
/**
* Adds a text directly to the plot.
*
* ## Examples
*
* - [label_format.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/label_format.ipynb)
*
* - [formatting_axes_etc.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/formatting_axes_etc.ipynb)
*
* - [geotools_naturalearth.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/demo/geotools_naturalearth.ipynb)
*
* @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 = true.
* 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.
* Set `tooltips = tooltipsNone` to hide tooltips from the layer.
* @param map Data-structure containing series of planar shapes and, optionally,
* associated 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 label Text to add to plot.
* @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 size Font size.
* @param family default = "sans".
* For more info see: [aesthetics.html#font-family](https://lets-plot.org/kotlin/aesthetics.html#font-family).
* @param fontface default = "plain".
* For more info see: [aesthetics.html#font-face](https://lets-plot.org/kotlin/aesthetics.html#font-face).
* @param hjust ("left", "middle", "right") or number between 0 ("left") and 1 ("right")
* or "inward" (aligns text towards the plot center), "outward" (away from the plot center).
* Horizontal text alignment.
* @param vjust ("bottom", "center", "top") or number between 0 ("bottom") and 1 ("top")
* or "inward" (aligns text towards the plot center), "outward" (away from the plot center).
* Vertical text alignment.
* @param angle Text rotation angle in degrees.
* @param lineheight Line height multiplier applied to the font size in the case of multi-line text.
* @param labelFormat Specifies the format pattern for displaying mapped values.
* @param naText default = "n/a".
* Text to show for missing values.
* @param nudgeX Horizontal adjustment to nudge labels by.
* @param nudgeY Vertical adjustment to nudge labels by.
* @param sizeUnit Relates the size of the text 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 checkOverlap Skips plotting text that overlaps previous text in the same layer.
* @param mapping Set of aesthetic mappings.
* Aesthetic mappings describe the way that variables in the data are
* mapped to plot "aesthetics".
*
*
* Format patterns in the `labelFormat` parameter can be just a number format (like "d") or
* a string template where number format is surrounded by curly braces: "{d} cylinders".
* For more info see: [formats.html](https://lets-plot.org/kotlin/formats.html)
* Note: the "$" must be escaped as "\$".
*
* Examples:
* - ".2f" -> "12.45"
* - "Score: {.2f}" -> "Score: 12.45"
* - "Score: {}" -> "Score: 12.454789"
*
*/
class geomText(
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,
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 label: String? = null,
override val alpha: Number? = null,
override val color: Any? = null,
override val size: Number? = null,
override val family: String? = null,
override val fontface: String? = null,
override val hjust: Any? = null,
override val vjust: Any? = null,
override val angle: Number? = null,
override val lineheight: Number? = null,
override val labelFormat: String? = null,
override val naText: String? = null,
override val nudgeX: Number? = null,
override val nudgeY: Number? = null,
override val sizeUnit: String? = null,
override val colorBy: String? = null,
override val checkOverlap: Boolean? = null,
mapping: TextMapping.() -> Unit = {}
) : TextAesthetics,
TextParameters,
WithSizeUnitOption,
WithSpatialParameters,
WithColorOption,
Layer(
mapping = TextMapping().apply(mapping).seal(),
data = data,
geom = text(),
stat = stat,
position = position,
showLegend = showLegend,
inheritAes = inheritAes,
manualKey = manualKey,
sampling = sampling,
tooltips = tooltips
) {
override fun seal(): Options {
return super.seal() +
super.seal() +
super.seal() +
super.seal()
}
}