Function figurewindow(key)
figurewindow(key,value,...)
controls the production and printing of
figure windows.
Input arguments:
"new"
produces a new figure window, if
<nwin> is not exceeded, or clears
an existing figure window
otherwise; and
increases figure counter <ifig>
by 1.
"nwin",<nwin>
sets the maximum number <nwin> of
figure windows on screen to the
given integer.
"ifig",<ifig>
sets the figure counter <ifig>
to the given integer.
"print"
writes the actual figure to (a)
file(s), and lists the figure
with a figure numero (either <ifig>
or <figurenumero1>), possible
caption <caption> and its file name
in the list file.
After writing the file,
<figurenumero1>, <figurenumero2>
and <caption> are set to empty.
"figurenumero",<figurenumero1>,<figurenumero2>
sets the figure numero in two forms
to the given two strings.
The first is used for presentation,
the second in the file name.
These forms are not used at default
and if the input is empty. In these
cases, figure counter <ifig> is used
as figure numero.
"caption",<caption>
sets the caption <caption> to the
given string.
"numeroprefixsuffix",<s1>,<s2>,<s3>
sets the text before and after the
figure numero for inclusion in the
caption. <s2> is written after the
numero when <caption> is given;
<s3> is written when <caption> is
empty.
"figurefile",<path>,<namestart>,<nameend>
sets the directory path <path>,
file name start <namestart>, and
file name end <nameend> for the
full figure file:
[<path> filesep <namestart> <figurenumero> <nameend> "." <suffix>]
Either sprintf("%03d",<ifig>) or
<figurenumero2> is used for
<figurenumero>.
Note that the list file is a
file in Latex.
"listfile",<path>,<filename>
sets the directory path <path>,
and the file name <filename>, for the
full list file:
[<path> filesep <filename> ".tex"]
"latexcode",<latexcode>
writes the given string at the actual
end of the list file.
"emptylistfile"
empties the whole list file; an empty
file is thus created.
"printformat",<printformatids>
sets the list of print formats for
output. A row cell array of strings
must be given.
Default is <printformatids> = {"pdf"}.
"printconfig",<printformatid>,<suffix>,<plotargs>
sets a print format to be referenced
with the string <printformatid>, with
the figure file suffix <suffix>, and
with a cell array <plotargs>. The third
element contains arguments understood by
function print().
The configuration of print format
<printformatid> = "pdf" is hardcoded,
and cannot be changed.
"mssglevel",<mssglevel>
sets the message level <mssglevel>
to the given string or numeric vector.
If <mssglevel> is not empty, the
function mssg() will be used to print
messages on screen. Otherwise, printf()
is used.
Note that settings and excecutions are done
in the ordre given!
Note on best results for print formats:
-- eps output on Linux with Octave 4.0 and
fltk/gnuplot graphics toolkits;
-- pdf output on Windows with Octave 5.2.
Additionally, there are these two calls:
<settings> = figurewindow(...)
figurewindow(<settings>)
where struct <settings> contains all
internal settings.
(c) 2026 fabien van mook
2026.08.20 release of this file within package "fvm-miscellaneous" under GNU GPLv3+
