tm_scale_bar

This function was renamed to <code>tm_scalebar()</code> in tmap v4.0.

internal

Thematic maps are geographical maps in which spatial data
distributions are visualized. This package offers a flexible,
layer-based, and easy to use approach to create thematic maps, such as
choropleths and bubble maps.

Martijn Tennekes

tmap

Thematic Maps

Jakub Nowosad

Joel Gombin

Sebastian Jeworutzki

Kent Russell

Richard Zijdeman

John Clouse

Robin Lovelace

Jannes Muenchow

Olivier Roy

Edzer Pebesma

Hugh Graham

Michael D. Sumner

Tim Appelhans

Nick Bearman

tm_scale_bar function

<dl><dt>...</dt>
<dd>Arguments passed on to <code>tm_scalebar</code><dl>
 <dt><code>breaks</code></dt>
<dd>breaks</dd></dl></dd> <dt><code>width</code></dt>
<dd>width of the scale bar. Units are number of text line heights, which is similar to the number of characters.</dd> <dt><code>text.size</code></dt>
<dd>text size</dd> <dt><code>text.color</code></dt>
<dd>text.color</dd> <dt><code>color.dark</code></dt>
<dd>color.dark</dd> <dt><code>color.light</code></dt>
<dd>color.light</dd> <dt><code>lwd</code></dt>
<dd>linewidth</dd> <dt><code>size</code></dt>
<dd>Deprecated (use <code>text.size</code> instead)</dd> <dt><code>stack</code></dt>
<dd>stack with other map components, either <code>"vertical"</code> or <code>"horizontal"</code>.</dd> <dt><code>margins</code></dt>
<dd>margins</dd> <dt><code>frame</code></dt>
<dd>frame</dd> <dt><code>frame.lwd</code></dt>
<dd>frame line width</dd> <dt><code>frame.r</code></dt>
<dd>Radius of the rounded frame corners. 0 means no rounding.</dd> <dt><code>bg.color</code></dt>
<dd>Background color</dd> <dt><code>bg.alpha</code></dt>
<dd>Background transparency</dd> <dt><code>position</code></dt>
<dd>An object created with <code>tm_pos_in()</code> or <code>tm_pos_out()</code>. Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is <code>"left"</code>, <code>"center"</code> or <code>"right"</code> (or upper case, meaning tighter to the map frame), the second <code>"top"</code>, <code>"center"</code> or <code>"bottom"</code>. Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also <a href="https://r-tmap.github.io/tmap/articles/adv_positions">vignette about positioning</a>.</dd> <dt><code>z</code></dt>
<dd>z</dd> 
</dl>

Arguments

Map component: scale bar — tm_scale_bar

<dl>

<dt>...</dt>
<dd>Arguments passed on to <code>tm_scalebar</code><dl>
 <dt><code>breaks</code></dt>
<dd>breaks</dd>

 <dt><code>width</code></dt>
<dd>width of the scale bar. Units are number of text line heights, which is similar to the number of characters.</dd>

 <dt><code>text.size</code></dt>
<dd>text size</dd>

 <dt><code>text.color</code></dt>
<dd>text.color</dd>

 <dt><code>color.dark</code></dt>
<dd>color.dark</dd>

 <dt><code>color.light</code></dt>
<dd>color.light</dd>

 <dt><code>lwd</code></dt>
<dd>linewidth</dd>

 <dt><code>size</code></dt>
<dd>Deprecated (use <code>text.size</code> instead)</dd>

 <dt><code>stack</code></dt>
<dd>stack with other map components, either <code>"vertical"</code> or <code>"horizontal"</code>.</dd>

 <dt><code>margins</code></dt>
<dd>margins</dd>

 <dt><code>frame</code></dt>
<dd>frame</dd>

 <dt><code>frame.lwd</code></dt>
<dd>frame line width</dd>

 <dt><code>frame.r</code></dt>
<dd>Radius of the rounded frame corners. 0 means no rounding.</dd>

 <dt><code>bg.color</code></dt>
<dd>Background color</dd>

 <dt><code>bg.alpha</code></dt>
<dd>Background transparency</dd>

 <dt><code>position</code></dt>
<dd>An object created with <code>tm_pos_in()</code> or <code>tm_pos_out()</code>. Or, as a shortcut, a vector of two values, specifying the x and y coordinates. The first is <code>"left"</code>, <code>"center"</code> or <code>"right"</code> (or upper case, meaning tighter to the map frame), the second <code>"top"</code>, <code>"center"</code> or <code>"bottom"</code>. Numeric values are also supported, where 0, 0 means left bottom and 1, 1 right top. See also <a href='https://r-tmap.github.io/tmap/articles/adv_positions'>vignette about positioning</a>.</dd>

 <dt><code>z</code></dt>
<dd>z</dd>

 
</dl></dd>

</dl>

Map component: scale bar

tm_scale_bar: Map component: scale bar

Description

Usage

Arguments