geom_rect#
- geom_rect(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, color_by=None, fill_by=None, **other_args)#
Display an axis-aligned rectangle defined by two corners.
- 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.
- 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
Bounding boxes of geometries will be drawn.
- 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.- color_by{‘fill’, ‘color’, ‘paint_a’, ‘paint_b’, ‘paint_c’}, default=’color’
Define the color aesthetic for the geometry.
- fill_by{‘fill’, ‘color’, ‘paint_a’, ‘paint_b’, ‘paint_c’}, default=’fill’
Define the fill 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
geom_rect()
draws rectangles.geom_rect()
understands the following aesthetics mappings:xmin : x-axis value.
xmax : x-axis value.
ymin : y-axis value.
ymax : 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.
fill : fill color. For more info see Color and Fill.
size : lines 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.
The
data
andmap
parameters ofGeoDataFrame
type support shapesMultiPoint
,Line
,MultiLine
,Polygon
andMultiPolygon
.The
map
parameter ofGeocoder
type implicitly invokes get_limits() 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_rect(xmin=-1, xmax=1, ymin=-1, ymax=1)
1import numpy as np 2import pandas as pd 3from lets_plot import * 4LetsPlot.setup_html() 5n = 1000 6centers = {'a': (-2, -2), 'b': (3, 0), 'c': (0, 3)} 7np.random.seed(42) 8c = np.random.choice(list(centers.keys()), size=n) 9x = np.array([centers[k][0] for k in c]) + np.random.normal(size=n) 10y = np.array([centers[k][1] for k in c]) + np.random.normal(size=n) 11df = pd.DataFrame({'x': x, 'y': y, 'c': c}).sort_values(by='c') 12agg_df = df.groupby('c').agg({'x': ['min', 'max'], \ 13 'y': ['min', 'max']}).reset_index() 14agg_df.columns = ['c', 'xmin', 'xmax', 'ymin', 'ymax'] 15ggplot() + \ 16 geom_rect(aes(xmin='xmin', xmax='xmax', ymin='ymin', \ 17 ymax='ymax', color='c', fill='c'), \ 18 data=agg_df, alpha=.2) + \ 19 geom_point(aes(x='x', y='y', color='c'), data=df)
1from lets_plot import * 2from lets_plot.geo_data import * 3LetsPlot.setup_html() 4geometry = geocode_countries("Kazakhstan").get_boundaries().iloc[0].geometry 5bbox = geometry.bounds 6ggplot() + geom_livemap() + \ 7 geom_rect(xmin=bbox[0], ymin=bbox[1], xmax=bbox[2], ymax=bbox[3], alpha=.5)
The geodata is provided by © OpenStreetMap contributors and is made available here under the Open Database License (ODbL).