ztickformat

Specify z-axis tick label format

Syntax

ztickformat(fmt)

ztickformat(datefmt)

ztickformat(durationfmt)

ztickformat(ax,___)

zfmt = ztickformat

zfmt = ztickformat(ax)

Description

ztickformat(fmt) sets the format for numeric z-axis tick labels. For example, specify fmt as 'usd' to display the labels in U.S. dollars.

ztickformat(datefmt) sets the format for labels that show dates or times. For example, specify datefmt as 'MM-dd-yy' to display dates such as 04-19-16. This option applies only to a z-axis with datetime values.

ztickformat(durationfmt) sets the format for labels that show durations. For example, specify durationfmt as 'm' to display the durations in minutes. This option applies only to a z-axis with duration values.

ztickformat(ax,___) uses the axes specified by ax instead of the current axes. Specify ax as the first input argument.

zfmt = ztickformat returns the format style used for z-axis tick labels of the current axes. Depending on the type of labels along the z-axis, zfmt is a character vector of a numeric format, date format, or duration format.

zfmt = ztickformat(ax) returns the format style used for the axes specified by ax instead of the current axes.

Examples

Display Tick Labels in Dollars

Create a 3-D stem chart of random data. Display the tick labels along the z-axis in US dollars.

z = 10*rand(5);
stem3(z)
ztickformat('usd')

Query the tick label format. MATLAB® returns the format as a character vector containing the formatting operators.

fmt = ztickformat

fmt = 
'$%,.2f'

Display the tick labels with no decimal values by tweaking the numeric format to use a precision value of 0 instead of 2.

ztickformat('$%,.0f')

Display Text After Each Tick Label

Create a 3-D line chart. Display the tick labels along the z-axis with the text "cm" after each value.

t = 0:pi/10:10*pi;
st = sin(t);
ct = cos(t);
plot3(st,ct,t)
grid on
ztickformat('%g cm')

Control Number of Decimals Displayed

Create a 3-D scatter plot of random data. Display the z-axis tick labels with two decimal places. Control the decimal places by passing ztickformat a character vector of a numeric format that uses fixed-point notation for the conversion character and a precision value of 2.

x = rand(50,1);
y = rand(50,1);
z = rand(50,1);
scatter3(x,y,z)
ztickformat('%.2f')

Tick Label Format for Specific Axes

Starting in R2019b, you can display a tiling of plots using the tiledlayout and nexttile functions. Call the tiledlayout function to create a 1-by-2 tiled chart layout. Call the nexttile function to create the axes objects ax1 and ax2. Create two 3-D stem plots, and specify the tick label format for the z-axis of the left plot by specifying ax1 as the first input argument to ztickformat. Display the tick labels in U.S. dollars.

tiledlayout(1,2)
ax1 = nexttile;
stem3(ax1,4*rand(5))
ztickformat(ax1,'usd')

ax2 = nexttile;
stem3(ax2,4*rand(5))

Input Arguments

fmt — Format for numeric tick labels

'%g' (default) | character vector | string

Format for numeric tick labels, specified as a character vector or string. You can specify one of the formats listed in this table. Alternatively, you can specify a custom format.

Predefined Format	Description
'usd'	U.S. dollars. This option is equivalent using '$%,.2f'. If the labels use scientific notation, this option sets the exponent value to 0.
'eur'	Euro. This option is equivalent to using '\x20AC%,.2f' with an exponent value of 0.
'gbp'	British pound. This option is equivalent to using '\x00A3%,.2f' with an exponent value of 0.
'jpy'	Japanese yen. This option is equivalent to using '\x00A5%,d' with an exponent value of 0.
'degrees'	Display degree symbol after values. This option is equivalent to using '%g\x00B0' with the default exponent value.
'percentage'	Display percent sign after values. This option is equivalent to using '%g%%' with the default exponent value.
'auto'	Default format of '%g' with the default exponent value.

Example: ztickformat('usd')

Custom Numeric Format

You can specify a custom numeric format by creating a character vector or string containing identifiers.

Identifiers are optional, except the percent sign and conversion character. Construct the format in this order:

• One or more flags — Options such as adding a plus sign before positive values. For a full list of options, see the table of Optional Flags.

• Field width — Minimum number of characters to print in the tick label. Specify the field width as an integer value. If the number of significant digits in the tick value is smaller than the field width, then the label is padded with spaces.

• Precision — Number of digits to the right of the decimal point or the number of significant digits, depending on the conversion character. Specify the precision as an integer value.

• Conversion character — Value type. For a full list of options, see the table of Conversion Characters. If you specify a conversion that does not fit the data, then MATLAB^® overrides the specified conversion, and uses %e.

Also, you can specify literal text at the beginning or end of the format. To print a single quotation mark, use ''. To print a percent character, use %%.

Example: ztickformat('%.2f') displays the values using fixed-point notation with two decimal places.

Example: ztickformat('$%.2f') displays a dollar sign before each value.

Example: ztickformat('%.2f million') displays million after each value.

Optional Flags

Identifier	Description	Example of Numeric Format
,	Display commas every three digits, such as '1,000'.	'%,4.4g'
+	Print the sign character (+) for positive values, such as '+100'.	'%+4.4g'
0	Pad the field width with leading zeros instead of spaces, such as '0100'.	'%04.4g'
–	Left-justify, which pads the end of the value with spaces instead of the beginning. For example, if the field width is 4, then this flag formats the label as '100 ' instead of ' 100'.	'%-4.4g'
#	For the %f, %e, and %g conversion characters, print the decimal point even when the precision is 0, such as '100.'. For %g, do not remove trailing zeros.	'%#4.4g'

Conversion Characters

Identifier	Description	Example
d or i	Signed integer with base 10. The precision value indicates the number of significant digits.	'%.4d' displays π as 0003.
f	Fixed-point notation. The precision value indicates the number of decimal places.	'%.4f' displays π as 3.1416.
e	Exponential notation. The precision value indicates the number of decimal places.	'%.4e' displays π as 3.1416x100.
g	The more compact version of e or f, with no trailing zeros. The precision value indicates the maximum number of decimal places.	'%.4g' displays π as 3.1416.

datefmt — Format for dates and times

'auto' | character vector | string

Format for dates and times, specified as 'auto', a character vector, or a string. The default format is based on the data.

Example: ztickformat('yyyy-MM-dd') displays a date and time such as 2016-04-19.

Example: ztickformat('eeee, MMMM d, yyyy HH:mm:ss') displays a date and time such as Saturday, April 19, 2016 21:41:06.

Example: ztickformat('MMMM d, yyyy HH:mm:ss Z') displays a date and time such as April 19, 2016 21:41:06 -0400.

The display format tables show the letter identifiers that you can use to construct the format. To separate the fields, you can include nonletter characters such as a hyphen, space, colon, or any non-ASCII characters. The identifiers correspond to the Unicode^® Locale Data Markup Language (LDML) standard for dates.

Date and Time Formats

Use these identifiers to specify the display formats of the date and time fields.

Letter Identifier	Description	Display
G	Era	CE
y	Year, with no leading zeros. See the Note that follows this table.	2014
yy	Year, using last two digits. See the Note that follows this table.	14
yyy, yyyy ...	Year, using at least the number of digits specified by the number of instances of 'y'	For the year 2014, 'yyy' displays 2014, while 'yyyyy' displays 02014.
u, uu, ...	ISO year. A single number designating the year. An ISO year value assigns positive values to CE years and negative values to BCE years, with 1 BCE being year 0.	2014
Q	Quarter, using one digit	2
QQ	Quarter, using two digits	02
QQQ	Quarter, abbreviated	Q2
QQQQ	Quarter, full name	2nd quarter
M	Month, numerical using one or two digits	4
MM	Month, numerical using two digits	04
MMM	Month, abbreviated name	Apr
MMMM	Month, full name	April
MMMMM	Month, capitalized first letter	A
W	Week of the month	1
d	Day of the month, using one or two digits	5
dd	Day of the month using two digits	05
D	Day of the year, using one, two or three digits	95
DD	Day of the year using two digits	95
DDD	Day of the year using three digits	095
e	Day of the week, numerical using one or two digits.	7, where Sunday is the first day of the week.
ee	Day of the week, numerical using two digits	07
eee	Day, abbreviated name	Sat
eeee	Day, full name	Saturday
eeeee	Day, capitalized first letter	S
a	Day period (AM or PM)	PM
h	Hour, 12-hour clock notation using one or two digits	9
hh	Hour, 12-hour clock notation using two digits	09
H	Hour, 24-hour clock notation using one or two digits	21
HH	Hour, 24-hour clock notation using two digits	21
m	Minute, using one or two digits	41
mm	Minute, using two digits	41
s	Second, using one or two digits	6
ss	Second, using two digits	06
S, SS, ..., SSSSSSSSS	Fractional second, using the number of digits specified by the number of instances of 'S' (up to 9 digits).	'SSS' truncates 6.12345 seconds to 123.

Some tips and considerations:

• Use one or more u characters instead of y characters to represent the year when working with year numbers near zero.

• Datetime values later than 144683 years CE or before 140743 BCE display only the year numbers, regardless of the specified format value.

Time Zone Offset Formats

Use these identifiers to specify the display format of the time zone offset. A time zone offset is the amount of time that a specific date and time is offset from UTC. A time zone offset is different from a time zone in that it comprises rules that determine the offsets for specific times of the year. Include a time zone offset identifier when you want to ensure that the time components are displayed unambiguously.

Letter Identifier	Description	Display
z	Abbreviated name of the time zone offset. If this value is not available, then the time zone offset uses the short UTC format, such as UTC-4.	EDT
Z	ISO 8601 basic format with hours, minutes, and optional seconds fields.	-0400
ZZZZ	Long UTC format.	UTC-04:00
ZZZZZ	ISO 8601 extended format with hours, minutes, and optional seconds fields. A time offset of zero is displayed as the ISO 8601 UTC indicator “Z”.	-04:00
x or X	ISO 8601 basic format with hours field and optional minutes field. If you specify X, a time offset of zero is displayed as the ISO 8601 UTC indicator “Z”.	-04
xx or XX	ISO 8601 basic format with hours and minutes fields. If you specify XX, a time offset of zero is displayed as the ISO 8601 UTC indicator “Z”.	-0400
xxx or XXX	ISO 8601 extended format with hours and minutes fields. If you specify XXX, a time offset of zero is displayed as the ISO 8601 UTC indicator “Z”.	-04:00
xxxx or XXXX	ISO 8601 basic format with hours, minutes, and optional seconds fields. If you specify XXXX, a time offset of zero is displayed as the ISO 8601 UTC indicator “Z”.	-0400
xxxxx or XXXXX	ISO 8601 extended format with hours, minutes, and optional seconds fields. If you specify XXXXX, a time offset of zero is displayed as the ISO 8601 UTC indicator “Z”.	-04:00

durationfmt — Format for duration values

character vector | string

Format for duration values, specified as a character vector or string.

To display a duration as a single number that includes a fractional part (for example, 1.234 hours), specify one of the following formats.

Format	Description
'y'	Number of exact, fixed-length years. A fixed-length year is equal to 365.2425 days.
'd'	Number of exact, fixed-length days. A fixed-length day is equal to 24 hours.
'h'	Number of hours
'm'	Number of minutes
's'	Number of seconds

To display a duration in the form of a digital timer, specify one of these formats:

• 'dd:hh:mm:ss'

• 'hh:mm:ss'

• 'mm:ss'

• 'hh:mm'

In addition, you can display up to nine fractional second digits by appending up to nine S characters. For example, 'hh:mm:ss.SSS' displays the milliseconds of a duration value to three digits.

ax — Target axes

current axes (default) | single Axes object | vector of Axes objects

Target axes, specified as a single Axes object or a vector of Axes objects. If you do not specify the axes, then ztickformat uses the current axes.

Algorithms

The ztickformat function sets and queries the TickLabelFormat property of the ruler object associated with the z-axis.