Main Content

iptgetapi

Get Application Programmer Interface (API) for handle

collapse all in page

Syntax

API = iptgetapi(h)

Description

example

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

Examples

collapse all

Open Live Script

Display an image in a figure window.

hFig = figure('Toolbar','none','Menubar','none');
hIm = imshow('tape.png');

Add a Scroll Panel tool to the figure.

hSP = imscrollpanel(hFig,hIm);

{"String":"Figure contains an axes object and an object of type uipanel. The axes object contains an object of type image.","Tex":[],"LaTex":[]}

Get the API associated with the Scroll Panel tool.

api = iptgetapi(hSP);

Use the API to magnify the image by 200%.

api.setMagnification(2)

{"String":"Figure contains an axes object and an object of type uipanel. The axes object contains an object of type image.","Tex":[],"LaTex":[]}

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

| | |