geom_segment#

geom_segment(mapping=None, *, data=None, stat=None, position=None, show_legend=None, inherit_aes=None, manual_key=None, sampling=None, tooltips=None, arrow=None, flat=None, geodesic=None, spacer=None, color_by=None, **other_args)#

Draw a straight line segment between two points.

Parameters:
mappingFeatureSpec

Set of aesthetic mappings created by aes() function. Aesthetic mappings describe the way that variables in the data are mapped to plot “aesthetics”.

datadict or Pandas or Polars DataFrame

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

statstr, default=’identity’

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), ‘density’ (computes and draws kernel density estimate).

positionstr or FeatureSpec, default=’identity’

Position adjustment. Either a position adjustment name: ‘dodge’, ‘dodgev’, ‘jitter’, ‘nudge’, ‘jitterdodge’, ‘fill’, ‘stack’ or ‘identity’, or the result of calling a position adjustment function (e.g., position_dodge() etc.).

show_legendbool, default=True

False - do not show legend for this layer.

inherit_aesbool, default=True

False - do not combine the layer aesthetic mappings with the plot shared mappings.

manual_keystr or layer_key

The key to show in the manual legend. Specify text for the legend label or advanced settings using the layer_key() function.

samplingFeatureSpec

Result of the call to the sampling_xxx() function. To prevent any sampling for this layer pass value “none” (string “none”).

tooltipslayer_tooltips

Result of the call to the layer_tooltips() function. Specify appearance, style and content. Set tooltips=’none’ to hide tooltips from the layer.

arrowFeatureSpec

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

flatbool, default=False.

True - keep a line straight (corresponding to a loxodrome in case of Mercator projection). False - allow a line to be reprojected, so it can become a curve.

geodesicbool, default=False

Draw geodesic. Coordinates expected to be in WGS84. Works only with geom_livemap().

spacerfloat, default=0.0

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

color_by{‘fill’, ‘color’, ‘paint_a’, ‘paint_b’, ‘paint_c’}, default=’color’

Define the color aesthetic for the geometry.

other_args

Other arguments passed on to the layer. These are often aesthetics settings used to set an aesthetic to a fixed value, like color=’red’, fill=’blue’, size=3 or shape=21. They may also be parameters to the paired geom/stat.

Returns:
LayerSpec

Geom object specification.

Notes

geom_segment() draws segments.

geom_segment() understands the following aesthetics mappings:

  • x : x-axis value.

  • y : y-axis value.

  • xend : x-axis value.

  • yend : y-axis value.

  • alpha : transparency level of a layer. Accept values between 0 and 1.

  • color (colour) : color of the geometry lines. For more info see Color and Fill.

  • size : line width.

  • linetype : type of the 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 list pattern [offset, [dash, gap, …]] / [dash, gap, …]. For more info see Line Types.

  • size_start : 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).

  • size_end : 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).

  • stroke_start : 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).

  • stroke_end : 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).

Examples

1from lets_plot import *
2LetsPlot.setup_html()
3ggplot() + geom_segment(x=0, y=0, xend=1, yend=1)

 1import numpy as np
 2from lets_plot import *
 3LetsPlot.setup_html()
 4T = 25
 5np.random.seed(42)
 6t = [0, *np.random.normal(size=T)]
 7x = np.cumsum(np.cos(t))
 8y = np.cumsum(np.sin(t))
 9data = {'x': x[:-1], 'y': y[:-1], 'xend': x[1:], 'yend': y[1:]}
10ggplot(data, aes(x='x', y='y')) + \
11    geom_segment(aes(xend='xend', yend='yend', color='xend'), \
12                 arrow=arrow(type='closed', angle=10)) + \
13    scale_color_gradient(low='#2c7bb6', high='#d7191c') + \
14    coord_fixed()

 1from lets_plot import *
 2LetsPlot.setup_html()
 3pushkin_1829_journey = {
 4    "dep_city": ["Moscow", "Oryol", "Novocherkassk", "Stavropol", \
 5                 "Georgiyevsk", "Vladikavkaz", "Tiflis", "Kars"],
 6    "arr_city": ["Oryol", "Novocherkassk", "Stavropol", "Georgiyevsk", \
 7                 "Vladikavkaz", "Tiflis", "Kars", "Erzurum"],
 8    "dep_lon": [37.618423, 36.098689, 40.110401, 41.9734, \
 9                43.4577689, 44.66778, 44.783333, 43.09495],
10    "arr_lon": [36.098689, 40.110401, 41.9734, 43.4577689, \
11                44.66778, 44.783333, 43.09495, 41.27694],
12    "dep_lat": [55.751244, 52.929697, 47.414101, 45.0428, \
13                44.1497667, 43.03667, 41.716667, 40.60199],
14    "arr_lat": [52.929697, 47.414101, 45.0428, 44.1497667, \
15                43.03667, 41.716667, 40.60199, 39.90861],
16}
17ggplot(pushkin_1829_journey) + geom_livemap(const_size_zoomin=0) + \
18    geom_segment(aes(x="dep_lon", y="dep_lat", xend="arr_lon", yend="arr_lat"), \
19                 size=1, color="#fc4e2a", arrow=arrow(), \
20                 tooltips=layer_tooltips().line("from @dep_city to @arr_city"))