Documentation

ylabel

Label y-axis

Syntax

  • ylabel(str)
  • ylabel(str,Name,Value)
  • ylabel(ax,___)
  • h = ylabel(___)

Description

ylabel(str) labels the y-axis of the current axes with the string, str. Reissuing the ylabel command causes the new label to replace the old label. Labels appear beside the axis in a two-dimensional view and to the side or in front of the axis in a three-dimensional view.

ylabel(str,Name,Value) additionally specifies the text object properties using one or more Name,Value pair arguments.

ylabel(ax,___) adds the label to the axes specified by ax. This syntax allows you to specify the axes to which to add a label. ax can precede any of the input argument combinations in the previous syntaxes.

h = ylabel(___) returns the handle to the text object used as the y-axis label. The handle is useful when making future modifications to the label.

Examples

expand all

Label y-Axis with String

figure
plot((1:10).^2)
ylabel('Population')

MATLAB® displays Population beside the y-axis.

Label y-Axis with Numeric Input

figure
plot((1:10).^2)
ylabel(123)

MATLAB® displays 123 beside the y-axis.

Create Multiline Label

Create a multiline label using a multiline cell array.

figure
plot((1:10).^2)
ylabel({2010;'Population';'in Years'})

Include Superscript and Subscript in Axis Labels

Use the '^' and '_' characters to include superscripts and subscripts in the axis labels. Use curly braces {} to modify more than one character.

t = linspace(0,1);
y = exp(t);
plot(t,y)
xlabel('t_{seconds}')
ylabel('e^t')

Create y-Axis Label and Set Font Properties

Use Name,Value pairs to set the font size, font weight, and text color properties of the y-axis label.

figure
plot((1:10).^2)
ylabel('Population','FontSize',12,...
       'FontWeight','bold','Color','r')

'FontSize',12 displays the label text in 12-point font. 'FontWeight','bold' makes the text bold. 'Color','r' sets the text color to red.

Label y-Axis of Specific Axes

Create two subplots and return the axes handles, s(1) and s(2).

figure
s(1) = subplot(2,1,1);
plot((1:10).^2)
s(2) = subplot(2,1,2);
plot((1:10).^3)

Label the y-axis of the top plot by referring to its axes handle, s(1).

ylabel(s(1),'Population')

Label y-Axis and Return Object Handle

Label the y-axis and return the handle to the text object used as the label.

figure
plot((1:10).^2)
str = 'Population';
h = ylabel(str);

Set the color of the label to red using the handle. Starting in R2014b, you can use dot notation to set properties. If you are using an earlier release, use the set function instead.

h.Color = 'red';

Input Arguments

expand all

str — Text to display as y-axis labelstring

Text to display as the y-axis label, specified in one of these forms:

  • Single string — For a single line of text. A string is text between single quotes. For example, 'one line'. You can also use a function that returns a string, such as date.

  • Numeric value — For a single line of text. For example, 123.

  • Cell array — For multiline text. Display each entry in the cell array on a separate line. For example, .

  • Padded string matrix — For multiline text or for including a variable in the text. Display each row of the matrix on a separate line. Use spaces to pad the matrix to get equal characters across each row. For example, ['abc','def'; 'a ',' bcd']. To include a variable in the text, use the num2str function. For example, to include variable x in the text, use ['The value is ',num2str(x)].

If the Interpreter property is 'tex' (the default), then you can use a subset of TeX markup embedded in the string. Use TeX markup to add superscripts and subscripts or to include special characters such as Greek letters and mathematical symbols. For a complete list of supported markup, see the Interpreter property.

    Note:   The words default, factory, and remove are reserved words that will not appear in a label when quoted as a normal string. To display any of these words individually, precede them with a backslash, such as '\default' or '\remove'.

Example: 'myLabel'

ax — Axes objectaxes object

Axes object. If you do not specify an axes, then the ylabel function uses the current axes.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'Color','red','FontSize',12 specifies red, 12-point font.

In addition to the following, you can specify other text object properties using Name,Value pair arguments. See Text Properties.

'FontSize' — Font size11 (default) | scalar value greater than 0

Font size, specified as a scalar value greater than 0 in point units. One point equals 1/72 inch. To change the font units, use the FontUnits property.

Setting the font size properties for the associated axes also affects the label font size. The label font size updates to equal the axes font size times the label scale factor. The FontSize property of the axes contains the axes font size. The LabelFontSizeMultiplier property of the axes contains the label scale factor. By default, the axes font size is 10 points and the scale factor is 1.1, so the y-axis label font size is 11 points.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

'FontWeight' — Thickness of text characters'normal' (default) | 'bold'

Thickness of the text characters, specified as one of these values:

  • 'normal' — Default weight as defined by the particular font

  • 'bold' — Thicker characters outlines than normal

MATLAB® uses the FontWeight property to select a font from those available on your system. Not all fonts have a bold font weight. Therefore, specifying a bold font weight could still result in the normal font weight.

    Note:   The 'light' and 'demi' font weight values have been removed. Use 'normal' instead.

'FontName' — Font name'Helvetica' (default) | 'FixedWidth' | system supported font name

Font name, specified as the name of the font to use or the string 'FixedWidth'. To display and print properly, the font name must be a font that your system supports.

To use a fixed-width font that looks good in any locale, use the case-sensitive string 'FixedWidth'. This eliminates the need to hard-code the name of a fixed-width font, which might not display text properly on systems that do not use ASCII character encoding. The 'FixedWidth' value relies on the root FixedWidthFontName property. Setting the root FixedWidthFontName property causes an immediate update of the display to use the new font.

Example: 'Cambria'

'Color' — Text color[0.15 0.15 0.15] (default) | RGB triplet | color string | 'none'

Text color, specified as a three-element RGB triplet, a color string, or 'none'. If you set the color to 'none', then the text is invisible.

An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range [0,1], for example, [0.4 0.6 0.7]. This table lists RGB triplet values that have equivalent color strings.

Long NameShort NameRGB Triplet
'yellow''y'[1 1 0]
'magenta''m'[1 0 1]
'cyan''c'[0 1 1]
'red''r'[1 0 0]
'green''g'[0 1 0]
'blue''b'[0 0 1]
'white''w'[1 1 1]
'black'k'[0 0 0]

Example: 'blue'

Example: [0 0 1]

'Interpreter' — Interpretation of text characters'tex' (default) | 'latex' | 'none'

Interpretation of text characters, specified as one of these values:

  • 'tex' — Interpret text strings using a subset of TeX markup. This is the default value.

  • 'latex' — Interpret text strings using LaTeX markup.

  • 'none' — Display literal characters.

TeX Markup

By default, MATLAB supports a subset of TeX markup. Use TeX markup to add superscripts and subscripts, modify the text type and color, and include special characters in the text string.

This table lists the supported modifiers when the Interpreter property is set to 'tex'. Modifiers remain in effect until the end of the string, except for superscripts and subscripts, which only modify the next character or the text within the curly braces {}.

ModifierDescriptionExample of String
^{ }Superscript'text^{superscript}'
_{ }Subscript'text_{subscript}'
\bfBold font'\bf text'
\itItalic font'\it text'
\slOblique font (usually the same as italic font)'\sl text'
\rmNormal font'\rm text'
\fontname{specifier}Font name — Set specifier as the name of a font family. You can use this in combination with other modifiers.'\fontname{Courier} text'
\fontsize{specifier}Font size — Set specifier as a numeric scalar value to change the font size.'\fontsize{15} text'
\color{specifier}Font color — Set specifer as one of these colors: red, green, yellow, magenta, blue, black, white, gray, darkGreen, orange, or lightBlue.'\color{magenta} text'
\color[rgb]{specifier}Custom font color — Set specifier as a three-element RGB triplet.'\color[rgb]{0,0.5,0.5} text'

This table lists the supported special characters when the interpreter is set to 'tex'.

Character SequenceSymbolCharacter SequenceSymbolCharacter SequenceSymbol

\alpha

α

\upsilon

υ

\sim

~

\angle

\phi

Φ

\leq

\ast

*

\chi

χ

\infty

\beta

β

\psi

ψ

\clubsuit

\gamma

γ

\omega

ω

\diamondsuit

\delta

δ

\Gamma

Γ

\heartsuit

\epsilon

ɛ

\Delta

Δ

\spadesuit

\zeta

ζ

\Theta

Θ

\leftrightarrow

\eta

η

\Lambda

Λ

\leftarrow

\theta

Θ

\Xi

Ξ

\Leftarrow

\vartheta

ϑ

\Pi

Π

\uparrow

\iota

ι

\Sigma

Σ

\rightarrow

\kappa

κ

\Upsilon

ϒ

\Rightarrow

\lambda

λ

\Phi

Φ

\downarrow

\mu

µ

\Psi

Ψ

\circ

º

\nu

ν

\Omega

Ω

\pm

±

\xi

ξ

\forall

\geq

\pi

π

\exists

\propto

\rho

ρ

\ni

\partial

\sigma

σ

\cong

\bullet

\varsigma

ς

\approx

\div

÷

\tau

τ

\Re

\neq

\equiv

\oplus

\aleph

\Im

\cup

\wp

\otimes

\subseteq

\oslash

\cap

\in

\supseteq

\supset

\lceil

\subset

\int

\cdot

·

\o

ο

\rfloor

\neg

¬

\nabla

\lfloor

\times

x

\ldots

...

\perp

\surd

\prime

´

\wedge

\varpi

ϖ

\0

\rceil

\rangle

\mid

|

\vee

\langle

\copyright

©

LaTeX Markup

To use LaTeX markup, set the Interpreter property to 'latex'. The displayed text uses the default LaTeX font style. The FontName, FontWeight, and FontAngle properties do not have an effect. To change the font style, use LaTeX markup within the text string.

The maximum size of the string that you can use with the LaTeX interpreter is 1200 characters. For multiline strings, this reduces by about 10 characters per line.

For more information about the LaTeX system, see The LaTeX Project Web site at http://www.latex-project.org/.

Output Arguments

expand all

h — Text objecttext object

Text object used as the y-axis label. Use h to access and modify properties of the label after its created.

See Also

Functions

Properties

Was this topic helpful?