geom_text_repel#

geom_text_repel(mapping=None, *, data=None, stat=None, position=None, show_legend=None, inherit_aes=None, manual_key=None, sampling=None, tooltips=None, map=None, map_join=None, use_crs=None, label_format=None, na_text=None, nudge_x=None, nudge_y=None, size_unit=None, nudge_unit=None, check_overlap=None, color_by=None, seed=None, max_iter=None, max_time=None, direction=None, point_padding=None, box_padding=None, max_overlaps=None, min_segment_length=None, arrow=None, **other_args)#

Add text labels that repel away from each other and from data 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 or GeoDataFrame

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.

mapGeoDataFrame or Geocoder

Data containing coordinates of points.

map_joinstr or list

Keys used to join map coordinates with data. First value in pair - column/columns in data. Second value in pair - column/columns in map.

use_crsstr, optional, default=”EPSG:4326” (aka WGS84)

EPSG code of the coordinate reference system (CRS) or the keyword “provided”. If an EPSG code is given, then all the coordinates in GeoDataFrame (see the map parameter) will be projected to this CRS. Specify “provided” to disable any further re-projection and to keep the GeoDataFrame’s original CRS.

label_formatstr

Format used to transform label mapping values to a string. Examples:

  • ‘.2f’ -> ‘12.45’

  • ‘Num {}’ -> ‘Num 12.456789’

  • ‘TTL: {.2f}$’ -> ‘TTL: 12.45$’

For more info see Formatting.

na_textstr, default=’n/a’

Text to show for missing values.

nudge_xfloat

Horizontal adjustment to nudge labels by.

nudge_yfloat

Vertical adjustment to nudge labels by.

size_unit{‘x’, ‘y’}

Relate the size of the text to the length of the unit step along one of the axes. If None, no fitting is performed.

nudge_unit{‘identity’, ‘size’, ‘px’}, default=’identity’

Units for x and y nudging. Possible values:

  • ‘identity’: a unit of 1 corresponds to a difference of 1 in data space;

  • ‘size’: a unit of 1 corresponds to the diameter of a point with size=1;

  • ‘px’: the unit is measured in screen pixels.

check_overlapbool, default=False

If True, skip plotting text that overlaps previous text in the same layer.

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

Define the color aesthetic for the geometry.

seedint

Random seed used for reproducibility of label positions.

max_iterint

Maximum number of iterations used to resolve label collisions.

max_timefloat

Maximum allowed time in seconds for resolving label collisions.

direction{‘both’, ‘x’, ‘y’}, default=’both’

Limit direction of repulsion movement.

point_paddingfloat

Padding around data points to avoid label overlap.

box_paddingfloat

Padding around text labels to avoid label-label overlap.

max_overlapsint

Maximum number of overlapping labels allowed. Labels beyond this number will be hidden.

min_segment_lengthfloat

Minimum length of the line segment connecting the label to the point. Shorter segments will be omitted.

arrowFeatureSpec

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

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

Adds text annotations to the plot using a force-based layout algorithm designed to prevent overlaps. Labels repel each other and the data points they annotate, resulting in a clearer and more readable visualization.

This is based on the “repelling labels” idea from the ggrepel package in R, and is especially useful for annotating crowded plots while minimizing collisions between text elements or label boxes.

geom_text_repel() understands the following aesthetics mappings:

  • x : x-axis value.

  • y : y-axis value.

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

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

  • size : font size.

  • label : text to add to plot.

  • family : font family. For more info see Text.

  • fontface : font style and weight. For more info see 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. 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).

  • angle : text rotation angle in degrees.

  • lineheight : line height multiplier applied to the font size in the case of multi-line text.

  • shape : shape of the point, an integer from 0 to 25. For more info see Point Shapes.

  • point_size : A value representing the visual size of the point associated with the label.

  • point_stroke : Width of the point border.

  • segment_color : Color of the line segment connecting the label to the point.

  • segment_size : Width of the line segment connecting the label to the point.

  • segment_alpha : Transparency level of the line segment. Accept values between 0 and 1.

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

Examples

 1from lets_plot import *
 2LetsPlot.setup_html()
 3data = {
 4    "x": [-0.5, 0.5],
 5    "y": [0, 0],
 6    "label": ["Lorem ipsum", "dolor sit amet"]
 7}
 8ggplot(data, aes("x", "y")) + \
 9    geom_point(size=20) + \
10    geom_text_repel(aes(label="label"), point_size=20, size=10, seed=42) + \
11    xlim(-1.2, 1.2) + ylim(-1.2, 1.2)
On this page