PMA.UI Documentation by Pathomation

Global

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) 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) getVersion

Source:
Get the current version number

(constant) SlideStatus :number

Source:
Properties:
Name Type Description
MissingFiles number Slide is missing files
Queued number Slide is queued for upload
Uploading number Slide is uploading
Error number Slide uploading was unsuccessful
Done number Slide uploaded successfully
NotSupported number Slide not supported
ImageUpload slide status
Type:
  • number

(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

buildTree(fileList) → {Array.<ImageUpload~TreeNode>}

Source:
Organizes a list of files into a tree structure.
Parameters:
Name Type Description
fileList Array.<File>
Returns:
Type
Array.<ImageUpload~TreeNode>

(async) findSlides(root, targetPath) → {Array.<ImageUpload~Slide>|undefined}

Source:
Traverses the tree of file objects breadth first and finds slides, which are coupled with their auxiliary files if provided.
Parameters:
Name Type Description
root ImageUpload~TreeNode The tree top node
targetPath string The path the slides must be uploaded to
Returns:
Type
Array.<ImageUpload~Slide> | undefined

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