Difference between revisions of "Jmol JavaScript Object/JSV"

From Jmol
Jump to navigation Jump to search
(getting specialized subsections out of the main Jmol-JSO page)
 
(getting specialized subsections out of the main Jmol-JSO page)
Line 6: Line 6:
  
 
For a demonstration of the Jmol/JSpecView connection, see the [http://chemapps.stolaf.edu/jmol/jspecview JSpecView subdirectory] at chemapps.stolaf.edu or the demo pages at [http://wwwchem.uwimona.edu.jm/spectra/JSpecView/ the University of the West Indies].
 
For a demonstration of the Jmol/JSpecView connection, see the [http://chemapps.stolaf.edu/jmol/jspecview JSpecView subdirectory] at chemapps.stolaf.edu or the demo pages at [http://wwwchem.uwimona.edu.jm/spectra/JSpecView/ the University of the West Indies].
 +
 +
=== JSpecView-Specific Functions ===
 +
 +
All these functions must be applied to the unique '''<code>Jmol</code>''' object (this name is literal, cannot be changed) --see syntax and examples below.
 +
 +
Syntax:
 +
Jmol.jsvAddHightlight = function(jsvApplet, x1, x2, r, g, b, a)
 +
Jmol.jsvExport = function(jsvApplet, exportType, n)
 +
Jmol.jsvGetCoordinate = function(jsvApplet)
 +
Jmol.jsvGetPropertyAsJavaObject = function(jsvApplet, key)
 +
Jmol.jsvGetPropertyAsJSON = function(jsvApplet, key)
 +
Jmol.jsvGetSolnColour = function(jsvApplet)
 +
Jmol.jsvIsPro = function(jsvApplet)
 +
Jmol.jsvIsSigned = function(jsvApplet)
 +
Jmol.jsvLoadInline = function(jsvApplet, data, params)
 +
Jmol.jsvRemoveAllHighlights = function(jsvApplet)
 +
Jmol.jsvRemoveHighlight = function(jsvApplet, x1, x2)
 +
Jmol.jsvReversePlot = function(jsvApplet)
 +
Jmol.jsvRunScript = function(jsvApplet, script)
 +
Jmol.jsvRunScriptNow = function(jsvApplet, script)
 +
Jmol.jsvSetFilePath = function(jsvApplet, tmpFilePath)
 +
Jmol.jsvSetSpectrumNumber = function(jsvApplet, n)
 +
Jmol.jsvSetVisible = function(jsvApplet, TF)
 +
Jmol.jsvSyncScript = function(jsvApplet, peakScript)
 +
Jmol.jsvToggleCoordinate = function(jsvApplet)
 +
Jmol.jsvToggleGrid = function(jsvApplet)
 +
Jmol.jsvToggleIntegration = function(jsvApplet)
 +
Jmol.jsvWriteStatus = function(jsvApplet, msg)

Revision as of 19:35, 25 February 2013

Integration of JSpecView into Jmol-JSO

Extensive work in 2012 integrated JSpecView into Jmol 13. The full Jmol application includes a new "tools" menu item that opens a frame for JSpecView. For the applet, Jmol and JSpecView are two distinct applets that talk to each other using the Jmol sync command. Jmol-JSO brokers this transaction and allows coordinated applet start-up so that one applet does not send a command to the other before both are ready.

Associated with this integration, we have designed a specification for an extension of the JCAMP-DX format that allows one JDX file to contain Jmol-readable models and peak information, allowing the user to click on, for example, a carbon atom in Jmol and have the C-13 NMR spectrum automatically display and highlight the associated peak in JSpecView.

For a demonstration of the Jmol/JSpecView connection, see the JSpecView subdirectory at chemapps.stolaf.edu or the demo pages at the University of the West Indies.

JSpecView-Specific Functions

All these functions must be applied to the unique Jmol object (this name is literal, cannot be changed) --see syntax and examples below.

Syntax:

Jmol.jsvAddHightlight = function(jsvApplet, x1, x2, r, g, b, a) 
Jmol.jsvExport = function(jsvApplet, exportType, n) 
Jmol.jsvGetCoordinate = function(jsvApplet) 
Jmol.jsvGetPropertyAsJavaObject = function(jsvApplet, key) 
Jmol.jsvGetPropertyAsJSON = function(jsvApplet, key) 
Jmol.jsvGetSolnColour = function(jsvApplet) 
Jmol.jsvIsPro = function(jsvApplet) 
Jmol.jsvIsSigned = function(jsvApplet) 
Jmol.jsvLoadInline = function(jsvApplet, data, params)
Jmol.jsvRemoveAllHighlights = function(jsvApplet) 
Jmol.jsvRemoveHighlight = function(jsvApplet, x1, x2)
Jmol.jsvReversePlot = function(jsvApplet) 
Jmol.jsvRunScript = function(jsvApplet, script)
Jmol.jsvRunScriptNow = function(jsvApplet, script) 
Jmol.jsvSetFilePath = function(jsvApplet, tmpFilePath) 
Jmol.jsvSetSpectrumNumber = function(jsvApplet, n) 
Jmol.jsvSetVisible = function(jsvApplet, TF)
Jmol.jsvSyncScript = function(jsvApplet, peakScript)
Jmol.jsvToggleCoordinate = function(jsvApplet)
Jmol.jsvToggleGrid = function(jsvApplet) 
Jmol.jsvToggleIntegration = function(jsvApplet)
Jmol.jsvWriteStatus = function(jsvApplet, msg)

Contributors

AngelHerraez