src/jalview/bin/JalviewJSApi.java

   1 package jalview.bin;
   2
   3 import jalview.gui.AlignFrame;
   4 import jalview.javascript.JalviewLiteJsApi;
   5
   6 /**
   7  * JAL-3369 JalviewJS API BH 2019.07.17
   8  *
   9  * @author hansonr
  10  *
  11  */
  12 public interface JalviewJSApi extends JalviewLiteJsApi
  13 {
  14
  15   Object parseArguments(String[] args);
  16
  17   /**
  18    * Open a new Tree panel on the desktop statically. Params are standard (not
  19    * set by Groovy). No dialog is opened.
  20    *
  21    * @param af
  22    * @param treeType
  23    * @param modelName
  24    * @return null, or the string "label.you_need_at_least_n_sequences" if number
  25    *         of sequences selected is inappropriate
  26    */
  27   public Object openTreePanel(AlignFrame af, String treeType,
  28           String modelName);
  29
  30   /**
  31    * public static method for JalviewJS API to open a PCAPanel without
  32    * necessarily using a dialog.
  33    *
  34    * @param af
  35    * @param modelName
  36    * @return the PCAPanel, or the string "label.you_need_at_least_n_sequences"
  37    *         if number of sequences selected is inappropriate
  38    */
  39   public Object openPcaPanel(AlignFrame af, String modelName);
  40
  41 }