Skip to contents

tmap options

Usage

tmap_options(...)

tmap_options_mode(mode = NA, default.options = FALSE)

tm_options(...)

tmap_options_diff()

tmap_options_reset()

tmap_options_save(style)

Arguments

...

See details

mode

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

default.options

return the default options or the current options?

style

style, see tmap_style() for available styles

Details

optiondescription
modesMode specific options. It is a named list where names correspond to the available modes. Each item is a list of options.
crsMap 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().
facet.maxMaximum number of facets
facet.flipShould facets be flipped (in case of facet wrap)? This can also be set via tm_facets_flip()
free.scalesFor backward compatibility: if this value is set, it will be used to impute the free arguments in the layer functions
raster.max.cellsMaximum number of raster grid cells
show.messagesShow messages?
show.warningsShow warnings?
output.formatOutput format
output.sizeOutput size
output.dpiOutput dpi
output.dpi.animationOutput dpi for animations
value.constDefault 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.
value.naDefault visual values that are used to visualize NA data values. A list is required with per visual variable a value.
value.nullDefault visual values that are used to visualize null (out-of-scope) data values. A list is required with per visual variable a value.
value.blankDefault visual values that correspond to blank. For color these are "#00000000" meaning transparent. A list is required with per visual variable a value.
values.varDefault 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.
values.rangeDefault range for values. See values.range of tm_scale_categorical(). A list is required with per visual variable a value.
value.neutralDefault 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.
scales.varDefault scales.
label.formatFormat for the labels (was legend.format in tmap v3).
label.naDefault label for missing values.
See tm_layout() for layout specific options.