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.0.0. This page might be outdated.
However, this page did not exist in the previous stable version.

Scilab Help >> Graphics > handle > get_figure_handle

get_figure_handle

get a figure handle from its id (obsolete)

Syntax

f = get_figure_handle(figure_id)

Arguments

figure_id

Integer, id of the figure to retrieve.

f

Handle of the corresponding figure.

Description

This function is obsolete and will be removed in Scilab 6.1.x. Please use findobj("figure_id",n) instead.

get_figure_handle function allows to retrieve the handle of a graphic figure knowing its id. If a figure with the specified id exists the function returns it. Otherwise is returns an empty matrix.

Examples

// create some figures
scf(0);
scf(5);
scf(12);

// get handle on the figure with id 5
f5 = get_figure_handle(5);
// current figure remains the one with id 12
gcf()

// get a non existing figure
f42 = get_figure_handle(42);

See also

  • set — set properties of some graphic objects or uimenus or uicontrol interactive components
  • get — Gets the handle of a graphical or User Interface object, or the property's value of objects.
  • gcf — Return handle of current graphic window.
  • scf — set the current graphic figure (window)
  • graphics_entities — description of the graphics entities data structures

History

VersionDescription
6.1.0 get_figure_handle(n) is declared obsolete. findobj("figure_id",n) is used instead.
Report an issue
<< ged handle glue >>

Copyright (c) 2022-2023 (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:28 CET 2022