plot-api / jetbrains.letsPlot.geom / geom_text

geom_text

class geom_text : TextAesthetics, LayerBase

Add a text directly to the plot.

Parameters

data - dictionary or pandas DataFrame, optional. The data to be displayed in this layer. If None, the default, the data is inherited from the plot data as specified in the call to lets_plot.

stat - string, optional. The statistical transformation to use on the data for this layer, as a string. Supported transformations: "identity" (leaves the data unchanged), "count" (counts number of points with same x-axis coordinate), "bin" (counts number of points with x-axis coordinate in the same bin), "smooth" (performs smoothing - linear default)

position - string, optional. Position adjustment, either as a string ("identity", "stack", "dodge", ...), or the result of a call to a position adjustment function.

x - x-axis value.

y - y-axis value.

label - text to add to plot.

alpha - transparency level of a point Understands numbers between 0 and 1.

color - (colour) color of a geometry. Can be continuous or discrete. For continuous value this will be a color gradient between two colors.

size - font size.

family - ('sans' | 'serif' | 'mono' | any other like: "Times New Roman") Font family. The default is 'sans'

fontface - ('plain' | 'bold' | 'italic' | 'bold italic') Font style and weight. The default is 'plain'

hjust - ('left', 'middle', 'right') or number between 0 ('right') and 1 ('left'). Horizontal text alignment.

vjust - ('bottom', 'center', 'top') or number between 0 ('bottom') and 1 ('top'). Vertical text alignment.

angle - text rotation angle in degrees.

mapping - set of aesthetic mappings. Aesthetic mappings describe the way that variables in the data are mapped to plot "aesthetics".

Constructors

<init>

Add a text directly to the plot.

geom_text(data: Map<*, *>? = null, stat: StatOptions = Stat.identity, position: PosOptions = identity, showLegend: Boolean = true, sampling: SamplingOptions? = null, x: Double? = null, y: Double? = 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: Double? = null, mapping: TextMapping.() -> Unit = {})

Properties

alpha

transparency level of a point Understands numbers between 0 and 1.

val alpha: Number?

angle

text rotation angle in degrees.

val angle: Double?

color

(colour) color of a geometry. Can be continuous or discrete. For continuous value this will be a color gradient between two colors.

val color: Any?

family

('sans' | 'serif' | 'mono' | any other like: "Times New Roman") Font family. The default is 'sans'

val family: String?

fontface

('plain' | 'bold' | 'italic' | 'bold italic') Font style and weight. The default is 'plain'

val fontface: String?

hjust

('left', 'middle', 'right') or number between 0 ('right') and 1 ('left'). Horizontal text alignment.

val hjust: Any?

label

text to add to plot.

val label: String?

size

font size.

val size: Number?

vjust

('bottom', 'center', 'top') or number between 0 ('bottom') and 1 ('top'). Vertical text alignment.

val vjust: Any?

x

x-axis value.

val x: Double?

y

y-axis value.

val y: Double?

Extension Functions

toSpec

fun Layer.toSpec(): MutableMap<String, Any>