lcolorbar

Color bar with text labels

Syntax

lcolorbar(labels)

lcolorbar(labels,Name,Value)

h = lcolorbar(___)

Description

lcolorbar(labels) displays a vertical color bar, with labels specified by the text in labels, to the right of the current axes.

lcolorbar(labels,Name,Value) specifies options for the color bar using name-value arguments.

example

h = lcolorbar(___) returns the color bar, using any combination of input arguments from the previous syntaxes.

Examples

collapse all

Create Labeled Color Bar

Open Live Script

Import elevation data for a region surrounding South Boulder Peak in Colorado. Calculate the viewshed for a sample point 1000 meters above the terrain.

[Z,R] = readgeoraster("n39_w106_3arc_v2.dt1","OutputType","double");
[vis,visR] = viewshed(Z,R,39.6,-105.6,1000);

Display the viewshed on a map, using green for visible areas and purple for obscured areas.

figure
usamap(vis,visR)
geoshow(vis,visR,"DisplayType","surface")
cmap = [0.4940 0.1840 0.5560; 0.4660 0.6740 0.1880];

Add a labeled color bar. Avoid truncating the text by moving the color bar to the left.

colormap(cmap)
h = lcolorbar(["Obscured" "Visible"]);
h.Position(1) = h.Position(1)-0.1;

Figure contains an axes object. The axes object contains an object of type image.

Input Arguments

collapse all

`labels` — Tick mark labels
cell array of character vectors | string array

Tick mark labels, specified as a cell array of character vectors or a string array. The number of elements in labels must match the length of the colormap.

Example: ["blue" "green" "yellow"]

Data Types: cell | char | string

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: lcolorbar(labels,Location="horizontal") displays a horizontal color bar below the axes.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: lcolorbar(labels,"Location","horizontal") displays a horizontal color bar below the axes.

Note

In addition to the name-value arguments in this section, you can use name-value arguments to specify values for the properties of the Axes object returned by this function. For more information about the properties of Axes objects, see Axes Properties.