PMA.UI Documentation by Pathomation

Events

Events

Source:
Events fired by components

Events

AnnotationAdded

Source:
Fires after when a new annotation has been added
Parameters:
Name Type Description
args Object
Properties
Name Type Description
feature Object The annotation object

AnnotationDeleted

Source:
Fires when an annotation has been deleted
Parameters:
Name Type Description
args Object
Properties
Name Type Description
annotationId Number
feature Object

AnnotationDrawing

Source:
Fires when annotation drawing begins

annotationEditingEnded

Source:
Fires when annotation editing ends

annotationEditingStarted

Source:
Fires when annotation editing begins

AnnotationModified

Source:
Fires when an annotation has been modified

AnnotationsSaved

Source:
Fires when the annotations have been saved to PMA.core
Parameters:
Name Type Description
args Object
Properties
Name Type Description
success boolean

AnnotationsSelectionChanged

Source:
Fires when the currently selected annotation(s) have changed
Parameters:
Name Type Description
args Array.<Object> The selected annotation objects

BeforeDrop

Source:
Fires when a slide is dropped in the PMA.UI.Components.SlideLoader
Parameters:
Name Type Description
args Object The arguments passed to this event
Properties
Name Type Description
serverUrl string The serverUrl
path string The path to the slide dropped
node Object The node metadata object
Returns:
- Whether to cancel the slide loading or not
Type
boolean

BeforeSlideLoad

Source:
Fires before a viewport attempts to load an image

DirectoryExpanded

Source:
Fires when a folder node has been expanded by a PMA.UI.Components.Tree instance
Parameters:
Name Type Description
args Object
Properties
Name Type Description
serverUrl string
path string

DirectorySelected

Source:
Fires when a directory has been selected by a PMA.UI.Components.Tree instance
Parameters:
Name Type Description
args Object
Properties
Name Type Description
serverUrl string
path string

Dropped

Source:
Fires when data are dropped on a PMA.UI.Components.Gallery
Parameters:
Name Type Description
args Object The arguments passed to this event
Properties
Name Type Description
serverUrl string The server url
path string The path to a slide or directory dropped
isFolder boolean Whether a directory was dropped
append boolean Whether the slide/directory was appended or replaced(alt key was pressed)

FormEditClick

Source:
Fires when a the edit button of a read only form is clicked

FormSaved

Source:
Fires when a form has been saved to PMA.core
Parameters:
Name Type Description
args Object The result of the save operation
Properties
Name Type Description
message string The error message if any
success boolean True if save was successful

MultiSelectionChanged

Source:
Fires when slide images have been checked by a PMA.UI.Components.Tree
Parameters:
Name Type Description
args Array.<Object>
Properties
Name Type Description
serverUrl string
path string

SearchFailed

Source:
Fires when a search has failed
Parameters:
Name Type Description
server Tree~server The object containing the server failed to fetch search results for

SearchFinished

Source:
Fires when a search has finished
Parameters:
Name Type Description
results Object.<string, Array.<string>> The object containing the result for each server available

SearchStarted

Source:
Fires when a search has started

ServerExpanded

Source:
Fires when a server node has been expanded by a PMA.UI.Components.Tree instance
Parameters:
Name Type Description
args Object
Properties
Name Type Description
serverUrl string

ServerSelected

Source:
Fires when a server node has been selected by a PMA.UI.Components.Tree instance
Parameters:
Name Type Description
args Object
Properties
Name Type Description
serverUrl string

SessionIdLoginFailed

Source:
Fires when a session id authentication fails
Parameters:
Name Type Description
args Object The arguments passed to this event
Properties
Name Type Description
serverUrl string The server url

SlideDeSelected

Source:
Fires when a slide image has been deselected by a PMA.UI.Components.Tree or PMA.UI.Components.Gallery instance

SlideInfoError

Source:
Fires when image info could not be loaded

SlideLoaded

Source:
Fires after a viewport has finished loading an image
Parameters:
Name Type Description
args Object The slide loaded arguments
Properties
Name Type Description
serverUrl string The server the slide belongs to
path string The slide path
dropped boolean Whether the slide was loaded via a drag and drop operation

SlideSelected

Source:
Fires when a slide image has been selected by a PMA.UI.Components.Tree or PMA.UI.Components.Gallery or a PMA.UI.Components.MetadataTree instance
Parameters:
Name Type Description
args Object
Properties
Name Type Attributes Description
serverUrl string The server url this slide belongs to
path string The path to the slide
index Number <optional>
 The index of the slide selected in the gallery components (PMA.UI.Components.Gallery only)
userInteraction boolean <optional>
 Whether this event was fired by a user interaction or programmatically (PMA.UI.Components.Gallery only)

SyncChanged

Source:
Fires when the state of the synchronization of viewports has changed (enabled/disabled)
Parameters:
Name Type Description
enabled boolean Whether syncronization was enabled

TreeNodeDoubleClicked

Source:
Fires when a form has been saved to PMA.core
Parameters:
Name Type Description
args Object
Properties
Name Type Description
serverUrl string
path string
isSlide boolean

ValueExpanded

Source:
Fires when a form value is expanded by a PMA.UI.Components.MetadataTree
Parameters:
Name Type Description
args Object The arguments passed to this event
Properties
Name Type Description
serverUrl string The server url that the form value belongs to
slides Array.<string> An array of the paths for the slides belonging to the formvalue expanded