geom_text#
- geom_text(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, **other_args)#
Add a text directly to the plot.
- Parameters:
- mapping
FeatureSpec
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
orGeoDataFrame
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 the same x-axis coordinate), ‘bin’ (counts number of points with the 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’, ‘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.
- sampling
FeatureSpec
Result of the call to the
sampling_xxx()
function. To prevent any sampling for this layer pass value “none” (string “none”).- tooltips
layer_tooltips
Result of the call to the layer_tooltips() function. Specify appearance, style and content. Set tooltips=’none’ to hide tooltips from the layer.
- map
GeoDataFrame
orGeocoder
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 inmap
.- 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 themap
parameter) will be projected to this CRS. Specify “provided” to disable any further re-projection and to keep theGeoDataFrame
’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’, ‘min’, ‘max’}
Relate the size of the text 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 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.
- 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.
- mapping
- Returns:
LayerSpec
Geom object specification.
Notes
Adds text directly to the plot.
geom_text()
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.
The
data
andmap
parameters ofGeoDataFrame
type support shapesPoint
andMultiPoint
.The
map
parameter ofGeocoder
type implicitly invokes get_centroids() function.
The conventions for the values of
map_join
parameter are as follows:Joining data and
GeoDataFrame
objectData has a column named ‘State_name’ and
GeoDataFrame
has a matching column named ‘state’:map_join=[‘State_Name’, ‘state’]
map_join=[[‘State_Name’], [‘state’]]
Joining data and
Geocoder
objectData has a column named ‘State_name’. The matching key in
Geocoder
is always ‘state’ (providing it is a state-level geocoder) and can be omitted:map_join=’State_Name’
map_join=[‘State_Name’]
Joining data by composite key
Joining by composite key works like in examples above, but instead of using a string for a simple key you need to use an array of strings for a composite key. The names in the composite key must be in the same order as in the US street addresses convention: ‘city’, ‘county’, ‘state’, ‘country’. For example, the data has columns ‘State_name’ and ‘County_name’. Joining with a 2-keys county level
Geocoder
object (theGeocoder
keys ‘county’ and ‘state’ are omitted in this case):map_join=[‘County_name’, ‘State_Name’]
Examples
1from lets_plot import * 2LetsPlot.setup_html() 3ggplot() + geom_text(x=0, y=0, label='Lorem ipsum')
1import pandas as pd 2from lets_plot import * 3LetsPlot.setup_html() 4df = pd.DataFrame({ 5 "x": [0, -1, -1, -1, 0, 0, 1, 1, 1], 6 "y": [0, -1, 1, 0, -1, 1, -1, 0, 1], 7 "hjust": [.5, 1, 1, 1, .5, .5, 0, 0, 0], 8 "vjust": [.5, 1, 0, .5, 1, 0, 1, .5, 0], 9}).assign( 10 label=lambda r: ("hjust=" + r["hjust"].astype(str)).str.cat( 11 "vjust=" + r["vjust"].astype(str), 12 sep='\n' 13 ) 14) 15ggplot(df, aes("x", "y")) + \ 16 geom_text(aes(label="label", hjust="hjust", vjust="vjust")) + \ 17 geom_point() + \ 18 xlim(-1.2, 1.2) + ylim(-1.2, 1.2)
hjust=0.5 vjust=0.5 hjust=1.0 vjust=1.0 hjust=1.0 vjust=0.0 hjust=1.0 vjust=0.5 hjust=0.5 vjust=1.0 hjust=0.5 vjust=0.0 hjust=0.0 vjust=1.0 hjust=0.0 vjust=0.5 hjust=0.0 vjust=0.0 -1 -0.5 0 0.5 1 -1 -0.5 0 0.5 1 y x 1import numpy as np 2from lets_plot import * 3LetsPlot.setup_html() 4n = 10 5np.random.seed(42) 6x = np.arange(n) 7y = np.random.normal(loc=10, scale=2, size=n) 8ggplot({'x': x, 'y': y}, aes(x='x', y='y')) + \ 9 geom_bar(stat='identity', fill='#2b8cbe', tooltips='none') + \ 10 geom_text(aes(label='y'), position=position_nudge(y=1), \ 11 label_format='.1f', angle=45, color='#2b8cbe')
11.0 9.7 11.3 13.0 9.5 9.5 13.2 11.5 9.1 11.1 0 1 2 3 4 5 6 7 8 9 0 2 4 6 8 10 12 y x 1from lets_plot import * 2from lets_plot.geo_data import * 3LetsPlot.setup_html() 4cities = ["New York", "Los Angeles"] 5states = ["NY", "CA"] 6titles = ['{0} ({1})'.format(city, state) \ 7 for city, state in zip(cities, states)] 8data = {"city": cities, "state": states, "title": titles} 9centroids = geocode_cities(data["city"]).get_centroids() 10ggplot(data) + geom_livemap(tiles=maptiles_lets_plot(theme='dark')) + \ 11 geom_text(aes(label="title"), map=centroids, map_join="city", \ 12 size=7, color="yellow", fontface='bold')
The geodata is provided by © OpenStreetMap contributors and is made available here under the Open Database License (ODbL).