figure properties
figure graphics object properties.
📄Description

This page documents the visible properties returned by properties for a figure graphics object.

Property Action Type and supported values
Alphamap updates rendered output on the next graphics refresh. Type: finite numeric vector. Supported values: numeric alpha values in [0,1].
AutoResizeChildren updates rendered output on the next graphics refresh. Type: on/off value. Supported values: 'on', 'off', true, or false.
BeingDeleted Nelson computes this value; graphics operations update it. Type: text scalar or character row vector. Supported values: 'off', 'on'.
BusyAction controls whether an interrupting callback is queued or canceled. Type: text scalar or character row vector. Supported values: 'queue', 'cancel'.
ButtonDownFcn runs when the object receives a mouse-button event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
Children parenting operations update the vector. Type: graphics object handle vector. Supported values: empty vector or child handles.
Clipping updates rendered output on the next graphics refresh. Type: text scalar or character row vector. Supported values: 'on', 'off'.
CloseRequestFcn the graphics event system invokes it for the associated event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
Color background color of the figure. Default: light gray [0.94 0.94 0.94] (light theme). Exports (saveas) use a white background instead while InvertHardcopy is 'on'. Type: color value. Supported values: 'red'/'r', 'green'/'g', 'blue'/'b', 'cyan'/'c', 'magenta'/'m', 'yellow'/'y', 'black'/'k', 'white'/'w', RGB triplet [r g b] with values in [0,1], or hexadecimal color '#RRGGBB'/'#RGB'.
Colormap updates rendered output on the next graphics refresh. Type: finite numeric matrix. Supported values: m-by-3 RGB matrix with values in [0,1].
ContextMenu attaches the menu used for context-click actions. Type: graphics object handle scalar. Supported values: [] or a uicontextmenu handle.
CreateFcn runs when the object is created. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
CurrentAxes changes the figure target used by plotting commands that operate on the current axes. Type: axes graphics handle. Supported values: an axes or polar axes child of the figure, or an empty graphics handle.
CurrentCharacter reports keyboard input state for the current figure. Type: single-character text value. Supported values: character row vector or string scalar containing the most recent character, or empty text.
CurrentObject reports the object currently targeted by figure interaction. Type: graphics handle. Supported values: child object handle under the pointer or current interaction target, or empty graphics handle.
CurrentPoint position of the last mouse press or release in the figure, and of the pointer motion while WindowButtonMotionFcn is set. Updated before WindowButtonDownFcn, WindowButtonMotionFcn, WindowButtonUpFcn and ButtonDownFcn run. Type: two-element vector [x y]. Supported values: coordinates in the figure Units from the bottom-left corner of the drawing area (pixels by default, logical pixels on scaled displays).
DeleteFcn runs when the object is deleted. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
DevicePixelRatio recomputes geometry, limits, or layout. Type: finite numeric scalar. Supported values: finite scalar value.
DockControls updates rendered output on the next graphics refresh. Type: on/off value. Supported values: 'on', 'off', true, or false.
DrawLater updates rendered output on the next graphics refresh. Type: on/off value. Supported values: 'on', 'off', true, or false.
FileName stores the file path associated with a persisted or loaded figure. Type: text value. Supported values: character row vector, string scalar, or empty text.
GraphicsSmoothing updates rendered output on the next graphics refresh. Type: on/off value. Supported values: 'on', 'off', true, or false.
HandleVisibility controls whether handle-search functions can find the object. Type: text scalar or character row vector. Supported values: 'on', 'off', 'callback'.
Icon updates rendered output on the next graphics refresh. Type: text scalar, image array, or empty array. Supported values: [] , image path, or image data.
InnerPosition recomputes geometry, limits, or layout. Type: finite numeric vector. Supported values: finite vector with the documented size, such as [left bottom width height], [x y z], [azimuth elevation], or [minor major].
IntegerHandle updates the stored object state. Type: integer scalar or numeric vector. Supported values: finite integer value, finite numeric value, or vector required by the property.
Interruptible controls whether a running callback can be interrupted. Type: text scalar or character row vector. Supported values: 'on', 'off'.
InvertHardcopy 'on' (default): saveas exports the figure with a white background whatever its Color. 'off': the export keeps the on-screen figure Color. Type: on/off value. Supported values: 'on', 'off', true, or false.
KeyPressFcn the graphics event system invokes it for the associated event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
KeyReleaseFcn the graphics event system invokes it for the associated event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
MenuBar updates rendered output on the next graphics refresh. Type: text scalar or character row vector. Supported values: 'none', 'figure', 'auto'.
Name updates the object name displayed by windows, managers, or object inspection. Type: text value. Supported values: character row vector, string scalar, or empty text.
NextPlot selects how the next plotting command reuses or resets existing children. Type: text scalar or character row vector. Supported values: 'add', 'replace', 'replacechildren', 'replaceall', 'new'.
Number updates the stored object state. Type: integer scalar or numeric vector. Supported values: finite integer value, finite numeric value, or vector required by the property.
NumberTitle updates rendered output on the next graphics refresh. Type: on/off value. Supported values: 'on', 'off', true, or false.
OuterPosition recomputes geometry, limits, or layout. Type: finite numeric vector. Supported values: finite vector with the documented size, such as [left bottom width height], [x y z], [azimuth elevation], or [minor major].
PaperOrientation recomputes geometry, limits, or layout. Type: text scalar or character row vector. Supported values: 'vertical', 'horizontal'.
PaperPosition recomputes geometry, limits, or layout. Type: finite numeric vector. Supported values: finite vector with the documented size, such as [left bottom width height], [x y z], [azimuth elevation], or [minor major].
PaperPositionMode 'auto' lets Nelson recompute the paired property; 'manual' preserves the assigned value. Type: text scalar or character row vector. Supported values: 'auto', 'manual'.
PaperSize recomputes geometry, limits, or layout. Type: finite numeric vector. Supported values: finite vector with the documented size, such as [left bottom width height], [x y z], [azimuth elevation], or [minor major].
PaperType recomputes geometry, limits, or layout. Type: text scalar or character row vector. Supported values: 'usletter', 'a4', 'a3', 'a5', 'b4', 'b5', 'tabloid', or 'legal'.
PaperUnits recomputes geometry, limits, or layout. Type: text scalar or character row vector. Supported values: 'pixels', 'normalized', 'inches', 'centimeters', 'points', 'characters', 'data'.
Parent reparents the object and updates Children on the old and new parents. Type: graphics object handle scalar. Supported values: a valid parent handle for the object class.
Pointer updates rendered output on the next graphics refresh. Type: text scalar or character row vector. Supported values: 'arrow', 'crosshair', 'ibeam', 'watch', 'topl', 'topr', 'botl', 'botr', 'circle', 'cross', 'fleur', 'left', 'right', 'top', 'bottom', 'custom'.
PointerShapeCData replaces data and recomputes automatic limits that depend on it. Type: numeric, logical, categorical, string, vector, matrix, or table-derived data. Supported values: [] or data with dimensions compatible with the rendered object.
PointerShapeHotSpot recomputes geometry, limits, or layout. Type: finite numeric vector. Supported values: finite vector with the documented size, such as [left bottom width height], [x y z], [azimuth elevation], or [minor major].
Position recomputes geometry, limits, or layout. Type: finite numeric vector. Supported values: finite vector with the documented size, such as [left bottom width height], [x y z], [azimuth elevation], or [minor major].
Renderer updates rendered output on the next graphics refresh. Type: text scalar or character row vector. Supported values: 'opengl', 'painters'.
RendererMode 'auto' lets Nelson recompute the paired property; 'manual' preserves the assigned value. Type: text scalar or character row vector. Supported values: 'auto', 'manual'.
Resize updates rendered output on the next graphics refresh. Type: on/off value. Supported values: 'on', 'off', true, or false.
Scrollable updates rendered output on the next graphics refresh. Type: on/off value. Supported values: 'on', 'off', true, or false.
SelectionType Nelson computes this value; graphics operations update it. Type: text scalar or character row vector. Supported values: 'normal', 'extend', 'alt', 'open'.
SizeChangedFcn the graphics event system invokes it for the associated event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
Tag updates the stored object state. Type: text scalar or character row vector. Supported values: empty text or an object identifier.
Theme returns the active graphics theme object; assigning 'light' or 'dark' updates rendered output on the next graphics refresh. Type: graphics theme object for reads, text scalar or character row vector for writes. Supported assigned values: 'light', 'dark'.
ThemeChangedFcn the graphics event system invokes it for the associated event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
ThemeMode 'auto' lets Nelson recompute the paired property; 'manual' preserves the assigned value. Type: text scalar or character row vector. Supported values: 'auto', 'manual'.
ToolBar updates rendered output on the next graphics refresh. Type: text scalar or character row vector. Supported values: 'none', 'figure', 'auto'.
Type Nelson computes this value; graphics operations update it. Type: text scalar or character row vector. Supported values: read-only object type name, for example 'figure', 'axes', 'line', or 'scatter'.
Units recomputes geometry, limits, or layout. Type: text scalar or character row vector. Supported values: 'pixels', 'normalized', 'inches', 'centimeters', 'points', 'characters', 'data'.
UserData updates the stored object state. Type: Nelson array. Supported values: any Nelson value, including [], numeric arrays, text, cells, structures, or handles.
Visible updates rendered output on the next graphics refresh. Type: text scalar or character row vector. Supported values: 'on', 'off'.
WindowButtonDownFcn the graphics event system invokes it for the associated event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
WindowButtonMotionFcn the graphics event system invokes it for the associated event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
WindowButtonUpFcn the graphics event system invokes it for the associated event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
WindowKeyPressFcn the graphics event system invokes it for the associated event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
WindowKeyReleaseFcn the graphics event system invokes it for the associated event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
WindowScrollWheelFcn the graphics event system invokes it for the associated event. Type: callback value. Supported values: [], function handle, character vector, string scalar, or callback cell array.
WindowState recomputes geometry, limits, or layout. Type: text scalar or character row vector. Supported values: 'normal', 'minimized', 'maximized', 'fullscreen'.
WindowStyle 'docked' hosts the figure inside the Nelson desktop (GUI mode); 'alwaysontop' keeps the window above the other windows; 'normal' makes it a regular separate window again. Type: text scalar or character row vector. Supported values: 'normal', 'modal', 'docked', 'alwaysontop'.
💡Examples
Create the graphics object and list its properties.
h = figure('Visible', 'off');
names = properties(h);
close(h)
🔗See Also
figurepropertiesgetset
🕔Version History
Version Description
2.0.0 Property page added.
Edit this page on GitHub