Library: Monk Project Library 0.1 Alpha 1
Overview
Constructors
Functions
Monk.event.CollectionsMetadataHierarchyLoaded(object)
Collections Hierarchy has been loaded The following are recognized properties (but the full class hierarchy should be examined):
  • label: a short descriptive summary of the event suitable for users to see
  • component: the source {@link Workbench.component.Component} for the event.
parameters
Object object A literal with properties for this event
Monk.event.MessageSent(object)
A message has been sent to the user
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.analysis.D2KAnalysisRun(object)
The user has initiated a D2K analysis
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.analysis.GotJobStatus(object)
The job status for a D2K analysis was received
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.analysis.GotFeatures(object)
The features from a D2K analysis was received
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.analysis.GotPrediction(object)
The prediction from a D2K analysis was received
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.project.ProjectCreated(object)
Server response that a project has been created
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.project.ProjectDeleted(object)
Server response that a project has been deleted
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.project.ProjectsReceived(object)
A user's projects have been received from the server
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.project.ProjectSelected(object)
A user has selected a project
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.project.ProjectInfoReceived(object)
The info for a project has been received from the server
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.project.WorksetsReceived(object)
A project's worksets have been received from the server
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.workset.WorksetCreated(object)
Server response that a workset has been created.
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.workset.WorksetSaved(object)
Server response that a workset has been saved.
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.workset.WorksetLoaded(object)
Server response that a workset has been loaded.
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.workset.WorksetProcessed(object)
The workbench has finished processing the (loaded) workset, adapting it from XML to JSON.
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.workset.WorksetDeleted(object)
Server response that a workset has been deleted.
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.chunk.ChunkSelected(object)
A single text chunk has been selected. The following are recognized properties (but the full class hierarchy should be examined):
  • label: a short descriptive summary of the event suitable for users to see
  • component: the source {@link Workbench.component.Component} for the event.
parameters
Object object A literal with properties for this event
Monk.event.chunk.ChunkChecked(object)
A chunk has been (un)checked by the user.
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Boolean object.checked Whether the chunk was checked or unchecked
Monk.event.chunk.ChunksChecked(object)
Multiple chunks have been checked by the user.
parameters
Object object A literal with properties for this event
String object.label A short descriptive summary of the event
Workbench.component.Component object.The source of the event
Monk.event.chunk.ChunkRated()
A chunk has been rated by the user.
Monk.event.chunk.ChunkContentsRetrieved(object)
The (rendered) contents of a chunk has been retrieved. The following are recognized properties (but the full class hierarchy should be examined):
  • uri: the URI to retrieve the chunk contents
  • label: a short descriptive summary of the event suitable for users to see
  • component: the source {@link Workbench.component.Component} for the event.
parameters
Object object A literal with properties for this event
Monk.event.chunk.ChunkContentsRetrievedWithFeatures(object)
The (rendered) contents of a chunk (with features) has been retrieved. The following are recognized properties (but the full class hierarchy should be examined):
  • uri: the URI to retrieve the chunk contents
  • label: a short descriptive summary of the event suitable for users to see
  • component: the source {@link Workbench.component.Component} for the event.
parameters
Object object A literal with properties for this event
Monk.event.chunk.ChunksContainingFeatureRetrieved(object)
The list of chunks containing a feature have been retrieved. The following are recognized properties (but the full class hierarchy should be examined):
  • uri: the URI to retrieve the chunk contents
  • label: a short descriptive summary of the event suitable for users to see
  • component: the source {@link Workbench.component.Component} for the event.
parameters
Object object A literal with properties for this event
Monk.event.workbench.LocalWindowFocus(object)
The user has changed on a window, giving it focus. The following are recognized properties (but the full class hierarchy should be examined):
  • uri: the URI to retrieve the chunk contents
  • label: a short descriptive summary of the event suitable for users to see
  • component: the source {@link Workbench.component.Component} for the event.
parameters
Object object A literal with properties for this event
Objects
Generated by JsDoc Toolkit 1.3.0 on Tue, 22 Jan 2008 20:43:42 GMT