X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=examples%2FappletParameters.html;h=1e45aae5d5483f661652d5c9a2ea7494bfe9e275;hb=df7802fdd54e7d3b12bda12ac55e6057c985bdf2;hp=7479729db9b08914fab6b0a3362403a781c6c850;hpb=4dd1280e2c4220c92bba4db6c7429ad36ad84e70;p=jalview.git diff --git a/examples/appletParameters.html b/examples/appletParameters.html index 7479729..1e45aae 100644 --- a/examples/appletParameters.html +++ b/examples/appletParameters.html @@ -1,175 +1,34 @@ - - - Applet Parameters - + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors + * + * This file is part of Jalview. + * + * Jalview is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + * + * Jalview is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR + * PURPOSE. See the GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. +--> - - - - - - - - - - - - - - - - - - - - - -
- - - -
+ -

- Quick Links:

  • Download the applet jar file from here -
  • -
  • As of Jalview 2.8b1, the applet is signed, with 'sandbox' permissions
  • -
  • Parameters are described below
  • -
  • The javascript API is described here
  • -
-

-

Additional applet deployment notes are below.

+

JalviewLite Applet Parameter Documentation

+

+The JalviewLite applet is configured through a series of applet parameters, +which are described below. Once initialised, +the applet can be interacted with via its +Javascript API. +

Issues arising from tightening of Java Security default settings
JalviewLite is provided as a signed applet with 'sandbox' permissions and wildcards that allow it to be run from any website. Unfortunately, earlier versions of Java may not be compatible with these settings.

+

For additional deployment notes, see below.

Applet Parameters


The applet takes the following initialisation parameters.

@@ -187,6 +46,24 @@ var _gaq = _gaq || [];_gaq.push(["_setAccount", "UA-9060947-1"]);_gaq.push(["_tr + + + + + + + + + + + Propensity, Strand Propensity, Turn Propensity, Buried Index, Nucleotide, T-Coffee Scores, RNA Helices + + + + + + + + @@ -394,11 +279,14 @@ var _gaq = _gaq || [];_gaq.push(["_setAccount", "UA-9060947-1"]);_gaq.push(["_tr + + - + - + @@ -406,29 +294,29 @@ var _gaq = _gaq || [];_gaq.push(["_setAccount", "UA-9060947-1"]);_gaq.push(["_tr - + - + - + - + - + - + @@ -479,7 +367,7 @@ var _gaq = _gaq || [];_gaq.push(["_setAccount", "UA-9060947-1"]);_gaq.push(["_tr archive="jalviewApplet.jar, mydata.zip">
  • Use Jalview for input to a HTML form. For an example of how to - code this using Javascript, click here. + code this using Javascript, click here.
  • Embed Jalview into the web page, without the "Start Jalview" @@ -487,10 +375,14 @@ var _gaq = _gaq || [];_gaq.push(["_setAccount", "UA-9060947-1"]);_gaq.push(["_tr <param name="embedded" value="true">
  • -

    **APPLET SECURITY WARNINGS**

    • Since January 2014, only signed applets are allowed to run in the web page by default. We provide a range of different signed version of JalviewLite and JmolApplet that can be used in various situations.
    • -
    • The default version of JalviewLite is signed for sandbox execution.
    • -

    -

    **NEW FEATURES** in Jalview 2.8

    + +

    **NEW FEATURES** in Jalview 2.9

    +
      +
    • Split Views for cDNA and Protein alignments
      Specify second alignment with 'file2' parameter, and set cDNA/Protein column scaling with scaleProteinAsCdna +
    • +
    +

    +

    **NEW FEATURES** in Jalview 2.8

    • Normalised sequence logo display
    • @@ -512,7 +404,7 @@ var _gaq = _gaq || [];_gaq.push(["_setAccount", "UA-9060947-1"]);_gaq.push(["_tr
    • Javascript callbacks capabilities
      • oninit parameter and methods for registering javascript handlers for selections, mouseovers and linking to Jmol applets on the page.
      • To use javascript callbacks, ensure the applet tag includes the 'mayscript' attribute - either as a parameter (<param name="mayscript" value="true"/;gt;) or as a bare attribute in the applet html tag).
    • -
    • New jalviewLite java api methods for selecting, highlighting, scrolling and reordering sequences in an alignment view. +
    • New jalviewLite java api methods for selecting, highlighting, scrolling and reordering sequences in an alignment view.

    **NEW FEATURES** in Jalview 2.6

      @@ -594,30 +486,4 @@ var _gaq = _gaq || [];_gaq.push(["_setAccount", "UA-9060947-1"]);_gaq.push(["_tr (All the usual Jalview File formats are valid, however each new line in an alignment file must be entered as a parameter)
    - - - - - - - - - - -
    fileName The file to open, must be on same server as the applet.
    file2fileNameA second file to open and show linked in a Split Frame + view. If one file is nucleotide and the other peptide, and at + least one peptide sequence matches the translation of one of the + nucleotide sequences, then gaps will be inserted into the + sequences in this file to match the aligned columns for + corresponding positions in the primary alignment file. This + parameter is ignored if enableSplitFrame is set to false (since + 2.9). +
    enableSplitFrametrue or false (default true)Enable or disable the display of linked cDNA and Protein alignments in a split frame (since 2.9).
    sequence1,
    sequence2,
    @@ -237,10 +114,18 @@ var _gaq = _gaq || [];_gaq.push(["_setAccount", "UA-9060947-1"]);_gaq.push(["_tr
    defaultColour One of:
    Clustal, Blosum62, % Identity, Hydrophobic, Zappo, Taylor, Helix - Propensity, Strand Propensity, Turn Propensity, Buried Index, Nucleotide
    Default is no colour.
    defaultColourNucA colour scheme (from the list above) to apply to Nucleotide alignmentsThis overrides defaultColour if it is specified.
    defaultColourProtA colour scheme (from the list above) to apply to Peptide alignmentsThis overrides defaultColour if it is specified.
    userDefinedColour

    Example:
    D,E=red; K,R,H=0022FF; c=yellow

    1.0 or greater Adjust the width of each cell in the alignment grid relative to the width of a character in the alignment font. (since 2.5.1)
    scaleProteinAsCdnatrue or false (default is false)Set true to shown protein residues the same width as their encoding codons. + For use with parameter file2 when showing a split frame of cDNA and protein. (since 2.9)
    centrecolumnlabelstrue of false (default is false)true or false (default is false) When true, text labels associated with a column in the alignment will be shown centered with respect to the column. (since 2.4)
    showUnconservedtrue of false (default is false)true or false (default is false) When true, only gaps and symbols different to the consensus sequence for a column will be shown. Useful for visualizing alignments exhibiting low sequence variation, where it is important to highlight mutations. (since 2.5)
    upperCaseIndicate a text style to apply to uppercase sequence symbols. Currently, only bold is supported.
    automaticScrollingtrue of false (default is true)true or false (default is true) When true, alignment panels will automatically scroll to show any regions of the alignment highlighted due to javascript events or when mousing over a position in an associated structure. (since 2.6)
    showGroupConsensustrue of false (default is false)true or false (default is false) When true, shows consensus annotation row for any groups on the alignment. (since 2.7)
    showGroupConservationtrue of false (default is false)true or false (default is false) When true, shows amino-acid property conservation annotation row for any groups on the alignment. (since 2.7)
    showConsensusHistogramtrue of false (default is true)true or false (default is true) When true, shows the percentage occurence of the consensus symbol for each column as a histogram above the consensus sequence row. (since 2.7)
    showSequenceLogotrue of false (default is false)true or false (default is false) When true, shows a sequence logo above the consensus sequence (overlaid above the Consensus Histogram, if visible, with symbols coloured using the alignment's default colourscheme). (since 2.7)
    normaliseSequenceLogotrue of false (default is false)true or false (default is false) When true, all sequence logos will be normalised (all symbol stacks add up to full height of annotation row), rather than being scaled according to the fraction of symbols identical to the consensus. (since 2.8)
    oninit