geopandas.GeoDataFrame.plot#

GeoDataFrame.plot()[source]#

Plot a GeoDataFrame.

Generate a plot of a GeoDataFrame with matplotlib. If a column is specified, the plot coloring will be based on values in that column.

Parameters:
columnstr, np.array, pd.Series, pd.Index (default None)

The name of the GeoDataFrame column, np.array, pd.Series, or pd.Index to be plotted. If np.array, pd.Series, or pd.Index are used then it must have same length as GeoDataFrame. Values are used to color the plot. Ignored if color is also set.

kind: str

The kind of plots to produce. The default is to create a map ("geo"). Other supported kinds of plots from pandas:

  • 'line' : line plot

  • 'bar' : vertical bar plot

  • 'barh' : horizontal bar plot

  • 'hist' : histogram

  • 'box' : BoxPlot

  • 'kde' : Kernel Density Estimation plot

  • 'density' : same as 'kde'

  • 'area' : area plot

  • 'pie' : pie plot

  • 'scatter' : scatter plot

  • 'hexbin' : hexbin plot.

cmapstr | Colormap | dict (default None)

The name of a colormap recognized by matplotlib, a matplotlib.colors.Colormap or a dictionary of value: color mapping for categorical plots.

colorstr, np.array, pd.Series (default None)

Color of the geometry. If specified as scalar matplotlib understands as a color (str, tuple or RGBA etc.), all objects will be colored uniformly. If specifies as array-like of the same length as GeoDataFrame, individual colors will be mapped to respective geometries.

axmatplotlib.axes.Axes (default None)

matplotlib.axes.Axes axes on which to draw the plot

caxmatplotlib.axes.Axes (default None)

matplotlib.axes.Axes on which to draw the legend in case of a colorbar.

categoricalbool (default False)

Determine whether values of column shall be treated as a categorical variable or as a continuous one. For non-numerical columns, this will be set to True automatically.

legendbool (default False)

Plot a legend. Ignored if no column is given, or if color is given. This can be a matplotlib.legend.Legend in case of categorical variables or those with set scheme and a categorical legend, or a :class`:matplotlib.colorbar.Colorbar` in case of continuous variables or those with set scheme and a colorbar legend.

schemestr (default None)

Name of a choropleth classification scheme (requires mapclassify). A mapclassify.classifiers.MapClassifier object will be used under the hood. Supported are all schemes provided by mapclassify (e.g. 'BoxPlot', 'EqualInterval', 'FisherJenks', 'FisherJenksSampled', 'HeadTailBreaks', 'JenksCaspall', 'JenksCaspallForced', 'JenksCaspallSampled', 'MaxP', 'MaximumBreaks', 'NaturalBreaks', 'Quantiles', 'Percentiles', 'StdMean', 'UserDefined'). Arguments can be passed in classification_kwds.

This requires continuous variable and can result in a categorical plot where each classification bin is mapped to a category (default behavior) or in a continuous plot where bins are used to define matplotlib.colors.BoundaryNorm. The latter can be enabled by specifying colorbar=True within legend_kwds and yields colorbar legend.

In addition, scheme='greedy' uses mapclassify.greedy() to derive greedy (topological) coloring which attempts to color a GeoDataFrame using as few colors as possible, where no neighbours can have same color as the feature itself. This cannot be specified together with column as each geometry is treated as unique with no relation to its attributes.

kint (default 5)

Number of classes (ignored if scheme is None)

vminNone or float (default None)

Minimum value of cmap or scheme. If None, the minimum data value in the column to be plotted is used.

vmaxNone or float (default None)

Maximum value of cmap or scheme. If None, the maximum data value in the column to be plotted is used.

markersizestr or float or Sequence (default None)

Only applies to point geometries within a GeoDataFrame. If a str, will use the values in the column of the GeoDataFrame specified by markersize to set the size of markers. Otherwise can be a value to apply to all points, or a sequence of the same length as the number of points.

figsizetuple of integers (default None)

Size of the resulting matplotlib.figure.Figure. If the argument ax is given explicitly, figsize is ignored.

legend_kwdsdict (default None)

Keyword arguments to pass to matplotlib.pyplot.legend() (e.g. labels, or frameon) or matplotlib.pyplot.colorbar() (e.g. orientation). Additional accepted keywords when scheme is specified:

fmtstring

A formatting specification for the bin edges of the classes in the legend. For example, to have no decimals: {"fmt": "{:.0f}"}.

intervalboolean (default False)

An option to control brackets from mapclassify legend. If True, open/closed interval brackets are shown in the legend.

colorbarboolean (default False)

An option to control whether the legend should be treated as categorical or as a colorbar. When set to True, fmt and interval shall not be used.

categorieslist-like

Ordered list-like object of categories to be used for categorical plot.

classification_kwdsdict (default None)

Keyword arguments to pass to mapclassify when scheme is set.

missing_kwdsdict (default None)

Keyword arguments specifying style options (e.g. color, hatch, linewidth) to be passed on to geometries with missing values in addition to or overwriting other style_kwds. If None, geometries with missing values are not plotted.

aspect‘auto’, ‘equal’, None or float (default 'auto')

Set aspect of axis. If 'auto', the default aspect for map plots is 'equal'; if however data are not projected (coordinates are long/lat), the aspect is by default set to 1/cos(df_y * pi/180) with df_y the y coordinate of the middle of the GeoDataFrame (the mean of the y range of bounding box) so that a long/lat square appears square in the middle of the plot. This implies an Equirectangular projection. If None, the aspect of ax won’t be changed. It can also be set manually (float) as the ratio of y-unit to x-unit.

autolimbool (default True)

Update axes data limits to contain the new geometries.

tilesbool, str, xyzservices.TileProvider, os.PathLike, file-like, or rasterio.io.MemoryFile (default False)

Add contextual background tiles. Can be either a boolean, xyzservices.TileProvider, any string that can be resolved by xyzservices.providers.query_name(), URL, or a path to a local file. The placeholders for the XYZ in the URL need to be {x}, {y}, {z}, respectively. For local file paths, the file is read with rasterio and all bands are loaded into the basemap. The tiles are automatically warped to the CRS of the geometry. Note that this can result in suboptimal rendering. To avoid warping, geometry needs to be in EPSG:3857 (Web Mercator) or a CRS of the tiles if other projection is used. Default basemap when True follows the default of the underlying contextily.add_basemap(), which is OpenStreetMap Humanitarian.

attrstr (default None)

Attribution text passed to contextily.add_basemap() as attribution. When not provided, the default attribution of the selected tile source is used.

add_labelsbool (default True)

Use CRS metadata to label the axes.

**style_kwdsdict

Style options to be passed on to the actual plot function, such as edgecolor, facecolor, linewidth, markersize, alpha. These can be scalar, which are uniformly mapped to all geometries, array-likes of the same length as GeoDataFrame, which are mapped to their respective geometries, or dictionaries mapping styles to values when dealing with categorical plots.

Returns:
axmatplotlib axes instance

Examples

>>> import geodatasets
>>> df = geopandas.read_file(geodatasets.get_path("nybb"))
>>> df.head()
   BoroCode  ...                                           geometry
0         5  ...  MULTIPOLYGON (((970217.022 145643.332, 970227....
1         4  ...  MULTIPOLYGON (((1029606.077 156073.814, 102957...
2         3  ...  MULTIPOLYGON (((1021176.479 151374.797, 102100...
3         1  ...  MULTIPOLYGON (((981219.056 188655.316, 980940....
4         2  ...  MULTIPOLYGON (((1012821.806 229228.265, 101278...

>>> df.plot("BoroName", cmap="Set1")

See the User Guide page Mapping and plotting tools for details.