legendBreaks: Legends for colour scale

View source: R/legendBreaks.R

legendBreaksR Documentation

Legends for colour scale

Description

Legends where N+1 labels are supplied as the limits of N bins.

Usage

legendBreaks(pos, 
	breaks,     
	col,    legend,
    rev=TRUE,
    outer=TRUE,
    pch=15,
    bg='white',
    cex=par('cex'),
    pt.cex=2.5*cex,
    text.col=par('fg'),
    title=NULL,
    inset=0.05,
    title.col=text.col,
    adj=0,
    width=Inf,
    lines=Inf,
    y.intersp,
	...)
	

Arguments

pos

Position, as specified in the legend function.

breaks

Optional list with elements col and legend, such as the output from colourScale

col

Single colour or vector of colours for each bin

legend

vector of labels for the legend, one more element than there are colours

rev

if TRUE, labels and colours are ordered from bottom to top, otherwise top to bottom.

outer

If TRUE, put legend in the margin of the plot

pch

see legend

bg

background colour see legend

cex

see legend

pt.cex

see legend

text.col

see legend

title

see legend

inset

see legend

title.col

see legend

adj

Adjustment of the legend labels relative to plotting symbols.

width

Maximum number of characters before a line break is added to the legend labels

lines

Maximum number of lines in each legend label

y.intersp

see legend

...

Additional arguments passed to legend.

Details

A legend for 'z-axis' colour scales.

Value

Result of call to legend

See Also

colourScale


mapmisc documentation built on Nov. 21, 2023, 5:09 p.m.