PMA.UI Documentation by Pathomation

Overview

PMA.UI.View.Controls Overview

Displays an interface that shows an overview and current view of slide

Constructor

new Overview(opt_options)

Source:
Parameters:
Name Type Description
opt_options object Options to initialize the overview control
Properties
Name Type Attributes Description
target string Target DOM element to add overview control
maxResolution number Maximum resolution overview control can show
tipLabel string <optional>
 Label for tracking button
collapsed boolean <optional>
 Whether the control starts collapsed
tracking boolean <optional>
 Whether the control has tracking capability
stateManager object <optional>
 The state manager to keep settings in sync
pmaViewport Viewport <optional>
 Viewport instance this control belongs to

Methods

changeOverviewSize(factor)

Source:
Changes overview control size by factor
Parameters:
Name Type Description
factor number Factor to change overview's size

changeOverviewSizePx(sizePx)

Source:
Changes overview control size by pixel size
Parameters:
Name Type Description
sizePx number Pixel size to change overview's size

getCollapsed() → {boolean}

Source:
Gets the collapsed state of the control
Returns:
True if the control is currently collapsed
Type
boolean

getTrackingEnabled() → {boolean}

Source:
Gets the tracking state of the control
Returns:
True if the control is currently tracking
Type
boolean

setCollapsed(collapsed)

Source:
Sets the collapsed state of the control
Parameters:
Name Type Description
collapsed boolean True to collapse the control, otherwise false

setMap(map)

Source:
Sets the OpenLayers map this control handles. This is automatically called by OpenLayers
Parameters:
Name Type Description
map ol.Map

setTrackingEnabled(enabled)

Source:
Enables or disables tracking
Parameters:
Name Type Description
enabled boolean True to enable tracking, otherwise false