[Bio] / FigKernelPackages / Markups.pm Repository:
ViewVC logotype

Diff of /FigKernelPackages/Markups.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1, Fri Feb 24 19:44:03 2006 UTC revision 1.2, Thu Dec 6 13:59:34 2007 UTC
# Line 75  Line 75 
75    
76  =head3 new  =head3 new
77    
78  C<< my $$marks = Markups->new($fid, $fig); >>      my $$marks = Markups->new($fid, $fig);
79    
80  Construct a new Markups object for a specified feature.  Construct a new Markups object for a specified feature.
81    
# Line 113  Line 113 
113    
114  =head3 Insert  =head3 Insert
115    
116  C<< my $loc = $marks->Insert($start, $len, $label); >>      my $loc = $marks->Insert($start, $len, $label);
117    
118  Insert a new entry into the markup list. If an identical entry already exists, this  Insert a new entry into the markup list. If an identical entry already exists, this
119  method will have no effect.  method will have no effect.
# Line 157  Line 157 
157    
158  =head3 Delete  =head3 Delete
159    
160  C<< $marks->Delete($start, $len, $label); >>      $marks->Delete($start, $len, $label);
161    
162  Delete an entry from the markup list. If the entry does not exist, this method will  Delete an entry from the markup list. If the entry does not exist, this method will
163  have no effect.  have no effect.
# Line 195  Line 195 
195    
196  =head3 List  =head3 List
197    
198  C<< my @marks = $marks->List(); >>      my @marks = $marks->List();
199    
200  Return a list of this feature's markups. The value returned is a sorted list  Return a list of this feature's markups. The value returned is a sorted list
201  of 3-tuples. Each 3-tuple consists of the offset to the start of the markup,  of 3-tuples. Each 3-tuple consists of the offset to the start of the markup,
# Line 214  Line 214 
214    
215  =head3 Save  =head3 Save
216    
217  C<< $marks->Save(); >>      $marks->Save();
218    
219  Save this markup list. The markups will be written back to disk or to a database,  Save this markup list. The markups will be written back to disk or to a database,
220  depending on the nature of the incoming access object.  depending on the nature of the incoming access object.
# Line 232  Line 232 
232    
233  =head3 Render  =head3 Render
234    
235  C<< my $proteinHtml = $marks->Render($id, $lineWidth); >>      my $proteinHtml = $marks->Render($id, $lineWidth);
236    
237  Render the feature's protein translation using the specified markups. The translation will  Render the feature's protein translation using the specified markups. The translation will
238  be converted to HTML, with C<SPAN> tags used to alter the display of the marked-up areas. If  be converted to HTML, with C<SPAN> tags used to alter the display of the marked-up areas. If
# Line 365  Line 365 
365    
366  =head3 GetLabels  =head3 GetLabels
367    
368  C<< my @labels = Markups::GetLabels(); >>      my @labels = Markups::GetLabels();
369    
370  Return a list of the valid markup labels. These are computed from reading the appropriate style file.  Return a list of the valid markup labels. These are computed from reading the appropriate style file.
371    
# Line 395  Line 395 
395    
396  =head3 Compare  =head3 Compare
397    
398  C<< my $cmp = Markups::Compare($a, $b); >>      my $cmp = Markups::Compare($a, $b);
399    
400  Compare two markup entries for sorting. Markup entries are sorted by ascending start location  Compare two markup entries for sorting. Markup entries are sorted by ascending start location
401  followed by descending length. This is exactly the ideal order for rendering the markups.  followed by descending length. This is exactly the ideal order for rendering the markups.
# Line 444  Line 444 
444    
445  =head3 Clear  =head3 Clear
446    
447  C<< my  = $marks->Clear(); >>      my  = $marks->Clear();
448    
449  Delete all the markups.  Delete all the markups.
450    
# Line 461  Line 461 
461    
462  =head3 Find  =head3 Find
463    
464  C<< my ($loc, $flag) = Markups::_Find($list, $entry); >>      my ($loc, $flag) = Markups::_Find($list, $entry);
465    
466  Find the proper location for a markup entry in a markup list.  Find the proper location for a markup entry in a markup list.
467    

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3