matlab.display.DisplayConfiguration class

Package: matlab.display

Describe display environment and settings

Since R2021b

Description

The matlab.display.DisplayConfiguration class provides the environmental information required to build the compact display representation of an object array. When an object array must be displayed in a limited amount of space, such as when it is held within a structure, cell array, or table, MATLAB^® provides a DisplayConfiguration object to communicate the current display context.

The container displaying the object array instantiates this class, so you are not required to create an object of the class directly.

Class Attributes

Sealed

true

For information on class attributes, see Class Attributes.

Properties

Ellipsis — Ellipsis symbol

string scalar

Ellipsis symbol representing a portion of the data in an object array, specified as a string scalar. If you start MATLAB normally without the -nodesktop option, the default property value corresponds to the Unicode^® code value of 8230 (that is, string(char(8230)). Otherwise, the default value is "...".

Attributes:

GetAccess	public
SetAccess	public

AnnotationDelimiters — Delimiters used to wrap annotation

["(" ")"]

Delimiters used to wrap the annotation, specified as the string array ["(" ")"].

Attributes:

GetAccess	public
Constant	true
NonCopyable	true

AnnotationPadding — Padding placed before annotation

"  "

Padding placed before the annotation to separate it from its preceding text, specified as a string scalar composed of two whitespace characters.

Attributes:

GetAccess	public
Constant	true
NonCopyable	true

DefaultPadSize — Default number of spaces between elements of plain-text representation

4

Default number of spaces between the elements of an object array's plain-text representation, specified as the numeric value 4.

Attributes:

GetAccess	public
Constant	true
NonCopyable	true

DefaultPaddingSizeBetweenDimensionsAndClassName — Default number of spaces between array dimensions and class name

1

Default number of spaces between the array dimensions and class name, specified as the numeric value 1.

Attributes:

GetAccess	public
Constant	true
NonCopyable	true

InterElementDelimiter — Inter-element delimiter

string scalar composed of whitespace characters

Inter-element delimiter used to separate the elements of an object array's plain-text representation, specified as a string scalar composed of whitespace characters. The number of whitespace characters in the string is equal to DefaultPadSize.

Attributes:

GetAccess	public
Constant	true
NonCopyable	true

PaddingBetweenDimensionsAndClassName — Padding used to separate array dimensions and class name

string scalar composed of whitespace characters

Padding used to separate the array dimensions and class name, specified as a string scalar composed of whitespace characters. The number of whitespace characters in the string is equal to DefaultPaddingSizeBetweenDimensionsAndClassName.

Attributes:

GetAccess	public
Constant	true
NonCopyable	true

Methods

Public Methods

characterWidthForStringArray

width = characterWidthForStringArray(displayConfiguration,str) Return the character width for each element of the string array str. Use this method to make sure that the textual representation of an object array fits within the space provided by the container that must display the array. Input Arguments displayConfiguration — Description of the current display context, specified as a matlab.display.DisplayConfiguration object. str — Input text, specified as a string array. Output Arguments width — Character width corresponding to each element of str, returned as a numeric array.

Version History

Introduced in R2021b