Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
6.1.1 - English

Change language to:
Français - 日本語 - Português - Русский

Please note that the recommended version of Scilab is 2024.1.0. This page might be outdated.
However, this page did not exist in the previous stable version.

Scilab Help >> Graphics > xget


gets current values of the graphics context. This function is obsolete.


value = xget(query)


This function is obsolete. Use the graphics properties of objects instead.

This function is used to get values from the graphics context on the topic specified by the string query.

value = xget("fpf")

Gets as a string the floating point format for number display in contour functions. Note that value is "" when the default format is used.


// SCILAB 3 & 4           SCILAB N > 4
// ------------           ------------
xget("window")            gcf().figure_id
xget("figure")            gcf().figure_id
xget("wpos")              gcf().figure_position
xget("wdim")              gcf().figure_size
xget("wpdim")             gcf().figure_size
xget("viewport")          gcf().viewport
xget("wresize")           gcf().auto_resize
xget("auto clear")        gcf().auto_clear

xget("hidden3d")          gca().hiddencolor
xget("clipgrf")           bool2s(gca().clip_state=="clipgrf")
xget("clipoff")           bool2s(gca().clip_state=="off")
xget("clipping")          gca().clip_box
xget("background")        gca().background
xget("foreground")        gca().foreground
xget("pattern")           gca().foreground
xget("lastpattern")       size(gcf().color_map,1)
xget("color")             gca().foreground
xget("white")             color("white")
xget("font")              [gca().font_style gca().font_size]
xget("font size")         gca().font_size
xget("dashes")            gca().line_style
xget("line mode")         gca().line_mode

See also

  • xset — set values of the graphics context. This function is obsolete.
  • get — Gets the handle of a graphical or User Interface object, or the property's value of objects.
  • graphics entities — description of the graphics entities data structures
  • gcf — Return handle of current graphic window.
  • gdf — Return handle of default figure.
  • gca — Return handle of current axes.
  • gda — Return handle of default axes.
  • ged — Scilab Graphic Editor
  • getcolor — opens a dialog to show colors of the current or default colormap


5.0.1 The "alufunction" property is obsolete. It is no longer taken into account for graphical renderings. It is replaced with gcf().pixel_drawing_mode.
5.4.0 The "alufunction" is no longer supported..
6.0.0 Only the xget("fpf") syntax is now supported.
Report an issue
<< xchange Graphics xset >>

Copyright (c) 2022-2024 (Dassault Systèmes)
Copyright (c) 2017-2022 (ESI Group)
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Mon Jan 03 14:23:29 CET 2022