suptitle — Set a centered figure-level title using the legacy suptitle alias for sgtitle.
suptitle sets the same figure-level title as sgtitle and exists primarily for compatibility with older MATLAB subplot code. It supports current-figure and explicit-figure forms and returns a text handle.
Syntax
h = suptitle(txt)
h = suptitle(fig, txt)
h = suptitle(txt, Name, Value, ...)
h = suptitle(fig, txt, Name, Value, ...)Inputs
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
txt | Any | Yes | — | Super-title text (string/char/cellstr-like multiline forms; numeric scalars also accepted). |
fig | NumericScalar | Yes | — | Target figure handle. |
props | Any | Variadic | — | Property/value pairs (Color, FontSize, FontWeight, etc.). |
Returns
| Name | Type | Description |
|---|---|---|
h | NumericScalar | Handle to the created/updated super-title object. |
Errors
| Identifier | When | Message |
|---|---|---|
RunMat:suptitle:InvalidArgument | Figure handle, text payload, or property/value arguments are invalid. | suptitle: invalid argument |
RunMat:suptitle:Internal | Internal plotting state update fails. | suptitle: internal operation failed |
How suptitle works
suptitle(txt)updates the current figure and returns the super-title text handle.suptitle(fig, txt, ...)targets an explicit figure handle when the handle exists.- String scalars, char arrays, string arrays, and cell arrays can all be used to create multiline super titles.
- Text styling properties such as
FontSize,FontWeight,FontAngle,Color,Interpreter, andVisibleuse the shared plotting text-property system. suptitleandsgtitleupdate the same figure-level title object.
Examples
Add a super title above a subplot figure
subplot(2, 1, 1);
plot(1:10, rand(1, 10));
subplot(2, 1, 2);
plot(1:10, rand(1, 10));
suptitle('Experiment Summary');Style the figure-level title and inspect the returned handle
subplot(1, 2, 1);
imagesc(peaks(20));
subplot(1, 2, 2);
imagesc(peaks(20));
h = suptitle('Field Comparison', 'FontSize', 18, 'FontWeight', 'bold');
get(h, 'Type')Expected output:
ans =
'text'Target an explicit figure handle
fig = figure(42);
subplot(1, 2, 1);
plot(0:0.1:1, sin(0:0.1:1));
subplot(1, 2, 2);
plot(0:0.1:1, cos(0:0.1:1));
suptitle(fig, 'Sine and Cosine');Using suptitle with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how suptitle changes the result.
Run a small suptitle example, explain the result, then change one input and compare the output.
FAQ
How is suptitle different from sgtitle?⌄
In RunMat, suptitle and sgtitle update the same figure-level super title. suptitle is provided as a compatibility spelling for MATLAB code that uses the older helper name.
How is suptitle different from title?⌄
title attaches text to the current axes, so each subplot can have its own panel title. suptitle attaches text to the figure as a whole and is drawn once above all panels.
Can I update the super title after creating it?⌄
Yes. suptitle returns a text handle, so you can inspect or update it with get and set.
h = suptitle('Initial Title');
set(h, 'String', 'Updated Title', 'FontWeight', 'bold');Related Plotting functions
More plotting resources
Open-source implementation
Unlike proprietary runtimes, every RunMat function is open-source. Read exactly how suptitle is executed, line by line, in Rust.
- View the source for suptitle in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is an open-source runtime that executes MATLAB-syntax code blazing on any GPU. It is licensed under the Apache 2.0 license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.