geomText

class geomText(val data: Map<*, *>? = null, val stat: StatOptions = Stat.identity, val position: PosOptions = positionIdentity, val showLegend: Boolean = true, val sampling: SamplingOptions? = null, val tooltips: TooltipOptions? = null, val map: SpatialDataset? = null, val mapJoin: <Error class: unknown class><Any, Any>? = null, val useCRS: String? = null, val x: Number? = null, val y: Number? = null, val label: String? = null, val alpha: Number? = null, val color: Any? = null, val size: Number? = null, val family: String? = null, val fontface: String? = null, val hjust: Any? = null, val vjust: Any? = null, val angle: Number? = null, val lineheight: Number? = null, val labelFormat: String? = null, val naText: String? = null, val nudgeX: Number? = null, val nudgeY: Number? = null, val sizeUnit: String? = null, val colorBy: String? = null, mapping: TextMapping.() -> Unit = {}) : Layer, TextAesthetics, TextParameters, WithSizeUnitOption, WithSpatialParameters, WithColorOption

Adds a text directly to the plot.

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

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.

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.

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.

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

x

X-axis value.

y

Y-axis value.

label

Text to add to plot.

alpha

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

color

Color of the 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.

size

Font size.

family

default = "sans" ("sans", "serif", "mono" or any other like "Times New Roman"). Font family.

fontface

default = "plain" ("plain", "bold", "italic", "bold italic"). Font style and weight.

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.

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.

angle

Text rotation angle in degrees.

lineheight

Line height multiplier applied to the font size in the case of multi-line text.

labelFormat

Specifies the format pattern for displaying mapped values.

naText

default = "n/a". Text to show for missing values.

nudgeX

Horizontal adjustment to nudge labels by.

nudgeY

Vertical adjustment to nudge labels by.

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.

colorBy

default = "color" ("fill", "color", "paint_a", "paint_b", "paint_c"). Defines the color aesthetic for the geometry.

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 Note: the "$" must be escaped as "\$".

Examples:

  • ".2f" -> "12.45"

  • "Score: {.2f}" -> "Score: 12.45"

  • "Score: {}" -> "Score: 12.454789"

Constructors

Link copied to clipboard
constructor(data: Map<*, *>? = null, stat: StatOptions = Stat.identity, position: PosOptions = positionIdentity, showLegend: Boolean = true, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, map: SpatialDataset? = null, mapJoin: <Error class: unknown class><Any, Any>? = null, useCRS: String? = null, x: Number? = null, y: Number? = null, label: String? = null, alpha: Number? = null, color: Any? = null, size: Number? = null, family: String? = null, fontface: String? = null, hjust: Any? = null, vjust: Any? = null, angle: Number? = null, lineheight: Number? = null, labelFormat: String? = null, naText: String? = null, nudgeX: Number? = null, nudgeY: Number? = null, sizeUnit: String? = null, colorBy: String? = null, mapping: TextMapping.() -> Unit = {})

Properties

Link copied to clipboard
open override val alpha: Number? = null
Link copied to clipboard
open override val angle: 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 family: String? = null
Link copied to clipboard
open override val fontface: String? = null
Link copied to clipboard
val geom: GeomOptions
Link copied to clipboard
open override val hjust: Any? = null
Link copied to clipboard
open override val label: String? = null
Link copied to clipboard
open override val labelFormat: String? = null
Link copied to clipboard
Link copied to clipboard
open override val lineheight: Number? = null
Link copied to clipboard
open override val map: SpatialDataset? = null
Link copied to clipboard
open override val mapJoin: <Error class: unknown class><Any, Any>? = null
Link copied to clipboard
val mapping: <Error class: unknown class>
Link copied to clipboard
open override val naText: String? = null
Link copied to clipboard
open override val nudgeX: Number? = null
Link copied to clipboard
open override val nudgeY: Number? = null
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
open override val sizeUnit: String? = null
Link copied to clipboard
val stat: StatOptions
Link copied to clipboard
Link copied to clipboard
open override val useCRS: String? = null
Link copied to clipboard
open override val vjust: Any? = null
Link copied to clipboard
open override val x: Number? = null
Link copied to clipboard
open override val y: Number? = null