examples/javascript/jalview.js

   1 // default console to report messages\r
   2 var _console = document.getElementById("stdout");\r
   3 var _jvapps = new Array();\r
   4 // jvjmols is a list associating a jmol id to { modelstofiles }\r
   5 var _jvjmols = new Hashtable();\r
   6 // array of model names used to lookup index in Jmol\r
   7 var _modeltofiles = new Array();\r
   8 // counter for jmol structures\r
   9 var mnum = 1;\r
  10 \r
  11 function setConsole(console) {\r
  12         _console = console;\r
  13 }\r
  14 \r
  15 function getDestinationFrms(source, frames) {\r
  16         var frms = new Array();\r
  17         var frid = "";\r
  18         for (frm in frames) {\r
  19                 try {\r
  20                         frid = (("" + source.getDatasetId()) == ("" + frames[frm]\r
  21                                         .getDatasetId()));\r
  22                 } catch (q) {\r
  23                 }\r
  24                 ;\r
  25                 if (!frames[frm].equals(source) && !frid\r
  26                                 && !frames[frm].currentAlignFrame.equals(source)) {\r
  27                         frms[frms.length] = frames[frm];\r
  28                 }\r
  29         }\r
  30         return frms;\r
  31 }\r
  32 \r
  33 function mouseover(list1, list2, list3, list4) {\r
  34         // list1 = new Object(list1);\r
  35         var list = new Array(("" + list1), ("" + list2), ("" + list3), ("" + list4));\r
  36         var msg = "Mouse over :\n" + "AlignFrame obj: " + list1 + " Seq : "\r
  37                         + list[1] + "\nPos: " + list[2] + "(" + list[3] + ")\n";\r
  38 \r
  39         var flist = getDestinationFrms(list1, _jvapps);\r
  40         if (_console) {\r
  41                 _console.value = msg + "\n";\r
  42         }\r
  43 \r
  44         for (follower in flist) {\r
  45                 if (_console) {\r
  46                         _console.value += "Sending to " + flist[follower] + "\n";\r
  47                 }\r
  48                 flist[follower].highlight(list[1], list[2], "true");\r
  49         }\r
  50         return true;\r
  51 }\r
  52 \r
  53 function sellist(list1, list2, list3, list4) {\r
  54         // list1 = new Object(list1);\r
  55         var list = new Array(("" + list1), ("" + list2), ("" + list3), ("" + list4));\r
  56         var msg = "Selection:\n" + "AlignFrame obj: " + list[0] + " id : "\r
  57                         + list[1] + "\nSeqs " + list[2] + "\nColumns " + list[3] + "\n";\r
  58         var flist = getDestinationFrms(list1, _jvapps);\r
  59         if (_console) {\r
  60                 _console.value = msg + "\n";\r
  61         }\r
  62         \r
  63         for (follower in flist) {\r
  64                 if (_console) {\r
  65                         _console.value += "Sending to " + flist[follower] + "\n";\r
  66                 }\r
  67                 flist[follower].selectIn(flist[follower].getDefaultTargetFrame(),\r
  68                                 list[2], list[3])\r
  69         }\r
  70         return true;\r
  71 }\r
  72 \r
  73 function viewlist(list1, list2, list3, list4) {\r
  74         // list1 = new Object(list1);\r
  75         var list = new Array(("" + list1), ("" + list2), ("" + list3), ("" + list4));\r
  76         var msg = "Viewport extent change::\n" + "AlignFrame obj: " + list[0]\r
  77                         + " id : " + list[1] + "\nRow from " + list[2] + " and to "\r
  78                         + list[3] + "\nVisible columns: " + list[4] + "\n";\r
  79         var flist = getDestinationFrms(list1, _jvapps);\r
  80         if (_console) {\r
  81                 _console.value = msg + "\n";\r
  82         }\r
  83 \r
  84         for (follower in flist) {\r
  85                 if (_console) {\r
  86                         _console.value += "Sending to " + flist[follower] + "\n";\r
  87                 }\r
  88                 flist[follower].scrollToViewIn(flist[follower].getDefaultTargetFrame(),\r
  89                                 list[2], "-1");\r
  90         }\r
  91         return true;\r
  92 }\r
  93 \r
  94 // register a jalview applet and add some handlers to it\r
  95 // jmolView is a reference to a jmol applet that is displaying the PDB files listed (in order) in the modeltofiles Array\r
  96 function linkJvJmol(applet, jmolView, modeltofiles) {\r
  97         var i = _jvapps.length;\r
  98         while (i--) {\r
  99                 if (_jvapps[i].equals(applet)) {\r
 100                         throw ("Ignoring additional linkJvJmol call for "\r
 101                                         + applet.getName() + ".");\r
 102                 }\r
 103         }\r
 104         _jvapps[_jvapps.length] = applet;\r
 105         applet.setMouseoverListener("mouseover");\r
 106         applet.setSelectionListener("sellist");\r
 107         // viewListener not fully implemented in 2.7\r
 108         // try { applet.setViewListener("viewlist"); } catch (err) {};\r
 109         if (jmolView)\r
 110         {\r
 111                 var oldjm=jmolView;\r
 112                 // recover full id of Jmol applet\r
 113                 jmolView=_jmolGetApplet(jmolView).id;\r
 114                 var jmbinding=_jvjmols.get(jmolView);\r
 115                 if (!jmbinding)\r
 116                 {       \r
 117                         jmbinding=new Object();\r
 118                         jmbinding._modelstofiles=new Array();\r
 119                         jmbinding._fullmpath=new Array();\r
 120                         jmbinding._filetonum=new Hashtable();\r
 121                         jmbinding._jmol=jmolView;\r
 122                         jmbinding._jmhandle=oldjm;\r
 123                         _jvjmols.put(jmolView,jmbinding);\r
 124                 }\r
 125                 \r
 126                 jmbinding._modelstofiles=jmbinding._modelstofiles.concat(jmbinding._modelstofiles,modeltofiles);\r
 127                 jmbinding._jmol=jmolView;\r
 128                 // now update structureListener list\r
 129                 mtf="";\r
 130                 var dbase = document.baseURI.substring(0,document.baseURI.lastIndexOf("/")+1);\r
 131                 for (m in jmbinding._modelstofiles)\r
 132                 { mtf+=jmbinding._modelstofiles[m];\r
 133                 if (jmbinding._modelstofiles[m].indexOf("//")==-1)\r
 134                         { jmbinding._fullmpath[m] = dbase+jmbinding._modelstofiles[m]; }\r
 135                   jmbinding._filetonum.put(jmbinding._modelstofiles[m], m);\r
 136                   jmbinding._filetonum.put(jmbinding._fullmpath[m], m);\r
 137                   \r
 138                   if (m>0) { mtf+=sep; }}\r
 139                 jvfollower.setStructureListener("_structure", mtf);\r
 140         }\r
 141 }\r
 142 \r
 143 /*function _addJmolModel(jmolid, modelname) {\r
 144         modelname=""+modelname;\r
 145         var jminf = _jvjmols[jmolid];\r
 146         if (!jminf) {\r
 147                 jminf = new Object();\r
 148                 jminf._modelstofiles = new Array(); //new Hashtable();\r
 149                 jminf._jmol = jmolid;\r
 150                 jminf._modellist=new Array();\r
 151                 _jvjmols[jmolid] = jminf;\r
 152         }\r
 153         var obj = new Object();\r
 154         jminf._modeltofiles[modelname] = obj; // .put(modelname, obj);\r
 155         obj.id = modelname;\r
 156         obj.mnum = jminf._modeltofiles.length;\r
 157         jminf._modellist+=modelname;\r
 158 }*/\r
 159 \r
 160 \r
 161 \r
 162 // jmol Jalview Methods\r
 163 \r
 164 function _structure(list1, list2, list3, list4) {\r
 165         var follower;\r
 166         // if (_console) { if (!_console.value) { _console.value="";} }\r
 167         if (list1 == "mouseover") {\r
 168                 var list = new Array(("" + list1), ("" + list2), ("" + list3),\r
 169                                 ("" + list4));\r
 170                 // 1 is pdb file, 2 is residue number, 3 is chain\r
 171                 // list1 = new Object(list1);\r
 172                 var base = list[1].indexOf(document.baseURI\r
 173                                 .substring(0, document.baseURI.lastIndexOf('/'))\r
 174                                 ); // .indexOf(_path);\r
 175                 if (base==0) { base = document.baseURI.lastIndexOf('/'); }\r
 176                 var sid = list[1]; // .substring(base);\r
 177                 base = list[1].substring(0, base);\r
 178                 if (_console) {\r
 179                         _console.value += "Model is " + list[1] + ", Structure id is : "\r
 180                                         + sid + "\n";\r
 181                 }\r
 182                 ;\r
 183                 var siddat;\r
 184                 for ( var jmolappi in _jvjmols.values()) {\r
 185                         var jmolapp=_jvjmols.values()[jmolappi];\r
 186                         var msg = "";\r
 187                         if (siddat = jmolapp._filetonum.get(sid)) {\r
 188                                 // we don't putin chain number because there isn't one ?\r
 189                                 // skip select 0 bit\r
 190                                 var ch = ""+list[3];\r
 191                                 if ((""+list[2]).trim().length==1)\r
 192                                         {\r
 193                                         ch+=":"+list[2];\r
 194                                         }\r
 195                                 msg = "select (" + ch + " /" + siddat + ") ;";\r
 196                         }\r
 197                         if (msg) {\r
 198                                 if (_console) {\r
 199                                         _console.value += "Sending '" + msg + "' to jmol." + "\n";\r
 200                                 }\r
 201                         }\r
 202                         jmolScriptWait(msg, "" + jmolapp._jmhandle);\r
 203                         // only do highlight for one jmol ?\r
 204                         // return 1;\r
 205                 }\r
 206         }\r
 207         if (list1 == "colourstruct") {\r
 208                 if (_console) {\r
 209                         _console.value += 'colourStruct("' + list1 + '","' + list2\r
 210                         + '") [' + list4 + ']' + "\n";\r
 211                 }\r
 212                 setTimeout('colourStruct("'+list4+'","' + list1 + '","' + list2 + '")', 1);\r
 213                 return 1;\r
 214         }\r
 215         return 1;\r
 216 }\r
 217 // last colour message\r
 218 var _lastMsg = "";\r
 219 // indicator - if _colourStruct==0 then no colouring is going on\r
 220 var _colourStruct = 0;\r
 221 \r
 222 function colourStruct(involves, msg, handle) {\r
 223         if (_colourStruct == 0) {\r
 224                 _colourStruct = 1;\r
 225                 for (ap in _jvapps) {\r
 226                         var _msg = "";\r
 227                         do {\r
 228                                 if (_msg.match(/\S/)) {\r
 229                                         _lastMsg += _msg;\r
 230                                 }\r
 231                                 _msg = "" + _jvapps[ap].getJsMessage(msg, handle);\r
 232                         } while (_msg.match(/\S/));\r
 233                 }\r
 234                 // locate the jmol that should get the message\r
 235                 for (var jmol in _jvjmols.values())\r
 236                         {\r
 237                         var jml=_jvjmols.values()[jmol];\r
 238                         if (jml._filetonum.get(involves))\r
 239                                 {\r
 240                                         colourStructs(jml._jmhandle);\r
 241                                 }\r
 242                         }\r
 243                 _colourStruct = 0;\r
 244         } else {\r
 245                 // setTimeout('colourStruct("'+msg+'","'+handle+'")',3);\r
 246         }\r
 247 }\r
 248 \r
 249 function colourStructs(jmolapp) {\r
 250         dbg(0, "Colouring the structures\n");\r
 251         jmolScriptWait("set selectionhalos false;" + _lastMsg\r
 252                         + "; select 0; set selectionhalos true;", jmolapp);\r
 253         _lastMsg = "";\r
 254 }\r
 255 var _jmolhovermsg="";\r
 256 function _jmolhover(jmid, atomlabel, atomidx) {\r
 257         var msg=""+jmid+" "+atomlabel+" "+atomidx;\r
 258         if (_jmolhovermsg==msg)\r
 259                 {\r
 260                 return;\r
 261                 }\r
 262         _jmolhovermsg=msg;\r
 263         modeltofiles = _jvjmols.get(jmid)._modelstofiles;\r
 264         // atomlabel=(""+atomlabel).match(/\[(.+)\](\d+):(.)\.(\S+)\s*\/(\d+)\..+/);\r
 265         // relaxed third parameter - may be null or a model number for multi model\r
 266         // views\r
 267         atomlabel = ("" + atomlabel)\r
 268                         .match(/\[(.+)\](\d+):(.)\.(\S+)\s*(\/\d+\.|).+/);\r
 269         atomidx = "" + atomidx;\r
 270         if (atomlabel[5]) {\r
 271                 atomlabel[5] = atomlabel[5].match(/\/(.+)\./)[1];\r
 272         } else {\r
 273                 // default - first model\r
 274                 atomlabel[5] = 0;\r
 275         }\r
 276         // use atomlabel[5] to look up model filename so we can highlight associated positions in any jalviews\r
 277         for (ap in _jvapps) {\r
 278                 _jvapps[ap].mouseOverStructure(atomlabel[2], atomlabel[3],\r
 279                                 document.baseURI\r
 280                                                 .substring(0, document.baseURI.lastIndexOf('/'))\r
 281                                                 + "/" + modeltofiles[atomlabel[5]]);\r
 282                 msg = _jmolhovermsg;\r
 283         }\r
 284 }\r
 285 function _jmolpick(jmid, atomlabel, atomidx) {\r
 286         atomlabel = "" + atomlabel;\r
 287         atomidx = "" + atomidx;\r
 288         // label is atom id, atom number, and xyz coordinates in the form:\r
 289         // C6 #6 -0.30683374 -1.6836332 -0.716934\r
 290         // atom index, starting with 0.\r
 291 \r
 292 }\r
 293 function _jmolMessagecallback(jmid, statmess) {\r
 294         // if (statmess.indexOf("Script Terminated")==0)\r
 295         {\r
 296                 var thisTime = new Date();\r
 297                 if (_console) {\r
 298                         _console.value += "Last script execution took : "\r
 299                                         + (thisTime.valueOf() - _lastTime.valueOf()) / 1000.0\r
 300                                         + " seconds.";\r
 301                 }\r
 302                 _lastTime = thisTime;\r
 303 \r
 304         }\r
 305 }\r