iptgetapi

R2026b

Get Application Programmer Interface (API) for handle

collapse all in page

Syntax

API = iptgetapi(h)

Description

API = iptgetapi(h) returns the API structure of an interactive modular tool with handle h.

example

Examples

collapse all

Open Live Script

Display an image in a figure window.

hFig = figure(Toolbar="none",Menubar="none",Name="Tape");
hIm = imshow("tape.png");

Add a Scroll Panel tool to the figure.

hSP = imscrollpanel(hFig,hIm);

Figure Tape contains an axes object and another object of type uipanel. The hidden axes object contains an object of type image.

Get the API associated with the Scroll Panel tool.

api = iptgetapi(hSP);

Use the API to magnify the image by 200%.

api.setMagnification(2)

Figure Tape contains an axes object and another object of type uipanel. The hidden axes object contains an object of type image.

Input Arguments

collapse all

Handle to an interactive modular tool such as an imdistline, imline, immagbox, or imscrollpanel.

Output Arguments

collapse all

Handle API, returned as a struct whose fields are the function handles that belong to the interactive modular tool h. If h is not a handle to an interactive modular tool, then API is returned as an empty array, [].

Version History

Introduced before R2006a

See Also

| | |