Main Content

imoverviewpanel

Overview tool panel for image displayed in scroll panel

collapse all in page

Syntax

hpanel = imoverviewpanel(hparent,himage)

Description

Use the imoverviewpanel function to add an Overview tool to the same figure as an image contained in a scroll panel. The Overview tool is a navigation aid when exploring a zoomed-in version of the image.

The Overview tool displays the target image in its entirety, scaled to fit. The tool overlays a rectangle, called the detail rectangle, over the scaled version of the image. The detail rectangle shows the portion of the target image that is currently visible in the scroll panel. To view portions of the image that are not currently visible in the scroll panel, move the detail rectangle in the Overview tool.

example

hpanel = imoverviewpanel(hparent,himage) creates an Overview tool for an image displayed in a scroll panel. himage is a handle to the target image in the scroll panel. hparent is the handle to the figure or uipanel object that will contain the Overview tool. hpanel is the handle to the Overview tool.

Examples

collapse all

Open Live Script

Display an image in a figure. The example suppresses the standard toolbar and menubar in the figure window because these do not work with the scroll panel.

hFig = figure('Toolbar','none','Menubar','none');
hIm = imshow('foggysf1.jpg');

Create a scroll panel to contain the image. Set the size and position of the scroll panel so that the image occupies the top half of the figure window.

hSP = imscrollpanel(hFig,hIm);
set(hSP,'Units','normalized','Position',[0 .5 1 .5])

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

Add an overview tool to the figure. Set the size and position of the overview tool to occupy the bottom half of the figure window.

To explore details of the displayed image, try dragging the detail rectangle over the overview tool.

hOvPanel = imoverviewpanel(hFig,hIm);
set(hOvPanel,'Units','Normalized','Position',[0 0 1 .5])

{"String":"Figure contains 2 axes objects and other objects of type uipanel. Axes object 1 contains an object of type image. Axes object 2 contains 8 objects of type line, patch, image.","Tex":[],"LaTex":[]}

Input Arguments

collapse all

Handle to a figure or uipanel object that contains the Overview tool, specified as a handle.

Handle to target image, specified as a handle. The image must be displayed in a scroll panel created by imscrollpanel.

Output Arguments

collapse all

Handle to Overview tool, returned as a handle. An Overview tool is a type of uipanel object.

Tips

  • To create an Overview tool in a separate figure window, use imoverview. When created using imoverview, the Overview tool includes zoom-in and zoom-out buttons.

Version History

Introduced before R2006a

See Also

|