label

class label(val x: Number? = null, val y: Number? = null, val label: String? = null, val alpha: Number? = null, val color: Any? = null, val fill: 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 nudgeUnit: String? = null, val labelPadding: Number? = null, val labelR: Number? = null, val labelSize: Number? = null, val alphaStroke: Boolean? = null, val sizeUnit: String? = null, val colorBy: String? = null, val fillBy: String? = null, val checkOverlap: Boolean? = null, val mapping: LabelMapping.() -> Unit = {}) : GeomOptions, LabelAesthetics, LabelParameters, WithSizeUnitOption, WithColorOption, WithFillOption

Constructors

Link copied to clipboard
constructor(x: Number? = null, y: Number? = null, label: String? = null, alpha: Number? = null, color: Any? = null, fill: 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, nudgeUnit: String? = null, labelPadding: Number? = null, labelR: Number? = null, labelSize: Number? = null, alphaStroke: Boolean? = null, sizeUnit: String? = null, colorBy: String? = null, fillBy: String? = null, checkOverlap: Boolean? = null, mapping: LabelMapping.() -> Unit = {})

Properties

Link copied to clipboard
open override val alpha: Number? = null

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

Link copied to clipboard
open override val alphaStroke: Boolean? = null

Enables the applying of 'alpha' to 'color' (label text and border).

Link copied to clipboard
open override val angle: Number? = null

Label rotation angle in degrees.

Link copied to clipboard
open override val checkOverlap: Boolean? = null

Skips plotting text that overlaps previous text in the same layer.

Link copied to clipboard
open override val color: Any? = null

Color of the geometry. For more info see: aesthetics.html#color-and-fill.

Link copied to clipboard
open override val colorBy: String? = null

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

Link copied to clipboard
open override val family: String? = null

default = "sans". For more info see: aesthetics.html#font-family.

Link copied to clipboard
open override val fill: Any? = null

Background color of the label. For more info see: aesthetics.html#color-and-fill.

Link copied to clipboard
open override val fillBy: String? = null

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

Link copied to clipboard
open override val fontface: String? = null

default = "plain". For more info see: aesthetics.html#font-face.

Link copied to clipboard
open override val hjust: Any? = null

horizontal text alignment relative to the x-coordinate. Possible values: 0 or "left" - left-aligned (text starts at x), 0.5 or "middle" (default) - text is centered on x, 1 or "right" - right-aligned (text ends at x). There are two special alignments: "inward" (aligns text towards the plot center) and "outward" (away from the plot center).

Link copied to clipboard
val kind: GeomKind
Link copied to clipboard
open override val label: String? = null

Text to add to plot.

Link copied to clipboard
open override val labelFormat: String? = null

Specifies the format pattern for displaying mapped values.

Link copied to clipboard
open override val labelPadding: Number? = null

Amount of padding around label. Defaults to 0.25 of font size.

Link copied to clipboard
open override val labelR: Number? = null

Radius of rounded corners. Defaults to 0.15 of label height.

Link copied to clipboard
open override val labelSize: Number? = null

Size of label border.

Link copied to clipboard
open override val lineheight: Number? = null

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

Link copied to clipboard
val mapping: Options
Link copied to clipboard
open override val naText: String? = null

Text to show for missing values.

Link copied to clipboard
open override val nudgeUnit: String? = null

Units for x and y nudging. Possible values:

Link copied to clipboard
open override val nudgeX: Number? = null

Horizontal adjustment to nudge labels by.

Link copied to clipboard
open override val nudgeY: Number? = null

Vertical adjustment to nudge labels by.

Link copied to clipboard
open override val parameters: Options
Link copied to clipboard
open override val size: Number? = null

Font size.

Link copied to clipboard
open override val sizeUnit: String? = null

Relate the size to the length of the unit step along one of the axes. "x" uses the unit step along the x-axis, "y" uses the unit step along the y-axis. "min" uses the smaller of the unit steps along the x- and y-axes. "max" uses the larger of the unit steps along the x- and y-axes. If not specified, no fitting is performed.

Link copied to clipboard
open override val vjust: Any? = null

vertical text alignment relative to the y-coordinate. Possible values: 0 or "bottom" - bottom-aligned (bottom of text at y), 0.5 or "center" (default) - middle of text at y, 1 or "top" - top-aligned (top of text at y). There are two special alignments: "inward" (aligns text towards the plot center) and "outward" (away from the plot center).

Link copied to clipboard
open override val x: Number? = null

X-axis value.

Link copied to clipboard
open override val y: Number? = null

Y-axis value.