provider name

mode. If not specified the default mode is used

If TRUE the credit (attribution) text is returned. If FALSE (default) the provider name.

Should the output be returned as list where names are provider names? By default TRUE when credits is also TRUE.

vector

options

scale

o

aes

layer

cls

ct

data.table

tmf object

smeta object

x

passed on

tmap object.

should the aspect ratio be returned?

show the map

viewport (for "plot" mode)

A logical, should knit?

A vector of options

A logical, is the map drawn in shiny?

A logical, if in.shiny, is tmapProxy() used?

passed on internally (for developers: in "view" mode, the proxy leaflet object is passed to tmapLeafletInit).

One of:

• shape object, which is an object from a class defined by the sf or stars package. Objects from the packages sp and raster are also supported, but discouraged.

• Not specified, i.e. qtm() is executed. In this case a plain interactive map is shown.

• An OpenStreetMap search string, e.g. qtm("Amsterdam"). In this case a plain interactive map is shown positioned according to the results of the search query (from OpenStreetMap nominatim)

Visual variables.

Visual variables.

data variable name by which the data is split, or a vector of two variable names to split the data by two variables (where the first is used for the rows and the second for the columns). See also tm_facets().

numeric value that serves as the global scale parameter. All font sizes, symbol sizes, border widths, and line widths are controlled by this value. The parameters symbols.size, text.size, and lines.lwd can be scaled separately with respectively symbols.scale, text.scale, and lines.scale. See also ....

main title. For legend titles, use X.legend, where X is the layer name (see ...).

Either a crs object or a character value (PROJ.4 character string). By default, the projection is used that is defined in the shp object itself.

bounding box. Argument passed on to tm_shape()

name(s) of the provider or an URL of a tiled basemap. It is a shortcut to tm_basemap(). Set to NULL to disable basemaps. By default, it is set to the tmap option basemaps.

name(s) of the provider or an URL of a tiled overlay map. It is a shortcut to tm_tiles().

zindex

group

group.control

Layout options (see tm_layout()) that define the style. See tmap_style() for details.

Deprecated, see tm_format() for alternatives

arguments associated with the visual variables are passed on to the layer functions tm_polygons(), tm_lines(), tm_symbols(), and tm_text(). For instance, fill.scale is the scale specifications of the fill color of polygons (see tm_polygons()).

A tmap object. A tmap object is created with qtm() or by stacking tmap-elements.

The environment in which to evaluate expr

Is expr a quoted expression (with quote())? This is useful if you want to save an expression in a variable

If TRUE (default), when the plot is resized, the map is regenerated. When set to FALSE the map is rescaled: the aspect ratio is kept, but the layout will be less desirable.

tmap mode, see tmap_mode() If not defined, the current mode is used

Output variable to read from

the width and height of the map

single-element character vector indicating the output ID of the map to modify (if invoked from a Shiny module, the namespace will be added automatically)

the Shiny session object to which the map belongs; usually the default value will suffice

the tmap object that specifies the added and removed layers.

the z index of the pane in which the layer is contained that is going to be removed. It is recommended to specify the zindex for this layer when creating the map (inside renderTmap()).

Shape file

tmap Identifier

bounding box

base size

base family

should the axes be shown?

should the legend(s) be shown?

visual variables and arguments passed on to tm_legend(). By default, the argument type is set to "symbols", which means that the supported visual variables are: "fill", "col", "shape", "size", "fill_alpha", "col_alpha", "lty", "lwd", "linejoin", and "lineend". The number of legend items will be equal to the maximum number of specific values (and specified labels.)

labels by default "" (so omitted)

the layer type from which the visual variables (see ...) are taken. Options: "symbols" (default), "lines", "polygons", and "text".

The title of the legend.

The design of the legend.

The orientation of the legend.

The position of the legend. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

Component group id name. All components (e.g. legends, titles, etc) with the same group_id will be grouped. The specifications of how they are placed (e.g. stacking, margins etc.) are determined in tm_comp_group() where its argument id should correspond to group_id.

Name of the group to which this layer belongs. This is only relevant in view mode, where layer groups can be switched (see group.control)

In view mode, the group control determines how layer groups can be switched on and off. Options: "radio" for radio buttons (meaning only one group can be shown), "check" for check boxes (so multiple groups can be shown), and "none" for no control (the group cannot be (de)selected).

z index, e.g. the place of the component relative to the other componets

group by variable used to create the animation frames. Note: it is called pages in the core function tm_facets().

number of animation frames. This only app

frames per second. Default: 30 for tm_facets_animate and 2 for tm_facets_animate_slow.

how should the animation be played? One of "loop", "pingpong", and "once"

device pixel ratio. The ratio between the physical pixel density of a device and its logical pixel density.

passed on to tm_facets()

Name of the provider or an URL. The list of available providers can be obtained with providers (tip: in RStudio, type ⁠leaflet::providers$⁠ to see the options). See https://leaflet-extras.github.io/leaflet-providers/preview/ for a preview of those. When a URL is provided, it should be in template format, e.g. "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png". Use NULL in tm_basemap() to disable basemaps.

Transparency level

Zoom level (only used in plot mode)

API key. Needed for Stadia and Thunderforest maps in plot mode. See details

Maximum native zoom level (only used in view mode). The minimum and maximum zoom levels are determined in tm_view().

subdomain of the tile server. Only used when server is a url template. The default is "abc" which works for most tile servers.

zindex of the pane in view mode. By default, it is set to the layer number plus 400. By default, the tmap layers will therefore be placed in the custom panes "tmap401", "tmap402", etc., except for the base tile layers, which are placed in the standard "tile". This parameter determines both the name of the pane and the z-index, which determines the pane order from bottom to top. For instance, if zindex is set to 500, the pane will be named "tmap500".

Name of the group to which this layer belongs. This is only relevant in view mode, where layer groups can be switched (see group.control)

In view mode, the group control determines how layer groups can be switched on and off. Options: "radio" for radio buttons (meaning only one group can be shown), "check" for check boxes (so multiple groups can be shown), and "none" for no control (the group cannot be (de)selected).

The breaks of the bins (for histograms)

Should the x axis and y axis be plot?

Extra ggplot2 code

The position specification of the component: an object created with tm_pos_in() or tm_pos_out(). Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is "left", "center" or "right" (or upper case, meaning tighter to the map frame), the second "top", "center" or "bottom". Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also vignette about positioning. In case multiple components should be combined (stacked), use group_id and specify component in tm_comp_group().

Component group id name. All components (e.g. legends, titles, etc) with the same group_id will be grouped. The specifications of how they are placed (e.g. stacking, margins etc.) are determined in tm_comp_group() where its argument id should correspond to group_id.

width and height of the component.

stack with other map components, either "vertical" or "horizontal".

z index, e.g. the place of the component relative to the other componets

passed on to tm_title()

List of tmap options to be set, or option names (characters) to be returned (see details)

Map crs (see tm_shape()). NA means the crs is specified in tm_shape(). The crs that is used by the transformation functions is defined in tm_shape().

Maximum number of facets

Should facets be flipped (in case of facet wrap)? This can also be set via tm_facets_flip()

For backward compatibility: if this value is set, it will be used to impute the free arguments in the layer functions

Maximum number of raster grid cells. Can be mode specific c(plot = 3000, view = 1000, 1000) (the last value is the fall back default)

Should rasters be warped or transformed in case a different projection (crs) is used? Warping creates a new regular raster in the target crs, whereas transforming creates a (usually non-regular) raster in the target crs. The former is lossy, but much faster and is therefore the default. When a different projection (crs) is used, a (usually) regular raster will be

Show messages?

Show warnings?

Output format

Output size

Output dpi

Output dpi for animations

Default visual value constants e.g. the default fill color for tm_shape(World) + tm_polygons(). A list is required with per visual variable a value.

Default visual values that are used to visualize NA data values. A list is required with per visual variable a value.

Default visual values that are used to visualize null (out-of-scope) data values. A list is required with per visual variable a value.

Default visual values that correspond to blank. For color these are "#00000000" meaning transparent. A list is required with per visual variable a value.

Default values when a data variable to mapped to a visual variable, e.g. a color palette. A list is required with per visual variable a value.

Default range for values. See values.range of tm_scale_categorical(). A list is required with per visual variable a value.

Default values for when a data variable to mapped to a visual variable, e.g. a color palette. A list is required with per visual variable a value.

Default scales (as in object sizes) for values. See values.range of tm_scale_categorical(). A list is required with per visual variable a value.

Default scale functions per visual variable and type of data variable. A list is required with per visual variable per data type.

Default values of scale function-specific arguments. A list is required with per scale function and optional per visual variable.

The number of continuous legend breaks within one 'unit' (label). The default value is 50.

the number of classes of a continuous scale. Should be odd. The default value is 101.

Format for the labels (was legend.format in tmap v3).

Default label for missing values.

Overall scale of the map

Aspect ratio of each map. When asp is set to NA (default) the aspect ratio will be adjusted to the used shapes. When set to 0 the aspect ratio is adjusted to the size of the device divided by the number of columns and rows.

Draw map background?

Background color of the map.

Draw map background (outside the frame)?

Background color of map outside the frame.

Draw map frame?

The color of the frame.

The alpha transparency of the frame.

The line width of the frame. See graphics::par, option 'lwd'.

The r (radius) of the frame.

The double line of the frame. TRUE or FALSE.

The margins of the outer space (outside the frame. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The margins of the inner space (inside the frame). A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The extra arguments of the margins of the inner space (inside the frame). A list of arguments.

The margins of the meta. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The auto_margins of the meta.

Margin between the map.

The margin of the panel.

The height of the mark of the grid.

The height of the xylab.

The height of the coords.

The visibility of the xlab. TRUE or FALSE.

The text of the xlab.

The size of the xlab.

The color of the xlab.

The rotation of the xlab.

The space of the xlab. In terms of number of text line heights.

The font face of the xlab. See graphics::par, option 'font'.

The font family of the xlab. See graphics::par, option 'family'.

The alpha transparency of the xlab.

The side of the xlab.

The visibility of the ylab. TRUE or FALSE.

The text of the ylab.

The size of the ylab.

The color of the ylab.

The rotation of the ylab.

The space of the ylab. In terms of number of text line heights.

The font face of the ylab. See graphics::par, option 'font'.

The font family of the ylab. See graphics::par, option 'family'.

The alpha transparency of the ylab.

The side of the ylab.

The type of the panel.

The panel positions for wrapped facets created with tm_facets_grid(). One of "left", "right", "top" (default) or "bottom".

The panel positions for grid facets created with tm_facets_grid(). Vector of two, where the first determines the locations of row panels ("left" or "right") and the second the location of column panels ( "top" or '"bottom")

Unit of the coordinate

The sepia_intensity of the color.

The saturation of the color.

'Color vision deficiency simulation

The font face of the text. See graphics::par, option 'font'.

The font family of the text. See graphics::par, option 'family'.

The alpha transparency of the text.

The position of the component. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The offset of the component.

The stack_margin of the component.

The autoscale of the component.

The resize_as_group of the component.

The frame_combine of the component.

The stack of the component.

The stack of the legend.

The stack of the chart.

The equalize of the component.

The frame of the component.

The color of the frame of the component.

The alpha transparency of the frame of the component.

The line width of the frame of the component. See graphics::par, option 'lwd'.

The r (radius) of the frame of the component.

The bg of the component.

The color of the bg of the component.

The alpha transparency of the bg of the component.

The visibility of the legend. TRUE or FALSE.

The design of the legend.

The orientation of the legend.

The position of the legend. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The width of the legend.

The height of the legend.

The reverse of the legend.

The visibility of the na of the legend. TRUE or FALSE.

The color of the title of the legend.

The size of the title of the legend.

The font face of the title of the legend. See graphics::par, option 'font'.

The font family of the title of the legend. See graphics::par, option 'family'.

The alpha transparency of the title of the legend.

The color of the xlab of the legend.

The size of the xlab of the legend.

The font face of the xlab of the legend. See graphics::par, option 'font'.

The font family of the xlab of the legend. See graphics::par, option 'family'.

The alpha transparency of the xlab of the legend.

The color of the ylab of the legend.

The size of the ylab of the legend.

The font face of the ylab of the legend. See graphics::par, option 'font'.

The font family of the ylab of the legend. See graphics::par, option 'family'.

The alpha transparency of the ylab of the legend.

The color of the text of the legend.

The size of the text of the legend.

The font face of the text of the legend. See graphics::par, option 'font'.

The font family of the text of the legend. See graphics::par, option 'family'.

The alpha transparency of the text of the legend.

The frame of the legend.

The color of the frame of the legend.

The alpha transparency of the frame of the legend.

The line width of the frame of the legend. See graphics::par, option 'lwd'.

The r (radius) of the frame of the legend.

The bg of the legend.

The color of the bg of the legend.

The alpha transparency of the bg of the legend.

The only of the legend.

The absolute fontsize of the legend. So far, only used to calculate legend dimensions

The portrait of the standard of the settings of the legend.

The landscape of the standard of the settings of the legend.

The position of the add_legend. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The visibility of the chart. TRUE or FALSE.

The x of the axis of the plot of the chart.

The y of the axis of the plot of the chart.

The position of the chart. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The width of the chart.

The height of the chart.

The reverse of the chart.

The visibility of the na of the chart. TRUE or FALSE.

The color of the title of the chart.

The size of the title of the chart.

The font face of the title of the chart. See graphics::par, option 'font'.

The font family of the title of the chart. See graphics::par, option 'family'.

The alpha transparency of the title of the chart.

The color of the xlab of the chart.

The size of the xlab of the chart.

The font face of the xlab of the chart. See graphics::par, option 'font'.

The font family of the xlab of the chart. See graphics::par, option 'family'.

The alpha transparency of the xlab of the chart.

The color of the ylab of the chart.

The size of the ylab of the chart.

The font face of the ylab of the chart. See graphics::par, option 'font'.

The font family of the ylab of the chart. See graphics::par, option 'family'.

The alpha transparency of the ylab of the chart.

The color of the text of the chart.

The size of the text of the chart.

The font face of the text of the chart. See graphics::par, option 'font'.

The font family of the text of the chart. See graphics::par, option 'family'.

The alpha transparency of the text of the chart.

The frame of the chart.

The color of the frame of the chart.

The alpha transparency of the frame of the chart.

The line width of the frame of the chart. See graphics::par, option 'lwd'.

The r (radius) of the frame of the chart.

The bg of the chart.

The color of the bg of the chart.

The alpha transparency of the bg of the chart.

The color of the object of the chart.

The size of the title.

The color of the title.

The font face of the title. See graphics::par, option 'font'.

The font family of the title. See graphics::par, option 'family'.

The alpha transparency of the title.

The padding of the title. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The frame of the title.

The color of the frame of the title.

The alpha transparency of the frame of the title.

The line width of the frame of the title. See graphics::par, option 'lwd'.

The r (radius) of the frame of the title.

The position of the title. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The width of the title.

The size of the credits.

The color of the credits.

The font face of the credits. See graphics::par, option 'font'.

The font family of the credits. See graphics::par, option 'family'.

The alpha transparency of the credits.

The padding of the credits. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The position of the credits. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The width of the credits.

The height of the credits.

The north of the compass.

The type of the compass.

The size of the text of the compass.

The size of the compass.

The labels of the show of the compass.

The directions of the cardinal of the compass.

The color of the text of the compass.

The dark of the color of the compass.

The light of the color of the compass.

The line width of the compass. See graphics::par, option 'lwd'.

The margins of the compass. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The position of the compass. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The position of the inset. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The height of the logo.

The margins of the logo. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The between_margin of the logo.

The position of the logo. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The height of the inset_map.

The width of the inset_map.

The margins of the inset_map. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The between_margin of the inset_map.

The position of the inset_map. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The frame of the inset_map.

The height of the inset.

The width of the inset.

The margins of the inset. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The between_margin of the inset.

The frame of the inset.

The bg of the inset.

The color of the bg of the inset.

The alpha transparency of the bg of the inset.

The height of the inset_grob.

The width of the inset_grob.

The height of the inset_gg.

The width of the inset_gg.

See tm_scalebar()

See tm_scalebar()

See tm_scalebar()

The size of the text of the scalebar.

The color of the text of the scalebar.

The font face of the text of the scalebar. See graphics::par, option 'font'.

The font family of the text of the scalebar. See graphics::par, option 'family'.

The dark of the color of the scalebar.

The light of the color of the scalebar.

The line width of the scalebar. See graphics::par, option 'lwd'.

The size of the scalebar.

The margins of the scalebar. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The position of the scalebar. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The visibility of the grid. TRUE or FALSE.

The pos of the labels of the grid.

The x of the grid.

The y of the grid.

The x of the n of the grid.

The y of the n of the grid.

The coordinate reference system (CRS) of the grid.

The color of the grid.

The line width of the grid. See graphics::par, option 'lwd'.

The alpha transparency of the grid.

The visibility of the labels of the grid. TRUE or FALSE.

The size of the labels of the grid.

The color of the labels of the grid.

The font face of the labels of the grid. See graphics::par, option 'font'.

The font family of the labels of the grid. See graphics::par, option 'family'.

The rot of the labels of the grid.

The format of the labels of the grid.

The cardinal of the labels of the grid.

The x of the margin of the labels of the grid.

The y of the margin of the labels of the grid.

The x of the space of the labels of the grid.

The y of the space of the labels of the grid.

The inside_frame of the labels of the grid.

The ticks of the grid.

The lines of the grid.

The ndiscr of the grid.

The position of the mouse_coordinates. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The server of the minimap.

The toggle of the minimap.

The position of the minimap. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The visibility of the panel. TRUE or FALSE.

The labels of the panel.

The size of the label of the panel.

The color of the label of the panel.

The font face of the label of the panel. See graphics::par, option 'font'.

The font family of the label of the panel. See graphics::par, option 'family'.

The alpha transparency of the label of the panel.

The bg of the label of the panel.

The color of the bg of the label of the panel.

The alpha transparency of the bg of the label of the panel.

The frame of the label of the panel.

The color of the frame of the label of the panel.

The alpha transparency of the frame of the label of the panel.

The line width of the frame of the label of the panel. See graphics::par, option 'lwd'.

The r (radius) of the frame of the label of the panel.

The height of the label of the panel.

Rotation angles of the panel labels. Vector of four values that determine the panel label rotation when they are placed left, top, right, and bottom. The default angles are 90, 0, 270 and 0 respectively. Note that the second value is the most common, since labels are by default shown on top (see panel.wrap.pos). In cross-table facets created with tm_facets_grid(), the first two values are used by default (see panel.xtab.pos).

The scalebar of the qtm.

The minimap of the qtm.

The mouse_coordinates of the qtm.

The earth boundary

The color of the earth_boundary.

The line width of the earth_boundary. See graphics::par, option 'lwd'.

Earth datum

The color of the space.

Should attempt to fix an invalid shapefile

The visibility of the basemap. TRUE or FALSE.

The server of the basemap.

The alpha transparency of the basemap.

The zoom of the basemap.

The visibility of the tiles. TRUE or FALSE.

The server of the tiles.

The alpha transparency of the tiles.

The zoom of the tiles.

The color of the attr.

Only used internally (work in progress)

The used crs for world maps

The crs_basemap of the .

Use gradient fill using linearGradient()

If TRUE it opens an external browser, and FALSE (default) it opens the internal IDEs (e.g. RStudio) browser.

use webGL for points, lines, and polygons. For large spatial objects, this is much faster than the standard leaflet layer functions. However, it can not always be used for two reasons. First, the number of visual variables are limited; only fill, size, and color (for lines) are supported. Second, projected CRS's are not supported. Furthermore, it has the drawback that polygon borders are not as sharp. By default only TRUE for large spatial objects (500 or more features) when the mentioned criteria are met. By default TRUE if no other visual variables are used.

The position of the control. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

base layers

overlay layers

Should the box be collapsed or expanded?

logical that determines whether maximum bounds are set, or a bounding box. Not applicable in plot mode. In view mode, this is passed on to setMaxBounds()

numeric vector that determines the view. Either a vector of three: lng, lat, and zoom, or a single value: zoom. See setView(). Only applicable if bbox is not specified

numeric vector of two that set the minimum and maximum zoom levels (see tileOptions()).

If TRUE (default) circle shaped symbols (e.g. tm_dots() and tm_symbols()) will be rendered as addCircleMarkers() instead of addMarkers(). The former is faster, the latter can support any symbol since it is based on icons

options passed on to leafletOptions()

deprecated See tm_title()

deprecated See tm_title()

deprecated. Use the title. options instead.

renamed to text.fontface and text.fontfamily

mode, e.g. "plot" or "view"

style, see tmap_style() for available styles

Should only mode-specific options be returned? TRUE by default.

return the default options or the current options?

id of the component group. Refers to the group_id argument of each component function, such as tm_legend() and tm_title().

The position specification of the components in this group: an object created with tm_pos_in() or tm_pos_out(). Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is "left", "center" or "right" (or upper case, meaning tighter to the map frame), the second "top", "center" or "bottom". Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also vignette about positioning.

stacking "horizontal" or "vertical"

put frame around all components that are drawn on the same location. Whether a frame is drawn is still decided by the frame argument of the 'main' (first) component.

in case frame_combine is FALSE, should the separate frames be equalized, i.e. have the same width (when stacked vertically) or height (when stacked horizontally)?

in case a component if rescaled because of the limited space, rescale the other components proportionally?

Margin between components

Offset margin between frame and the components block

Should a frame be drawn? By default TRUE for legends, charts and insets, and FALSE otherwise.

frame color

frame alpha transparancy

frame line width

Radius of the rounded frame corners. 0 means no rounding.

Background color the components block. Is usually set in each component function, but if specified here, it will overwrite them.

Background color the components block. Is usually set in each component function, but if specified here, it will overwrite them.

Background alpha transparency of the components block. Is usually set in each component function, but if specified here, it will overwrite them.

north

compass type, one of: "arrow", "4star", "8star", "radar", "rose". The default is controlled by tm_layout (which uses "arrow" for the default style)

text.size

size

show.labels

cardinal.directions

text.color

color.dark

color.light

lwd

The position specification of the component: an object created with tm_pos_in() or tm_pos_out(). Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is "left", "center" or "right" (or upper case, meaning tighter to the map frame), the second "top", "center" or "bottom". Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also vignette about positioning. In case multiple components should be combined (stacked), use group_id and specify component in tm_comp_group().

Component group id name. All components (e.g. legends, titles, etc) with the same group_id will be grouped. The specifications of how they are placed (e.g. stacking, margins etc.) are determined in tm_comp_group() where its argument id should correspond to group_id.

Show background?

Background color

Background transparency

stack with other map components, either "vertical" or "horizontal".

just

frame should a frame be drawn?

frame color

frame alpha transparancy

frame line width

Radius of the rounded frame corners. 0 means no rounding.

margins

z index, e.g. the place of the component relative to the other componets

to catch deprecated arguments (alpha)

text

font size

font color

padding

font face, bold, italic

font family

alpha transparency of the text

stack with other map components, either "vertical" or "horizontal".

just

frame should a frame be drawn?

frame line width

Radius of the rounded frame corners. 0 means no rounding.

Show background?

Background color

Background transparency

The position specification of the component: an object created with tm_pos_in() or tm_pos_out(). Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is "left", "center" or "right" (or upper case, meaning tighter to the map frame), the second "top", "center" or "bottom". Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also vignette about positioning. In case multiple components should be combined (stacked), use group_id and specify component in tm_comp_group().

Component group id name. All components (e.g. legends, titles, etc) with the same group_id will be grouped. The specifications of how they are placed (e.g. stacking, margins etc.) are determined in tm_comp_group() where its argument id should correspond to group_id.

width and height of the component.

z index, e.g. the place of the component relative to the other componets

to catch deprecated arguments

Map projection (CRS). Can be set to an crs object (see sf::st_crs()), a proj4string, an EPSG number, the value "auto" (automatic crs recommendation), or one the the following generic projections: c("laea", "aeqd", "utm", "pconic", "eqdc", "stere"). See details.

Which property should the projection have? One of: "global", "area" (equal-area), "distance" (equidistant), "shape" (conformal). Only applicable if crs = "auto". See details.

Group by variable (only for a facet wrap or facet stack)

Variable that specifies the rows (only for a facet grid)

Variable that specifies the columns (only for a facet grid)

Variable that specifies the pages (only for a facet grid)

show facets as layers?

Number of rows

Number of columns

Should facets be wrapped by row?

For facet stack: horizontal or vertical?

Logical. If the by argument is specified, should each map has its own coordinate ranges? By default TRUE, unless facets are shown in as different layers (as.layers = TRUE)

Logical. If the by argument is specified, should non-selected spatial units be dropped? If FALSE, they are plotted where mapped aesthetics are regarded as missing values. Not applicable for raster shapes. By default TRUE.

Logical. If the by argument is specified, should empty facets be dropped? Empty facets occur when the by-variable contains unused levels. When TRUE and two by-variables are specified, empty rows and columns are dropped.

Logical. If the by argument is specified, and all data values for specific facets are missing, should these facets be dropped? FALSE by default. In v3, it was called showNA.

Logical. Should the navigation in view mode (zooming and panning) be synchronized? By default TRUE if the facets have the same bounding box. This is generally the case when rasters are plotted, or when free.coords is FALSE.

Text used for facets of missing values. In v3, it was textNA.

Number that determines how the elements (e.g. font sizes, symbol sizes, line widths) of the small multiples are scaled in relation to the scaling factor of the shapes. The elements are scaled to the scale.factorth root of the scaling factor of the shapes. So, for scale.factor = 1, they are scaled proportional to the scaling of the shapes. Since elements, especially text, are often too small to read, a higher value is recommended. By default, scale.factor = 2.

"grid", "wrap" or "stack"

deprecated. Please use the .free arguments in the layer functions, e.g. fill.free in tm_polygons.

passed on to tm_facets()

X coordinates for vertical grid lines. If NA, it is specified with a pretty scale and n.x.

Y coordinates for horizontal grid lines. If NA, it is specified with a pretty scale and n.y.

Preferred number of grid lines for the x axis. For the labels, a pretty() sequence is used, so the number of actual labels may be different than n.x.

Preferred number of grid lines for the y axis. For the labels, a pretty() sequence is used, so the number of actual labels may be different than n.y.

Projection character. If specified, the grid lines are projected accordingly. Many world maps are projected, but still have latitude longitude (EPSG 4326) grid lines.

List of formatting options for the grid labels. Parameters are:

fun

Function to specify the labels. It should take a numeric vector, and should return a character vector of the same size. By default it is not specified. If specified, the list items scientific, format, and digits (see below) are not used.

scientific

Should the labels be formatted scientifically? If so, square brackets are used, and the format of the numbers is "g". Otherwise, format="f", and text.separator, text.less.than, and text.or.more are used. Also, the numbers are automatically rounded to millions or billions if applicable.

format

By default, "f", i.e. the standard notation xxx.xxx, is used. If scientific=TRUE then "g", which means that numbers are formatted scientifically, i.e. n.dddE+nn if needed to save space.

digits

Number of digits after the decimal point if format="f", and the number of significant digits otherwise.

...

Other arguments passed on to formatC()

Add the four cardinal directions (N, E, S, W) to the labels, instead of using negative coordinates for west and south (so it assumes that the coordinates are positive in the north-east direction).

Used to catch deprecated arguments from tmap v3.

Color of the grid lines.

Line width of the grid lines

Alpha transparency of the grid lines. Number between 0 and 1. By default, the alpha transparency of col is taken.

Show tick labels. Either one value for both x and y axis, or a vector two: the first for x and latter for y.

position of the labels. Vector of two: the horizontal ("left" or "right") and the vertical ("top" or "bottom") position.

Font size of the tick labels

Font color of the tick labels

Rotation angles of the labels. Vector of two values: the first is the rotation angle (in degrees) of the tick labels on the x axis and the second is the rotation angle of the tick labels on the y axis. Only 0, 90, 180, and 270 are valid values.

Margin between tick labels of x axis and the frame. Note that when labels.inside_frame = FALSE and ticks = TRUE, the ticks will be adjusted accordingly.

Margin between tick labels of y axis and the frame. Note that when labels.inside_frame = FALSE and ticks = TRUE, the ticks will be adjusted accordingly.

Space that is used for the labels and ticks for the x-axis when labels.inside_frame = FALSE. By default, it is determined automatically using the widths and heights of the tick labels. The unit of this parameter is text line height.

Space that is used for the labels and ticks for the y-axis when labels.inside_frame = FALSE. By default, it is determined automatically using the widths and heights of the tick labels. The unit of this parameter is text line height.

Show labels inside the frame? By default FALSE.

If labels.inside_frame = FALSE, should ticks can be drawn between the labels and the frame? Either one value for both x and y axis, or a vector two: the first for x and latter for y.

If labels.inside_frame = FALSE, should grid lines can be drawn?

Number of points to discretize a parallel or meridian (only applicable for curved grid lines)

zindex of the pane in view mode. By default, it is set to the layer number plus 400. By default, the tmap layers will therefore be placed in the custom panes "tmap401", "tmap402", etc., except for the base tile layers, which are placed in the standard "tile". This parameter determines both the name of the pane and the z-index, which determines the pane order from bottom to top. For instance, if zindex is set to 500, the pane will be named "tmap500".

Name of the group to which this layer belongs. This is only relevant in view mode, where layer groups can be switched (see group.control)

In view mode, the group control determines how layer groups can be switched on and off. Options: "radio" for radio buttons (meaning only one group can be shown), "check" for check boxes (so multiple groups can be shown), and "none" for no control (the group cannot be (de)selected).

group name that corresponds with the group name specified in the layer functions (e.g. tm_polygons())

The group control determines how layer groups can be switched on and off. Options: "radio" for radio buttons (meaning only one group can be shown), "check" for check boxes (so multiple groups can be shown), and "none" for no control (the group cannot be (de)selected).

The zoom levels at which the group is displays at. When specified control will be set to "none".

object to draw. Can be: bounding box, tmap object, ggplot2 object, grob object, image file name.

height of the component in number of text line heights.

width of the component in number of text line heights.

margins

Margin between

The position specification of the component: an object created with tm_pos_in() or tm_pos_out(). Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is "left", "center" or "right" (or upper case, meaning tighter to the map frame), the second "top", "center" or "bottom". Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also vignette about positioning. In case multiple components should be combined (stacked), use group_id and specify component in tm_comp_group().

Component group id name. All components (e.g. legends, titles, etc) with the same group_id will be grouped. The specifications of how they are placed (e.g. stacking, margins etc.) are determined in tm_comp_group() where its argument id should correspond to group_id.

frame should a frame be drawn?

frame color

frame alpha transparancy

frame line width

Radius of the rounded frame corners. 0 means no rounding.

Show background?

Background color

Background transparency

z index, e.g. the place of the component relative to the other componets

Visual variable that determines the color. See details.

Visual variable that determines the text. See details.

passed on to tm_lines() and tm_labels_highlighted(). For the text color and alpha transparency of the text labels, please use text_col and text_alpha instead of col and col_alpha.

The options for tm_lines()

The options for tm_labels_highlighted()

Legend title

Show legend?

Orientation of the legend: "portrait" or "landscape"

Legend design "standard". No other designs implemented yet.

Should the legend be reversed?

Show NA values in legend?

The position specification of the component: an object created with tm_pos_in() or tm_pos_out(). Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is "left", "center" or "right" (or upper case, meaning tighter to the map frame), the second "top", "center" or "bottom". Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also vignette about positioning. In case multiple components should be combined (stacked), use group_id and specify component in tm_comp_group().

Component group id name. All components (e.g. legends, titles, etc) with the same group_id will be grouped. The specifications of how they are placed (e.g. stacking, margins etc.) are determined in tm_comp_group() where its argument id should correspond to group_id.

Width of the legend. Units are 'text line heights'. In case a negative number is specified, the units are (approximate) pixels. The relation between these two is configured via the option absolute_fontsize.

Height of the legend. Units are 'text line heights'. In case a negative number is specified, the units are (approximate) pixels. The relation between these two is configured via the option absolute_fontsize.

z index, e.g. the place of the component relative to the other componets

The color of the title of the legend.

The size of the title of the legend.

The font face of the title of the legend. See graphics::par, option 'font'.

The font family of the title of the legend. See graphics::par, option 'family'.

The alpha transparency of the title of the legend.

The padding of the title of the legend. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The align of the title of the legend.

The color of the text of the legend.

The size of the text of the legend.

The font face of the text of the legend. See graphics::par, option 'font'.

The font family of the text of the legend. See graphics::par, option 'family'.

The alpha transparency of the text of the legend.

Not used anymore: use the format argument of the ⁠tm_scale_*()⁠ functions instead.

frame should a frame be drawn?

frame line width

Radius of the rounded frame corners. 0 means no rounding.

Show background?

The color of the bg of the legend.

The alpha transparency of the bg of the legend.

The absolute fontsize of the legend. So far, only used to calculate legend dimensions

The height of the item of the legend.

The width of the item of the legend.

The space of the item of the legend. In terms of number of text line heights.

The height of the na item of the legend.

The width of the na item of the legend.

The space of the na item of the legend. In terms of number of text line heights.

The shape of the item of the legend.

List of vectors of size 2 that determines the horizontal tick mark lines (for portrait legends). The values are the y-values of begin and endpoint of each tick mark.

Remove ticks for NA values

The color of the ticks of the legend.

The line width of the ticks of the legend. See graphics::par, option 'lwd'.

The margins of the legend. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The margin of the space between item and text of the legend.

visual values, e.g. col, fill, lwd, can be specified. If so, they overrule the default visual values, which are determined by the drawn map objects (e.g. polygons)

visual (or transformation) variable to combine the legend with: e.g. "fill" or "size"

label for the x dimension (rows)

label for the y dimension (columns)

The color of the xlab of the legend.

The size of the xlab of the legend.

The font face of the xlab of the legend. See graphics::par, option 'font'.

The font family of the xlab of the legend. See graphics::par, option 'family'.

The alpha transparency of the xlab of the legend.

The padding of the xlab of the legend. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The align of the xlab of the legend.

The color of the ylab of the legend.

The size of the ylab of the legend.

The font face of the ylab of the legend. See graphics::par, option 'font'.

The font family of the ylab of the legend. See graphics::par, option 'family'.

The alpha transparency of the ylab of the legend.

The padding of the ylab of the legend. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The align of the ylab of the legend.

Visual variable that determines the color. See details.

Visual variable that determines the line width. See details.

Visual variable that determines the line type. See details.

Visual variable that determines the color transparency. See details.

line join and line end. See gpar() for details.

Specification in which order the spatial features are drawn. See tm_plot_order() for details.

Map layers are drawn on top of each other. The zindex numbers (one for each map layer) determines the stacking order. By default the map layers are drawn in the order they are called.

Name of the group to which this layer belongs. This is only relevant in view mode, where layer groups can be switched (see group.control)

In view mode, the group control determines how layer groups can be switched on and off. Options: "radio" for radio buttons (meaning only one group can be shown), "check" for check boxes (so multiple groups can be shown), and "none" for no control (the group cannot be (de)selected).

names of data variables that are shown in the popups in "view" mode. Set popup.vars to TRUE to show all variables in the shape object. Set popup.vars to FALSE to disable popups. Set popup.vars to a character vector of variable names to those those variables in the popups. The default (NA) depends on whether visual variables (e.g.fill) are used. If so, only those are shown. If not all variables in the shape object are shown.

list of formatting options for the popup values. See the argument legend.format for options. Only applicable for numeric data variables. If one list of formatting options is provided, it is applied to all numeric variables of popup.vars. Also, a (named) list of lists can be provided. In that case, each list of formatting options is applied to the named variable.

name of the data variable that specifies the hover labels (view mode only). Set to FALSE to disable hover labels. By default FALSE, unless id is specified. In that case, it is set to id,

name of the data variable that specifies the indices of the spatial features. Only used for "view" mode.

options passed on to the corresponding ⁠opt_<layer_function>⁠ function

to catch deprecated arguments from version < 4.0

should only line geometries of the shape object (defined in tm_shape()) be plotted, or also other geometry types (like polygons)? By default "ifany", which means TRUE in case a geometry collection is specified.

either a filename or url of a png image. If multiple files/urls are provided with a character vector, the logos are placed near each other. To specify logos for small multiples use a list of character values/vectors. In order to stack logos vertically, multiple tm_logo elements can be stacked.

height of the logo in number of text line heights. The width is scaled based the height and the aspect ratio of the logo. If multiple logos are specified by a vector or list, the heights can be specified accordingly.

margins

Margin between

stack with other map components, either "vertical" or "horizontal".

The position specification of the component: an object created with tm_pos_in() or tm_pos_out(). Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is "left", "center" or "right" (or upper case, meaning tighter to the map frame), the second "top", "center" or "bottom". Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also vignette about positioning. In case multiple components should be combined (stacked), use group_id and specify component in tm_comp_group().

Component group id name. All components (e.g. legends, titles, etc) with the same group_id will be grouped. The specifications of how they are placed (e.g. stacking, margins etc.) are determined in tm_comp_group() where its argument id should correspond to group_id.

frame should a frame be drawn?

frame color

frame alpha transparancy

frame line width

Radius of the rounded frame corners. 0 means no rounding.

z index, e.g. the place of the component relative to the other componets

name of the provider or an URL (see tm_tiles). By default, it shows the same map as the basemap, and moreover, it will automatically change when the user switches basemaps. Note the latter does not happen when server is specified.

should the minimap have a button to minimise it? By default TRUE.

stack with other map components, either "vertical" or "horizontal".

The position specification of the component: an object created with tm_pos_in() or tm_pos_out(). Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is "left", "center" or "right" (or upper case, meaning tighter to the map frame), the second "top", "center" or "bottom". Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also vignette about positioning. In case multiple components should be combined (stacked), use group_id and specify component in tm_comp_group().

Component group id name. All components (e.g. legends, titles, etc) with the same group_id will be grouped. The specifications of how they are placed (e.g. stacking, margins etc.) are determined in tm_comp_group() where its argument id should correspond to group_id.

z index, e.g. the place of the component relative to the other componets

Arguments passed on to leaflet::addMiniMap

map

a map widget object

width

The width of the minimap in pixels. Defaults to 150.

height

The height of the minimap in pixels. Defaults to 150.

collapsedWidth

The width of the toggle marker and the minimap when collapsed, in pixels. Defaults to 19.

collapsedHeight

The height of the toggle marker and the minimap when collapsed, in pixels. Defaults to 19.

zoomLevelOffset

The offset applied to the zoom in the minimap compared to the zoom of the main map. Can be positive or negative, defaults to -5.

zoomLevelFixed

Overrides the offset to apply a fixed zoom level to the minimap regardless of the main map zoom. Set it to any valid zoom level, if unset zoomLevelOffset is used instead.

centerFixed

Applies a fixed position to the minimap regardless of the main map's view / position. Prevents panning the minimap, but does allow zooming (both in the minimap and the main map). If the minimap is zoomed, it will always zoom around the centerFixed point. You can pass in a LatLng-equivalent object. Defaults to false.

zoomAnimation

Sets whether the minimap should have an animated zoom. (Will cause it to lag a bit after the movement of the main map.) Defaults to false.

toggleDisplay

Sets whether the minimap should have a button to minimise it. Defaults to false.

autoToggleDisplay

Sets whether the minimap should hide automatically, if the parent map bounds does not fit within the minimap bounds. Especially useful when 'zoomLevelFixed' is set.

minimized

Sets whether the minimap should start in a minimized position.

aimingRectOptions

Sets the style of the aiming rectangle by passing in a Path.Options (https://web.archive.org/web/20220702182250/https://leafletjs.com/reference-1.3.4.html#path-options) object. (Clickable will always be overridden and set to false.)

shadowRectOptions

Sets the style of the aiming shadow rectangle by passing in a Path.Options (https://web.archive.org/web/20220702182250/https://leafletjs.com/reference-1.3.4.html#path-option) object. (Clickable will always be overridden and set to false.)

strings

Overrides the default strings allowing for translation.

tiles

URL for tiles or one of the pre-defined providers.

mapOptions

Sets Leaflet options for the MiniMap map. It does not override the MiniMap default map options but extends them.

stack with other map components, either "vertical" or "horizontal".

The position specification of the component: an object created with tm_pos_in() or tm_pos_out(). Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is "left", "center" or "right" (or upper case, meaning tighter to the map frame), the second "top", "center" or "bottom". Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also vignette about positioning. In case multiple components should be combined (stacked), use group_id and specify component in tm_comp_group().

Component group id name. All components (e.g. legends, titles, etc) with the same group_id will be grouped. The specifications of how they are placed (e.g. stacking, margins etc.) are determined in tm_comp_group() where its argument id should correspond to group_id.

z index, e.g. the place of the component relative to the other componets

Map crs (see tm_shape()). NA means the crs is specified in tm_shape(). The crs that is used by the transformation functions is defined in tm_shape().

Maximum number of facets

Should facets be flipped (in case of facet wrap)? This can also be set via tm_facets_flip()

For backward compatibility: if this value is set, it will be used to impute the free arguments in the layer functions

Maximum number of raster grid cells. Can be mode specific c(plot = 3000, view = 1000, 1000) (the last value is the fall back default)

Should rasters be warped or transformed in case a different projection (crs) is used? Warping creates a new regular raster in the target crs, whereas transforming creates a (usually non-regular) raster in the target crs. The former is lossy, but much faster and is therefore the default. When a different projection (crs) is used, a (usually) regular raster will be

Show messages?

Show warnings?

Output format

Output size

Output dpi

Output dpi for animations

Default visual value constants e.g. the default fill color for tm_shape(World) + tm_polygons(). A list is required with per visual variable a value.

Default visual values that are used to visualize NA data values. A list is required with per visual variable a value.

Default visual values that are used to visualize null (out-of-scope) data values. A list is required with per visual variable a value.

Default visual values that correspond to blank. For color these are "#00000000" meaning transparent. A list is required with per visual variable a value.

Default values when a data variable to mapped to a visual variable, e.g. a color palette. A list is required with per visual variable a value.

Default range for values. See values.range of tm_scale_categorical(). A list is required with per visual variable a value.

Default values for when a data variable to mapped to a visual variable, e.g. a color palette. A list is required with per visual variable a value.

Default scales (as in object sizes) for values. See values.range of tm_scale_categorical(). A list is required with per visual variable a value.

Default scale functions per visual variable and type of data variable. A list is required with per visual variable per data type.

Default values of scale function-specific arguments. A list is required with per scale function and optional per visual variable.

The number of continuous legend breaks within one 'unit' (label). The default value is 50.

the number of classes of a continuous scale. Should be odd. The default value is 101.

Format for the labels (was legend.format in tmap v3).

Default label for missing values.

Overall scale of the map

Aspect ratio of each map. When asp is set to NA (default) the aspect ratio will be adjusted to the used shapes. When set to 0 the aspect ratio is adjusted to the size of the device divided by the number of columns and rows.

Draw map background?

Background color of the map.

Draw map background (outside the frame)?

Background color of map outside the frame.

Draw map frame?

The color of the frame.

The alpha transparency of the frame.

The line width of the frame. See graphics::par, option 'lwd'.

The r (radius) of the frame.

The double line of the frame. TRUE or FALSE.

The margins of the outer space (outside the frame. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The margins of the inner space (inside the frame). A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The extra arguments of the margins of the inner space (inside the frame). A list of arguments.

The margins of the meta. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The auto_margins of the meta.

Margin between the map.

The margin of the panel.

The height of the mark of the grid.

The height of the xylab.

The height of the coords.

The visibility of the xlab. TRUE or FALSE.

The text of the xlab.

The size of the xlab.

The color of the xlab.

The rotation of the xlab.

The space of the xlab. In terms of number of text line heights.

The font face of the xlab. See graphics::par, option 'font'.

The font family of the xlab. See graphics::par, option 'family'.

The alpha transparency of the xlab.

The side of the xlab.

The visibility of the ylab. TRUE or FALSE.

The text of the ylab.

The size of the ylab.

The color of the ylab.

The rotation of the ylab.

The space of the ylab. In terms of number of text line heights.

The font face of the ylab. See graphics::par, option 'font'.

The font family of the ylab. See graphics::par, option 'family'.

The alpha transparency of the ylab.

The side of the ylab.

The type of the panel.

The panel positions for wrapped facets created with tm_facets_grid(). One of "left", "right", "top" (default) or "bottom".

The panel positions for grid facets created with tm_facets_grid(). Vector of two, where the first determines the locations of row panels ("left" or "right") and the second the location of column panels ( "top" or '"bottom")

Unit of the coordinate

The sepia_intensity of the color.

The saturation of the color.

'Color vision deficiency simulation

The font face of the text. See graphics::par, option 'font'.

The font family of the text. See graphics::par, option 'family'.

The alpha transparency of the text.

The position of the component. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The offset of the component.

The stack_margin of the component.

The autoscale of the component.

The resize_as_group of the component.

The frame_combine of the component.

The stack of the component.

The stack of the legend.

The stack of the chart.

The equalize of the component.

The frame of the component.

The color of the frame of the component.

The alpha transparency of the frame of the component.

The line width of the frame of the component. See graphics::par, option 'lwd'.

The r (radius) of the frame of the component.

The bg of the component.

The color of the bg of the component.

The alpha transparency of the bg of the component.

The visibility of the legend. TRUE or FALSE.

The design of the legend.

The orientation of the legend.

The position of the legend. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The width of the legend.

The height of the legend.

The reverse of the legend.

The visibility of the na of the legend. TRUE or FALSE.

The color of the title of the legend.

The size of the title of the legend.

The font face of the title of the legend. See graphics::par, option 'font'.

The font family of the title of the legend. See graphics::par, option 'family'.

The alpha transparency of the title of the legend.

The color of the xlab of the legend.

The size of the xlab of the legend.

The font face of the xlab of the legend. See graphics::par, option 'font'.

The font family of the xlab of the legend. See graphics::par, option 'family'.

The alpha transparency of the xlab of the legend.

The color of the ylab of the legend.

The size of the ylab of the legend.

The font face of the ylab of the legend. See graphics::par, option 'font'.

The font family of the ylab of the legend. See graphics::par, option 'family'.

The alpha transparency of the ylab of the legend.

The color of the text of the legend.

The size of the text of the legend.

The font face of the text of the legend. See graphics::par, option 'font'.

The font family of the text of the legend. See graphics::par, option 'family'.

The alpha transparency of the text of the legend.

The frame of the legend.

The color of the frame of the legend.

The alpha transparency of the frame of the legend.

The line width of the frame of the legend. See graphics::par, option 'lwd'.

The r (radius) of the frame of the legend.

The bg of the legend.

The color of the bg of the legend.

The alpha transparency of the bg of the legend.

The only of the legend.

The absolute fontsize of the legend. So far, only used to calculate legend dimensions

The portrait of the standard of the settings of the legend.

The landscape of the standard of the settings of the legend.

The position of the add_legend. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The visibility of the chart. TRUE or FALSE.

The x of the axis of the plot of the chart.

The y of the axis of the plot of the chart.

The position of the chart. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The width of the chart.

The height of the chart.

The reverse of the chart.

The visibility of the na of the chart. TRUE or FALSE.

The color of the title of the chart.

The size of the title of the chart.

The font face of the title of the chart. See graphics::par, option 'font'.

The font family of the title of the chart. See graphics::par, option 'family'.

The alpha transparency of the title of the chart.

The color of the xlab of the chart.

The size of the xlab of the chart.

The font face of the xlab of the chart. See graphics::par, option 'font'.

The font family of the xlab of the chart. See graphics::par, option 'family'.

The alpha transparency of the xlab of the chart.

The color of the ylab of the chart.

The size of the ylab of the chart.

The font face of the ylab of the chart. See graphics::par, option 'font'.

The font family of the ylab of the chart. See graphics::par, option 'family'.

The alpha transparency of the ylab of the chart.

The color of the text of the chart.

The size of the text of the chart.

The font face of the text of the chart. See graphics::par, option 'font'.

The font family of the text of the chart. See graphics::par, option 'family'.

The alpha transparency of the text of the chart.

The frame of the chart.

The color of the frame of the chart.

The alpha transparency of the frame of the chart.

The line width of the frame of the chart. See graphics::par, option 'lwd'.

The r (radius) of the frame of the chart.

The bg of the chart.

The color of the bg of the chart.

The alpha transparency of the bg of the chart.

The color of the object of the chart.

The size of the title.

The color of the title.

The font face of the title. See graphics::par, option 'font'.

The font family of the title. See graphics::par, option 'family'.

The alpha transparency of the title.

The padding of the title. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The frame of the title.

The color of the frame of the title.

The alpha transparency of the frame of the title.

The line width of the frame of the title. See graphics::par, option 'lwd'.

The r (radius) of the frame of the title.

The position of the title. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The width of the title.

The size of the credits.

The color of the credits.

The font face of the credits. See graphics::par, option 'font'.

The font family of the credits. See graphics::par, option 'family'.

The alpha transparency of the credits.

The padding of the credits. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The position of the credits. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The width of the credits.

The height of the credits.

The north of the compass.

The type of the compass.

The size of the text of the compass.

The size of the compass.

The labels of the show of the compass.

The directions of the cardinal of the compass.

The color of the text of the compass.

The dark of the color of the compass.

The light of the color of the compass.

The line width of the compass. See graphics::par, option 'lwd'.

The margins of the compass. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The position of the compass. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The position of the inset. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The height of the logo.

The margins of the logo. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The between_margin of the logo.

The position of the logo. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The height of the inset_map.

The width of the inset_map.

The margins of the inset_map. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The between_margin of the inset_map.

The position of the inset_map. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The frame of the inset_map.

The height of the inset.

The width of the inset.

The margins of the inset. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The between_margin of the inset.

The frame of the inset.

The bg of the inset.

The color of the bg of the inset.

The alpha transparency of the bg of the inset.

The height of the inset_grob.

The width of the inset_grob.

The height of the inset_gg.

The width of the inset_gg.

See tm_scalebar()

See tm_scalebar()

See tm_scalebar()

The size of the text of the scalebar.

The color of the text of the scalebar.

The font face of the text of the scalebar. See graphics::par, option 'font'.

The font family of the text of the scalebar. See graphics::par, option 'family'.

The dark of the color of the scalebar.

The light of the color of the scalebar.

The line width of the scalebar. See graphics::par, option 'lwd'.

The size of the scalebar.

The margins of the scalebar. A vector of 4 values: bottom, left, top, right. The unit is the device height (for bottom and top) or width (for left and right).

The position of the scalebar. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The visibility of the grid. TRUE or FALSE.

The pos of the labels of the grid.

The x of the grid.

The y of the grid.

The x of the n of the grid.

The y of the n of the grid.

The coordinate reference system (CRS) of the grid.

The color of the grid.

The line width of the grid. See graphics::par, option 'lwd'.

The alpha transparency of the grid.

The visibility of the labels of the grid. TRUE or FALSE.

The size of the labels of the grid.

The color of the labels of the grid.

The font face of the labels of the grid. See graphics::par, option 'font'.

The font family of the labels of the grid. See graphics::par, option 'family'.

The rot of the labels of the grid.

The format of the labels of the grid.

The cardinal of the labels of the grid.

The x of the margin of the labels of the grid.

The y of the margin of the labels of the grid.

The x of the space of the labels of the grid.

The y of the space of the labels of the grid.

The inside_frame of the labels of the grid.

The ticks of the grid.

The lines of the grid.

The ndiscr of the grid.

The position of the mouse_coordinates. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The server of the minimap.

The toggle of the minimap.

The position of the minimap. A tm_pos object, or a shortcut of two values: horizontal (left, center, right) and vertical (top, center, bottom). See tm_pos for details

The visibility of the panel. TRUE or FALSE.

The labels of the panel.

The size of the label of the panel.

The color of the label of the panel.

The font face of the label of the panel. See graphics::par, option 'font'.

The font family of the label of the panel. See graphics::par, option 'family'.

The alpha transparency of the label of the panel.

The bg of the label of the panel.

The color of the bg of the label of the panel.

The alpha transparency of the bg of the label of the panel.

The frame of the label of the panel.

The color of the frame of the label of the panel.

The alpha transparency of the frame of the label of the panel.

The line width of the frame of the label of the panel. See graphics::par, option 'lwd'.

The r (radius) of the frame of the label of the panel.

The height of the label of the panel.

Rotation angles of the panel labels. Vector of four values that determine the panel label rotation when they are placed left, top, right, and bottom. The default angles are 90, 0, 270 and 0 respectively. Note that the second value is the most common, since labels are by default shown on top (see panel.wrap.pos). In cross-table facets created with tm_facets_grid(), the first two values are used by default (see panel.xtab.pos).

The scalebar of the qtm.

The minimap of the qtm.

The mouse_coordinates of the qtm.

The earth boundary

The color of the earth_boundary.

The line width of the earth_boundary. See graphics::par, option 'lwd'.

Earth datum

The color of the space.

Should attempt to fix an invalid shapefile

The visibility of the basemap. TRUE or FALSE.

The server of the basemap.

The alpha transparency of the basemap.

The zoom of the basemap.

The visibility of the tiles. TRUE or FALSE.

The server of the tiles.

The alpha transparency of the tiles.

The zoom of the tiles.

The color of the attr.

Only used internally (work in progress)

The used crs for world maps

The crs_basemap of the .

deprecated See tm_title()

deprecated See tm_title()

deprecated. Use the title. options instead.

renamed to text.fontface and text.fontfamily

style see tm_style()

List of tmap options to be set, or option names (characters) to be returned (see details)

width

height

position (horizontal and vertical)

extra margins

Use gradient fill using linearGradient()

Vector of two limit latitude values for maps printed in Web Mercator projection (EPSG 3857). If c(-90, 90) the poles will be inflated too much. The Web Mercator is defines as c(-85.06, 85.06), but the default setting in tmap is c(-84, 84).

Visual variable for which the values determine the plotting order. Example: bubble map where the "size" aesthetic is used. A data variable (say population) is mapped via a continuous scale (tm_scale_continuous()) to bubble sizes. The bubbles are plotted in order of size. How is determined by the other arguments. Use "DATA" to keep the same order as in the data. Another special value are "AREA" and "LENGTH" which are preserved for polygons and lines respectively: rather than a data variable the polygon area / line lengths determines the plotting order.

Logical that determines whether the visual values are plotted in reversed order. The visual values (specified with tmap option "values.var") are by default reversed, so plotted starting from the last value. In the bubble map example, this means that large bubbles are plotted first, hence at the bottom.

Where should features be plotted that have an NA value for (at least) one other aesthetic variable? In the (order) "mix", at the "bottom", or on "top"? In the bubble map example: if fill color is missing for some bubble, where should those bubbles be plotted?

Where should non-selected (aka null) features be plotted?

Should null features be plotted below NA features?

Visual variable that determines the fill color. See details.

Visual variable that determines the color. See details.

Visual variable that determines the line width. See details.

Visual variable that determines the line type. See details.

Visual variable that determines the fill color transparency. See details.

Visual variable that determines the color transparency. See details.

Line join and line end. See gpar() for details.

Specification in which order the spatial features are drawn. See tm_plot_order() for details.

Map layers are drawn on top of each other. The zindex numbers (one for each map layer) determines the stacking order. By default the map layers are drawn in the order they are called.

Name of the group to which this layer belongs. This is only relevant in view mode, where layer groups can be switched (see group.control)

In view mode, the group control determines how layer groups can be switched on and off. Options: "radio" for radio buttons (meaning only one group can be shown), "check" for check boxes (so multiple groups can be shown), and "none" for no control (the group cannot be (de)selected).

names of data variables that are shown in the popups in "view" mode. Set popup.vars to TRUE to show all variables in the shape object. Set popup.vars to FALSE to disable popups. Set popup.vars to a character vector of variable names to those those variables in the popups. The default (NA) depends on whether visual variables (e.g.fill) are used. If so, only those are shown. If not all variables in the shape object are shown.

list of formatting options for the popup values. See the argument legend.format for options. Only applicable for numeric data variables. If one list of formatting options is provided, it is applied to all numeric variables of popup.vars. Also, a (named) list of lists can be provided. In that case, each list of formatting options is applied to the named variable.

name of the data variable that specifies the hover labels (view mode only). Set to FALSE to disable hover labels. By default FALSE, unless id is specified. In that case, it is set to id,

name of the data variable that specifies the indices of the spatial features. Only used for "view" mode.

options passed on to the corresponding ⁠opt_<layer_function>⁠ function

to catch deprecated arguments from version < 4.0

should only polygon geometries of the shape object (defined in tm_shape()) be plotted? By default "ifany", which means TRUE in case a geometry collection is specified.

The plotting area is overlaid with a 3x3 grid, of which the middle grid cell is the map area. Components can be drawn into any cell. cell.h specifies the horizontal position (column) can take values "left", "center", and "right". cell.v specifies the vertical position (row) and can take values "top", "center", and "bottom". See details for a graphical explanation.

The position of the component within the cell. The main options for pos.h are "left", "center", and "right". For cell.v these are "top", "center", and "bottom". These options can also be provided in upper case; in that case there is no offset (see the tmap option component.offset). Also numbers between 0 and 1 can be provided, which determine the position of the component inside the cell (with (0,0) being left bottom). The arguments just.h and just.v determine the justification point.

The alignment of the component in case multiple components are stacked. When they are stacked horizontally, align.v determines how components that are smaller in height than the available height (determined by the outer.margins if specified and otherwise by the highest component) are justified: "top", "center", or "bottom". Similarly, align.h determines how components are justified horizontally when they are stacked vertically: "left", "center", or "right".

The justification of the components. Only used in case pos.h and pos.v are numbers.

Visual variable that determines the color. See details.

Visual variable that determines the color transparency. See details.

Map layers are drawn on top of each other. The zindex numbers (one for each map layer) determines the stacking order. By default the map layers are drawn in the order they are called.

Name of the group to which this layer belongs. This is only relevant in view mode, where layer groups can be switched (see group.control)

In view mode, the group control determines how layer groups can be switched on and off. Options: "radio" for radio buttons (meaning only one group can be shown), "check" for check boxes (so multiple groups can be shown), and "none" for no control (the group cannot be (de)selected).

options passed on to the corresponding ⁠opt_<layer_function>⁠ function

to catch deprecated arguments from version < 4.0

Should the raster image be interpolated? Currently only applicable in view mode (passed on to grid)

Visual variable that determines the color. col is a multivariate variable, with 3 (tm_rgb) or 4 (tm_rgba) numeric data variables. These can be specified via tm_vars() with multivariate = TRUE

Visual variable that determines the color transparency. See details.

options passed on to the corresponding ⁠opt_<layer_function>⁠ function

to catch deprecated arguments from version < 4.0

Should the raster image be interpolated? Currently only applicable in view mode (passed on to grid)

The saturation of the rgb.

arguments passed on to the applied scale function ⁠tm_scale_*()⁠

(generic scale argument) Scaling of the values. Only useful for size-related visual variables, such as size of tm_symbols() and lwd of tm_lines().

(generic scale argument) Value that can be considered neutral. This is used for legends of other visual variables of the same map layer. E.g. when both fill and size are used for tm_symbols() (using filled circles), the size legend items are filled with the value.neutral color from the fill.scale scale, and fill legend items are bubbles of size value.neutral from the size.scale scale.

(generic scale argument) Value used for missing values. See tmap option "value.na" for defaults per visual variable.

Arguments caught (and not used) from the automatic function tm_scale()

Arguments passed on to tm_scalebar

breaks

breaks. E.g. c(0, 10, 50) places scale bar breaks at 0, 10, and 50 units. These units are specified in tm_shape().

width

width of the scale bar. Units are number of text line heights, which is similar to the number of characters. In case beaks are specified, the width is only handy to finetune the approximated width, e.g. in case clipping of the labels occurs, or there is too much whitespace.

allow_clipping

should clipping of the last label by allowed? If TRUE (default), the last break label including unit is printed even when it doesn't fit the frame. If FALSE it will not be printed. Instead the unit suffix is added to the second last label.

text.size

text size

text.color

text.color

color.dark

color.dark

color.light

color.light

lwd

linewidth

size

Deprecated (use text.size instead)

stack

stack with other map components, either "vertical" or "horizontal".

margins

margins

frame

frame should a frame be drawn?

frame.color

frame color

frame.alpha

frame alpha transparancy

frame.lwd

frame line width

frame.r

Radius of the rounded frame corners. 0 means no rounding.

bg

Show background?

bg.color

Background color

bg.alpha

Background transparency

position

The position specification of the component: an object created with tm_pos_in() or tm_pos_out(). Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is "left", "center" or "right" (or upper case, meaning tighter to the map frame), the second "top", "center" or "bottom". Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also vignette about positioning. In case multiple components should be combined (stacked), use group_id and specify component in tm_comp_group().

group_id

Component group id name. All components (e.g. legends, titles, etc) with the same group_id will be grouped. The specifications of how they are placed (e.g. stacking, margins etc.) are determined in tm_comp_group() where its argument id should correspond to group_id.

z

z index, e.g. the place of the component relative to the other componets

two tm_scale objects. Currently, all ⁠tm_scale_*()⁠ functions are supported except tm_scale_continuous().

(generic scale argument) The visual values. For colors (e.g. fill or col for tm_polygons()) this is a palette name from the cols4all package (see cols4all::c4a()) or vector of colors, for size (e.g. size for tm_symbols()) these are a set of sizes (if two values are specified they are interpret as range), for symbol shapes (e.g. shape for tm_symbols()) these are a set of symbols, etc. The tmap option values.var contains the default values per visual variable and in some cases also per data type.

(generic scale argument) Should the values be repeated in case there are more categories?

(generic scale argument) Range of the values. Vector of two numbers (both between 0 and 1) where the first determines the minimum and the second the maximum. Full range, which means that all values are used, is encoded as c(0, 1). For instance, when a grey scale is used for color (from black to white), c(0,1) means that all colors are used, ⁠0.25, 0.75⁠ means that only colors from dark grey to light grey are used (more precisely "grey25" to "grey75"), and ⁠0, 0.5⁠ means that only colors are used from black to middle grey ("grey50"). When only one number is specified, this is interpreted as the second number (where the first is set to 0). Default values can be set via the tmap option values.range.

(generic scale argument) Scaling of the values. Only useful for size-related visual variables, such as size of tm_symbols() and lwd of tm_lines().

(generic scale argument) Value used for missing values. See tmap option "value.na" for defaults per visual variable.

(generic scale argument) Value used for NULL values. See tmap option "value.null" for defaults per visual variable. Null data values occur when out-of-scope features are shown (e.g. for a map of Europe showing a data variable per country, the null values are applied to countries outside Europe).

(generic scale argument) Value that can be considered neutral. This is used for legends of other visual variables of the same map layer. E.g. when both fill and size are used for tm_symbols() (using filled circles), the size legend items are filled with the value.neutral color from the fill.scale scale, and fill legend items are bubbles of size value.neutral from the size.scale scale.

(generic scale argument) Labels

(generic scale argument) Label for missing values

(generic scale argument) Label for null (out-of-scope) values

Preferred number of tick labels. Only used if ticks is not specified

Limits of the data values that are mapped to the continuous scale. When NA, the range of data values is taken. When only one value is provided, the range of data values with this provided value is taken. The default depends on the visual variable: it is 0 for all visual variables other than color when tm_scale_continuous is used. For the transformation scale functions, it is NA.

Should outliers be truncated? An outlier is a data value that is below or above the respectively lower and upper limit. A logical vector of two values is expected. The first and second value determines whether values lower than the lower limit respectively higher than the upper limit are truncated to the lower respectively upper limit. If FALSE (default), they are considered as missing values.

Tick values. If not specified, it is determined automatically with n

Transformation function. One of "identity" (default), "log", and "log1p". Note: the base of the log scale is irrelevant, since the log transformed values are normalized before mapping to visual values.

The data value that is interpreted as the midpoint. By default it is set to 0 if negative and positive values are present. Useful when values are diverging colors. In that case, the two sides of the color palette are assigned to negative respectively positive values. If all values are positive or all values are negative, then the midpoint is set to NA, which means that the value that corresponds to the middle color class (see style) is mapped to the middle color. If it is specified for sequential color palettes (e.g. "Blues"), then this color palette will be treated as a diverging color palette.

(generic scale argument) The visual values. For colors (e.g. fill or col for tm_polygons()) this is a palette name from the cols4all package (see cols4all::c4a()) or vector of colors, for size (e.g. size for tm_symbols()) these are a set of sizes (if two values are specified they are interpret as range), for symbol shapes (e.g. shape for tm_symbols()) these are a set of symbols, etc. The tmap option values.var contains the default values per visual variable and in some cases also per data type.

(generic scale argument) Should the values be repeated in case there are more categories?

(generic scale argument) Range of the values, especially useful for color palettes. Vector of two numbers (both between 0 and 1) where the first determines the minimum and the second the maximum. Full range, which means that all values are used, is encoded as c(0, 1). For instance, when a gray scale is used for color (from black to white), c(0,1) means that all colors are used, ⁠0.25, 0.75⁠ means that only colors from dark gray to light gray are used (more precisely "grey25" to "grey75"), and ⁠0, 0.5⁠ means that only colors are used from black to middle gray ("grey50"). When only one number is specified, this is interpreted as the second number (where the first is set to 0). Default values can be set via the tmap option values.range.

(generic scale argument) Scaling of the values. Only useful for size-related visual variables, such as size of tm_symbols() and lwd of tm_lines().

(generic scale argument) Value used for missing values. See tmap option "value.na" for defaults per visual variable.