NOTE: We are working on migrating this site away from MediaWiki, so editing pages will be disabled for now.

Difference between revisions of "GBrowse/AJAXhandlerScript"

From GMOD
Jump to: navigation, search
(Changes To Configuration File)
(Changes To Configuration File)
Line 46: Line 46:
  
 
==Changes To Configuration File==
 
==Changes To Configuration File==
* A new section [TOOLTIPS] that has all the the config options or callbacks you need to access through gbrowse_details
+
* A new section [TOOLTIPS] that has all the named text sections or callbacks you need to access through gbrowse_details
 
+
[[Image:callbacks]]
 
+
# callback to be run remotely by gbrowse_details for AJAX/iframe balloons
+
[TOOLTIPS]
+
default = sub {
+
                my $args  = shift;
+
                my $feat  = $args->{feature};
+
                my $name  = $feat->display_name;
+
                my $type  = $feat->primary_tag;
+
                my $class = $feat->class;
+
                my $extra = join(' ',$feat->each_tag_value('Note')) if $feat->has_tag('Note');
+
                my $n    = $type =~ /^[AEIOU]/i ? 'n' : '';
+
                my $msg  = "Hello, I am $name, a$n $type of class $class";
+
                $msg    .= "<br>I am described as a <b>$extra</b><br>" if $extra;
+
                my $seq  = substr $feat->seq->seq, 0, 400;
+
                $seq =~ s/(\S{40})/$1\n/g;
+
                return "<table><tr><th bgcolor='lightsteelblue'>$name</th><tr>" .
+
                        "<tr><td>$msg</td></tr><tr><td bgcolor='lightyellow'>".
+
                        "First 400 bp:<br><pre>>$name\n$seq</pre></td></tr></table>";
+
            }
+
params  = sub {
+
            my $args = shift;
+
            my $msg = "<h3>Arguments received<h3>";
+
            $msg .= "<pre style='background:gainsboro;padding:10px'>";
+
            for my $k (sort keys %$args) {
+
              $msg .= "$k\t=>\t$$args{$k}\n";
+
            }
+
            return $msg."</pre>";
+
          }
+
  
 +
* The balloon configuration (unchanged).  The 375px max-width balloon is used in the examples above
 +
[[Image:balloncfg]]
  
 
* The [ORF] contig stanza used to generate the images above.  The relevant section is highlighted
 
* The [ORF] contig stanza used to generate the images above.  The relevant section is highlighted

Revision as of 17:53, 9 November 2007

Proposal to convert gbrowse_details to an AJAX request handler

A temporary page to describe a low-impact change to existing code to provide a built-in ajax handler for Gbrowse

Examples

  • A balloon hover with contents generated using an AJAX call to gbrowse_details and the params callback shown below

Sample1b.png


  • A sticky balloon with contents generated from gbrowse-details (via an <iframe> element) and the default callback shown below.

Sample2b.png

Changes to gbrowse_details

  • A new CGI parameter to invoke the AJAX-handling behavior
my $rmt   = param('remote');


  • A response is triggered after the feature(s) are defined but before PrintTop is called.
if (defined $rmt) {
  print header,start_html;
  print remote_content($rmt,$features[0]);
  print end_html;
  exit 0;
}
  • The remote_content subroutine will get the text or coderef. It will return the text or execute the callback with user-defined arguments
# do something for popup balloons                                                                                                                                             
sub remote_content {
  my $key = shift; # the key for the text or code-ref in the gbrowse config file                                                                                              
  my $feat = shift;
  my $contents = $CONFIG->config->code_setting('TOOLTIPS',$key) or die "$key is empty";                                                                                                                 
  my $coderef = (ref $contents||'') eq 'CODE';
  return $contents unless $coderef;  
  # paranoia?                                                                                                                                                                 
  die "Error: $key is not a CODE-REF" if ref $contents && !$coderef;
  # args are user-defined                                                                                                                                                     
  my %args = (feature => $feat) if $feat;
  for my $arg (param()) {
    my @vals = param($arg);
    my $val  = @vals > 1 ? \@vals : $vals[0];
    $args{$arg} = $val;
  }
  return $contents->(\%args);
}

Changes To Configuration File

  • A new section [TOOLTIPS] that has all the named text sections or callbacks you need to access through gbrowse_details

Callbacks

  • The balloon configuration (unchanged). The 375px max-width balloon is used in the examples above

Balloncfg

  • The [ORF] contig stanza used to generate the images above. The relevant section is highlighted

Orf stanza

Changes to Bio::Graphics::Browser