root object (MATLAB Function Reference)

Root object properties

Description

The root is a graphics object that corresponds to the computer screen. There is only one root object and it has no parent. The children of the root object are figures.

The root object exists when you start MATLAB; you never have to create it and you cannot destroy it. Use set and get to access the root properties.

See Also

diary, echo, figure, format, gcf, get, set

Object Hierarchy

Property List

The following table lists all root properties and provides a brief description of each. The property name links take you to an expanded description of the properties. This table does not include properties that are defined for, but not used by, the root object.

Property Name
Property Description
Property Value

Information about MATLAB's state

CallbackObject
Handle of object whose callback is executing
Values: object handle

CurrentFigure
Handle of current figure
Values: object handle

ErrorMessage
Text of last error message
Value: character string

PointerLocation
Current location of pointer
Values: x-, and y-coordinates

PointerWindow
Handle of window containing the pointer
Values: figure handle

ShowHiddenHandles
Show or hide handles marked as hidden
Values: on, off
Default: off

Controlling MATLAB's behavior

Diary
Enable the diary file
Values: on, off
Default: off

DiaryFile
Name of the diary file
Values: filename (string)
Default: diary

Echo
Display each line of script M-file as executed
Values: on, off
Default: off

Format
Format used to display numbers
Values: short, shortE, long, longE, bank, hex, +, rat
Default: shortE

FormatSpacing
Display or omit extra line feed
Values: compact, loose
Default: loose

Language
System environment setting
Values: string
Default: english

RecursionLimit
Maximum number of nested M-file calls
Values: integer
Defalut: 2.1478e+009

Units
Units for PointerLocation and ScreenSize properties
Values: pixels, normalized, inches, centimeters, points, characters
Default: pixels

Information about the display

FixedWidthFontName
Value for axes, text, and uicontrol FontName property
Values: font name
Default: Courier

ScreenDepth
Depth of the display bitmap
Values: bits per pixel

ScreenSize
Size of the screen
Values: [left, bottom, width, height]

General Information About Root Objects

Children
Handles of all nonhidden Figue objects
Values: vector of handles

Parent
The root object has no parent
Value: [] (empty matrix)

Selected
This property is not used by the root object.

Tag
User-specified label
Value: any string
Default: '' (empty string)

Type
The type of graphics object (read only)
Value: the string 'root'

UserData
User-specified data
Values: any matrix
Default: [] (empty matrix)

Property Name	Property Description	Property Value
Information about MATLAB's state
`CallbackObject`	Handle of object whose callback is executing	Values: object handle
`CurrentFigure`	Handle of current figure	Values: object handle
`ErrorMessage`	Text of last error message	Value: character string
`PointerLocation`	Current location of pointer	Values: x-, and y-coordinates
`PointerWindow`	Handle of window containing the pointer	Values: figure handle
`ShowHiddenHandles`	Show or hide handles marked as hidden	Values: `on`, `off` Default: `off`
Controlling MATLAB's behavior
`Diary`	Enable the diary file	Values: `on`, `off` Default: `off`
`DiaryFile`	Name of the diary file	Values: filename (string) Default: `diary`
`Echo`	Display each line of script M-file as executed	Values: `on`, `off` Default: `off`
`Format`	Format used to display numbers	Values: `short`, `shortE`, `long`, `longE`, `bank`, `hex`, `+`, `rat` Default: `shortE`
`FormatSpacing`	Display or omit extra line feed	Values: `compact`, `loose` Default: `loose`
`Language`	System environment setting	Values: string Default: `english`
`RecursionLimit`	Maximum number of nested M-file calls	Values: integer Defalut: `2.1478e+009`
`Units`	Units for `PointerLocation` and `ScreenSize` properties	Values: `pixels, normalized`, `inches`, `centimeters`, `points`, `characters` Default: `pixels`
Information about the display
`FixedWidthFontName`	Value for axes, text, and uicontrol `FontName` property	Values: font name Default: Courier
`ScreenDepth`	Depth of the display bitmap	Values: bits per pixel
`ScreenSize`	Size of the screen	Values: [left, bottom, width, height]
General Information About Root Objects
`Children`	Handles of all nonhidden Figue objects	Values: vector of handles
`Parent`	The root object has no parent	Value: `[]` (empty matrix)
`Selected`	This property is not used by the root object.
`Tag`	User-specified label	Value: any string Default: `''` (empty string)
`Type`	The type of graphics object (read only)	Value: the string `'root'`
`UserData`	User-specified data	Values: any matrix Default: `[]` (empty matrix)

rmpath Root Properties