setLabelTextFormatter

R2026b

Set format used to display text label of Distance tool

setLabelTextFormatter is not recommended. Use one of the ROI classes instead, described in Choose Approach to Annotate ROIs in Images.

Syntax

setLabelTextFormatter(h,str)

Description

setLabelTextFormatter(h,str) sets the format used to display the label text of the Distance tool, h.

Examples

Format Label of Distance Tool

Display an image and create a Distance tool.

imshow("pout.tif")
hline = imdistline(gca,[71 171],[108 150]);

Modify the format of the label to indicate that distance is measured in pixels.

setLabelTextFormatter(hline,"%02.0f pixels");

Input Arguments

h — Distance tool

imdistline object

Distance tool, specified as an imdistline object.

str — Text format

string scalar | character vector

Text format of Distance tool label, specified as a string scalar or character vector in a format expected by sprintf.

Version History

Introduced before R2006a