Members
(constant) ApiMethods :string
- Source:
PMA.core API methods
Type:
- string
(constant) ButtonLocations :string
- Source:
Properties:
Name | Type | Description |
---|---|---|
ButtonLocations.N |
string | North of the viewport |
ButtonLocations.S |
string | South of the viewport |
ButtonLocations.E |
string | East of the viewport |
ButtonLocations.W |
string | West of the viewport |
ButtonLocations.NE |
string | North-East corner of the viewport |
ButtonLocations.NW |
string | North-West corner of the viewport |
ButtonLocations.SE |
string | South-East corner of the viewport |
ButtonLocations.SW |
string | South-West corner of the viewport |
Custom button predefined locations
Type:
- string
(constant) callApiMethod
- Source:
Invokes a PMA.core API method. This method will properly encode all provided parameters.
(constant) Controls :string
- Source:
Properties:
Name | Type | Description |
---|---|---|
Controls.ZoomSlider |
string | The zoom slider control |
Controls.ScaleLine |
string | The scale line control |
Controls.Overview |
string | The overview control |
Controls.Barcode |
string | The barcode control |
Controls.Magnifier |
string | The magnifier control |
Controls.ColorAdjustments |
string | The brightness/contrast control |
Controls.LayerSwitch |
string | The control to turn layers on/off. Used for server side annotation layers |
Controls.DimensionSelector |
string | The control used to control z-stacks and timeframes |
Controls.Filename |
string | The filename control |
Controls.Snapshot |
string | The snapshot control |
Controls.Rotation |
string | The rotation control |
Controls.Attribution |
string | The attribution control |
Available controls
Type:
- string
(constant) formify
- Source:
Converts an object to a URL encoded string of the form param1=value1¶m2=value2
(constant) getBarcodeUrl
- Source:
Returns a URL that points to the barcode of a slide image. This method doesn't guarantee that a barcode image actually exists.
(constant) GetSlidesScope :string
- Source:
PMA.core scopes for the GetSlides API method
Type:
- string
(constant) getSnapshotUrl
- Source:
Returns a URL that points to the snapshot of a slide image
(constant) getThumbnailUrl
- Source:
Returns a URL that points to the thumbnail of a slide image
(constant) login
- Source:
Authenticates against a PMA.core server
(constant) parseDragData
- Source:
Tries to parse the data passed from a drag and drop operation
(constant) Themes :string
- Source:
Properties:
Name | Type | Description |
---|---|---|
Themes.Default |
string | OpenLayers default |
Themes.Classic |
string | Classic layout found in many desktop viewers |
Themes.Modern |
string | Modern layout compatible with web application UI |
Viewer themes
Type:
- string
Methods
addInteraction(options)
- Source:
Instructs the viewport to enter annotation drawing mode
Parameters:
Name | Type | Description |
---|---|---|
options |
Annotations~startDrawingOptions | Options to start drawing |
ajax(url, method, data, callback, requestOptions)
- 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 |
AjaxCallback | The function to call upon completion of the request |
requestOptions |
AjaxRequestOptions | Optional HTTP request options |
callApiMethodWithAuthentication(options)
- Source:
calls an API method that requires a session ID. This method will first attempt to acquire
a session ID (possibly a cached one) and then call the requested method.
If the method call fails because the call was unauthorized (so possible the session ID was not good),
the method will be called again for a second time, this time forcing an authentication before the
actual call.
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object | The parameters to pass to the ajax request
Properties
|
Fires:
- PMA.UI.Components.Events#event:SessionIdLoginFailed
loadSlides(serverUrl, images, doneCbopt)
- Source:
A private function which load slides from one server only
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
serverUrl |
string | The URL of the PMA.core server to get images from | |||||||||||||
images |
Array.<string> | Array.<Object> | An array of strings that contains the paths of the images to load or an array of objects that contains the path and rotation of the images as desribed below
Properties
|
|||||||||||||
doneCb |
function |
<optional> |
Called when image loading is complete |
virtualPathToTreePath(path, tree) → {string}
- Source:
Converts a virtual path to a key used internaly by the tree component to locate any node
Parameters:
Name | Type | Description |
---|---|---|
path |
string | The virtual path to convert. The server part should be the NAME of the server (not the url) |
tree |
Object | The instance of the fancytree |
Returns:
The key to the node
- 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 |
AjaxDataEncodeCallback(data) → {string}
- Source:
A function that will stringify the data.
Parameters:
Name | Type | Description |
---|---|---|
data |
Object | The payload |
Returns:
- Type
- string
AjaxRequestOptions
- Source:
Properties:
Name | Type | Description |
---|---|---|
contentType |
string | The request content type |
dataEncodeCallback |
AjaxDataEncodeCallback | A function that will appropriately stringify the data. If null, the data will be formified. |
An object expected for drag and drop features
Type:
- Object