umap (Map)

The umap widget defines areas on an image that allow the user to interact by clicking on that area. It can only be used in form components. Uniface provides a logical widget called Map, which is mapped to umap.

Map widget with highlighted hot spot
Drum set with cymbal highlighted and identified by tool tip

For more information, see Specifying a Widget for a Field or Entity and Defining Map Widgets

Widget Overview
Logical widget name: Map
Maps to physical widget:

umap

Default definition:

Map=umap(font=label)

Use for: String fields (not Image)
Supported triggers: trigger valueChanged
Supported properties: See umap (Map)
Supported in egrid(Grid) widget? No
Supports MSAA? : No

Description

The umap widget contains defined arbitrary shapes (called polygons) on the displayed image which function as hot spots. These shapes are not visible to the user, but the Sense property can be used to provide visible feedback such as a border or another image when the cursor moves over them or the polygon is clicked.

For example, the hotspot is highlighted when the user clicks it. If the Tool Tip property is selected, the Tag Title is displayed as a tool tip when the user moves the cursor over the hot spot.

If the Sense property is set to rollover, the rollover trigger is activated when the mouse moves over a polygon. This can be used to display an image to highlight the current polygon based on its tag name.

Each polygon (or group of polygons) has a tag name associated with it. When the user clicks on an enabled polygon, the valueChanged trigger is activated.

The detail trigger is activated with ^DETAIL (GOLD D or Control+D). Uniface assigns the selected polygon’s tag name to the umap field's value where it can be used to take appropriate action in a ProcScript module.

Widget Properties

Map Widget Properties

Property

Technical Name

Dynamic

3-D Effect (3d)

3D

Yes

Attach to Window Border (attach)

Attach

Yes

Background Color (BackColor)

BackColor

Yes

Frame

Frame

Yes

Foreground Color (ForeColor)

ForeColor

Yes

Highlight

Highlight

Yes

Image Type

UIMGTYPE

No

Image Name

Picture

No

Label Font (LabelFont)

LabelFont

Yes

Monochrome Bitmap (Monochrome)

Monochrome

Yes

Mouse Activation (MouseActivation)

MouseActivation

Yes

Pop-up Menu (PopupMenu)

PopupMenu

Yes

Preserve Aspect Ratio (PreserveAspect)

PreserveAspect

Yes

Rollover Image Type

No

Rollover Image Name

Rollover

No

Sense

Sense

Yes

Toggle Polygon (Toggle)

Toggle

Yes

Tool Tip (ToolTip)

Tooltip

Yes

Attach Margin (AttachMargin)

AttachMargin

Yes

Popup Rectangle (PopupRect)

PopupRect

Yes

Related Topics