BracketMapping

class BracketMapping(var xmin: Any? = null, var xmax: Any? = null, var y: Any? = null, var ymin: Any? = null, var ymax: Any? = null, var x: Any? = null, var lenstart: Any? = null, var lenend: Any? = null, var label: Any? = null, var size: Any? = null, var linetype: Any? = null, var color: Any? = null, var alpha: Any? = null, var family: Any? = null, var fontface: Any? = null, var hjust: Any? = null, var vjust: Any? = null, var angle: Any? = null, var lineheight: Any? = null, var segmentColor: Any? = null, var segmentSize: Any? = null, var segmentAlpha: Any? = null, var group: Any? = null, var paint_a: Any? = null, var paint_b: Any? = null, var paint_c: Any? = null) : BracketAesthetics, WithGroupOption, PaintAesthetics

Aesthetic mappings supported by geomBracket().

Parameters

xmin

Left end of the bracket for horizontal brackets.

xmax

Right end of the bracket for horizontal brackets.

y

Y-axis coordinate for horizontal brackets.

ymin

Lower end of the bracket for vertical brackets.

ymax

Upper end of the bracket for vertical brackets.

x

X-axis coordinate for vertical brackets.

lenstart

Length of the tip at the bracket start (at xmin for horizontal brackets, or ymin for vertical brackets).

lenend

Length of the tip at the bracket end (at xmax for horizontal brackets, or ymax for vertical brackets).

label

Text to add.

size

Font size.

linetype

Type of the bracket line. Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"), a hex string (up to 8 digits for dash-gap lengths), or a pattern offset to listOf(dash, gap, ...) / listOf(dash, gap, ...). For more info see: aesthetics.html#line-types.

color

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

alpha

Transparency level of a layer. Accept values between 0 and 1.

family

Font family. For more info see: aesthetics.html#text.

fontface

Font style and weight. For more info see: aesthetics.html#text.

hjust

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

vjust

Vertical text alignment relative to the y-coordinate. Accept either a numeric value or one of: "bottom", "center", or "top". The numeric values 0, 0.5 (default), and 1 correspond to "bottom", "center", and "top", respectively. There are two special alignments: "inward" (aligns text towards the plot center) and "outward" (away from the plot center).

angle

Text rotation angle in degrees.

lineheight

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

segmentColor

Color of the bracket line (the segments forming the bracket). For more info see: aesthetics.html#color-and-fill.

segmentSize

Width of the bracket line (the segments forming the bracket).

segmentAlpha

Transparency level of the bracket line. Accept values between 0 and 1.

group

Grouping key. If not set, grouping may be inferred from other aesthetics (e.g., color, size).

paint_a

Auxiliary paint channel A that can be used as either color or fill as needed. Map a variable here for composite/multi-channel color with a matching scale.

paint_b

Auxiliary paint channel B. See paint_a.

paint_c

Auxiliary paint channel C. See paint_a.

Constructors

Link copied to clipboard
constructor(xmin: Any? = null, xmax: Any? = null, y: Any? = null, ymin: Any? = null, ymax: Any? = null, x: Any? = null, lenstart: Any? = null, lenend: Any? = null, label: Any? = null, size: Any? = null, linetype: Any? = null, color: Any? = null, alpha: Any? = null, family: Any? = null, fontface: Any? = null, hjust: Any? = null, vjust: Any? = null, angle: Any? = null, lineheight: Any? = null, segmentColor: Any? = null, segmentSize: Any? = null, segmentAlpha: Any? = null, group: Any? = null, paint_a: Any? = null, paint_b: Any? = null, paint_c: Any? = null)

Properties

Link copied to clipboard
open override var alpha: Any?
Link copied to clipboard
open override var angle: Any?
Link copied to clipboard
open override var color: Any?
Link copied to clipboard
open override var family: Any?
Link copied to clipboard
open override var fontface: Any?
Link copied to clipboard
open override var group: Any?
Link copied to clipboard
open override var hjust: Any?
Link copied to clipboard
open override var label: Any?
Link copied to clipboard
open override var lenend: Any?
Link copied to clipboard
open override var lenstart: Any?
Link copied to clipboard
open override var lineheight: Any?
Link copied to clipboard
open override var linetype: Any?
Link copied to clipboard
open override var paint_a: Any?
Link copied to clipboard
open override var paint_b: Any?
Link copied to clipboard
open override var paint_c: Any?
Link copied to clipboard
open override var segmentAlpha: Any?
Link copied to clipboard
open override var segmentColor: Any?
Link copied to clipboard
open override var segmentSize: Any?
Link copied to clipboard
open override var size: Any?
Link copied to clipboard
open override var vjust: Any?
Link copied to clipboard
open override var x: Any?
Link copied to clipboard
open override var xmax: Any?
Link copied to clipboard
open override var xmin: Any?
Link copied to clipboard
open override var y: Any?
Link copied to clipboard
open override var ymax: Any?
Link copied to clipboard
open override var ymin: Any?

Functions

Link copied to clipboard
open fun groupOption(): Options