geomSegment

class geomSegment(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, arrow: Map<String, Any>? = null, spacer: Number? = null, flat: Boolean? = null, val x: Number? = null, val y: Number? = null, val xend: Number? = null, val yend: Number? = null, val alpha: Number? = null, val color: Any? = null, val linetype: Any? = null, val size: Number? = null, val sizeStart: Number? = null, val sizeEnd: Number? = null, val strokeStart: Number? = null, val strokeEnd: Number? = null, val colorBy: String? = null, mapping: SegmentMapping.() -> Unit = {}) : Layer, SegmentAesthetics, WithColorOption

Draws a straight line segment between points (x, y) and (xend, yend).

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

tooltips

Result of the call to the layerTooltips() function. Specifies appearance, style and content.

arrow

Specification for arrow head, as created by arrow() function.

spacer

default = 0.0. Space to shorten a segment by moving the start/end.

flat

default = false. true - keeps a line straight (corresponding to a loxodrome in case of Mercator projection). false - allows a line to be reprojected, so it can become a curve.

x

X-axis value.

y

Y-axis value.

xend

X-axis value.

yend

Y-axis value.

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.

linetype

Type of the line. Codes and names: 0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash".

size

Line width.

sizeStart

Offset from the segment start coordinate. Usually equal to the size of the point object from which the segment starts to avoid overlapping with it.

sizeEnd

Offset from the segment end coordinate. Usually equal to the size of the point object from which the segment ends to avoid overlapping with it.

strokeStart

Offset from the segment start coordinate. Usually equal to the stroke of the point object from which the segment starts to avoid overlapping with it.

strokeEnd

Offset from the segment end coordinate. Usually equal to the stroke of the point object from which the segment ends to avoid overlapping with it.

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

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, arrow: Map<String, Any>? = null, spacer: Number? = null, flat: Boolean? = null, x: Number? = null, y: Number? = null, xend: Number? = null, yend: Number? = null, alpha: Number? = null, color: Any? = null, linetype: Any? = null, size: Number? = null, sizeStart: Number? = null, sizeEnd: Number? = null, strokeStart: Number? = null, strokeEnd: Number? = null, colorBy: String? = null, mapping: SegmentMapping.() -> Unit = {})

Properties

Link copied to clipboard
open override val alpha: 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
val geom: GeomOptions
Link copied to clipboard
Link copied to clipboard
open override val linetype: Any? = null
Link copied to clipboard
val mapping: <Error class: unknown class>
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 sizeEnd: Number? = null
Link copied to clipboard
open override val sizeStart: Number? = null
Link copied to clipboard
val stat: StatOptions
Link copied to clipboard
open override val strokeEnd: Number? = null
Link copied to clipboard
open override val strokeStart: Number? = null
Link copied to clipboard
Link copied to clipboard
open override val x: Number? = null
Link copied to clipboard
open override val xend: Number? = null
Link copied to clipboard
open override val y: Number? = null
Link copied to clipboard
open override val yend: Number? = null