View

View

Source:
PMA.UI.View namespace

Classes

Viewport

Namespaces

Controls
Events
ObjectiveResolutions

Members

(static, readonly) ButtonLocations :string

Source:
Properties:
Name Type Description
N string North of the viewport
S string South of the viewport
E string East of the viewport
W string West of the viewport
NE string North-East corner of the viewport
NW string North-West corner of the viewport
SE string South-East corner of the viewport
SW string South-West corner of the viewport
Custom button predefined locations
Type:
  • string

(static, readonly) DefaultFillColor

Source:
Default fill color used

(static, readonly) Themes :string

Source:
Properties:
Name Type Description
Default string OpenLayers default
Classic string Classic layout found in many desktop viewers
Modern string Modern layout compatible with web application UI
Viewer themes
Type:
  • string

Methods

(static) ajax(url, method, data, callback)

Source:
Fires an HTTP ajax request. "this" is preserved and passed along to the callback
Parameters:
Name Type Description
url string The URL that the ajax request will be sent to
method string The HTTP verb (POST, GET, PUT etc.)
data Object The data to send. The method will properly encode the data automatically.
callback PMA.UI.View.ajaxCallback The function to call upon completion of the request

(static) formify(data) → {string}

Source:
Converts an object to a URL encoded string of the form param1=value1&param2=value2
Parameters:
Name Type Description
data Object The object to encode
Returns:
Type
string

Type Definitions

ajaxCallback(request)

Source:
Ajax response callback. "this" will be the same with the one passed to PMA.UI.View.ajax
Parameters:
Name Type Description
request XMLHttpRequest The object that was used to perform the ajax request

tileTransformer(pixels)

Source:
Receives pixel data and applies an image transformation to it
Parameters:
Name Type Description
pixels ImageData Represents the underlying pixel data of an area of a canvas element

SnapshotResult

Source:
Properties:
Name Type Description
url url The snapshot url
width Number The width of the snapshot
height boolean The height of the snapshot
An object expected for drag and drop features
Type:
  • Object