Documentation

ylabel

Label y-axis

Syntax

ylabel(txt)
ylabel(target,txt)
ylabel(___,Name,Value)
t = ylabel(___)

Description

example

ylabel(txt)labels they-axis of the current axes or chart returned by thegcacommand. Reissuing theylabelcommand causes the new label to replace the old label.

ylabel(target,txt)adds the label to the axes or chart specified bytarget.

example

ylabel(___,Name,Value)modifies the label appearance using one or more name-value pair arguments. For example,'FontSize',12sets the font size to 12 points. Specify name-value pair arguments after all other input arguments. Modifying the label appearance is not supported for all types of charts.

t= ylabel(___)returns the text object used as they-axis label. Usetto make future modifications to the label after it is created.

Examples

collapse all

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

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

MATLAB® displays123beside they-axis.

Create a multiline label using a multiline cell array.

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

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')

UseName,Valuepairs to set the font size, font weight, and text color properties of they-axis label.

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

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

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

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

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

ylabel(s(1),'Population')

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

plot((1:10).^2) t = ylabel('Population');

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

t.Color ='red';

Input Arguments

collapse all

Axis label, specified as a character array, cell array, or numeric value.

Example:'my label'

Example:{'first line','second line'}

Example:123

To include numeric variables with text in a label, use thenum2strfunction. For example:

x = 42; txt = [“值”,num2str(x)];

To include special characters, such as superscripts, subscripts, Greek letters, or mathematical symbols use TeX markup. For a list of supported markup, see theInterpreterproperty.

To create multiline labels:

  • Use a cell array, where each cell contains a line of text, such as{'first line','second line'}.

  • Use a character array, where each row contains the same number of characters, such as['abc'; 'ab '].

  • Usesprintfto create text with a new line character, such assprintf('first line \n second line').

Numeric labels are converted to text usingsprintf('%g',value). For example,12345678displays as1.23457e+07.

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

Target for label, specified as anAxesobject or a graphics object that has aYLabelproperty. For example, you can add ay-axis label to aHeatmapChartobject.

If you do not specify the target, then theylabelfunction adds the label to the graphics object returned by thegcacommand.

    Note:Some charts do not support modifying the label appearance, such as the color, or returning the text object as an output argument.

Name-Value Pair Arguments

Specify optional comma-separated pairs ofName,Valuearguments.Nameis the argument name andValueis the corresponding value.Namemust appear inside single quotes (' ').您可以指定名称和值对几个参数uments in any order asName1,Value1,...,NameN,ValueN.

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

除了以下,哟u can specify other text object properties usingName,Valuepair arguments. SeeText Properties.

collapse all

Font size, specified as a scalar value greater than0in point units. One point equals 1/72 inch. To change the font units, use theFontUnitsproperty.

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. TheFontSizeproperty of the axes contains the axes font size. TheLabelFontSizeMultiplierproperty 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 they-axis label font size is 11 points.

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

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

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

  • 'bold'— Thicker character outlines than normal

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

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

Font name, specified as the name of the font to use or'FixedWidth'. To display and print properly, the font name must be a font that your system supports. The default font depends on the specific operating system and locale.

To use a fixed-width font that looks good in any locale, use'FixedWidth'. The'FixedWidth'value relies on the rootFixedWidthFontNameproperty. Setting the rootFixedWidthFontNameproperty causes an immediate update of the display to use the new font.

Example:'Cambria'

Text color, specified as a three-element RGB triplet, a character vector of color name, 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 the long and short color name options and the equivalent RGB triplet values.

Long Name Short Name RGB 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]

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

  • 'tex'— Interpret characters using a subset of TeX markup.

  • 'latex'— Interpret characters 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 font type and color, and include special characters in the text.

This table lists the supported modifiers with theInterpreterproperty set to'tex'. Modifiers remain in effect until the end of the text. Superscripts and subscripts are an exception because they only modify the next character or the characters within the curly braces.

Modifier Description Example
^{ } Superscript 'text^{superscript}'
_{ } Subscript 'text_{subscript}'
\bf Bold font '\bf text'
\it Italic font '\it text'
\sl Oblique font (usually the same as italic font) '\sl text'
\rm Normal font '\rm text'
\fontname{specifier} Font name — Setspecifieras the name of a font family. You can use this in combination with other modifiers. '\fontname{Courier} text'
\fontsize{specifier} Font size — Setspecifieras a numeric scalar value in point units to change the font size. '\fontsize{15} text'
\color{specifier} Font color — Setspeciferas one of these colors:red,green,yellow,magenta,blue,black,white,gray,darkGreen,orange, orlightBlue. '\color{magenta} text'
\color[rgb]{specifier} Custom font color — Setspecifieras a three-element RGB triplet. '\color[rgb]{0,0.5,0.5} text'

This table lists the supported special characters with theInterpreterproperty set to'tex'.

Character Sequence Symbol Character Sequence Symbol Character Sequence Symbol

\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 theInterpreterproperty to'latex'. Use dollar symbols around the text, for example, use'$\int_1^{20} x^2 dx$'for inline mode or'$$\int_1^{20} x^2 dx$$'for display mode.

The displayed text uses the default LaTeX font style. TheFontName,FontWeight, andFontAngleproperties do not have an effect. To change the font style, use LaTeX markup.

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

For more information about the LaTeX system, see The LaTeX Project website athttp://www.latex-project.org/.

Output Arguments

collapse all

Text object used as they-axis label. Usetto access and modify properties of the label after its created.

Introduced before R2006a

Was this topic helpful?