Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Integrated Genome Browser contains a Bookmarks REST endpoint external programs can use to control IGB.

This endpoint was originally developed for users to record genome locations and data sets that they might want to come back to. It was also developed to enable Web sites to embed links to IGB. 

IGB bookmarks endpoint is: 

http://localhost:7085/IGBControl

Required parameters - one per bookmark

 

version: Genome version. e.g. version=H_sapiens_Mar_2006

...

end: End position on the sequence. e.g. end=52983241

(Start and end position are used to zoom on the coordinates)

loadresidues :- Boolean value trigger residue loading between given start and end. loadresidues: Indicates whether sequence bases should also be loaded, e.g. loadresidues=false

 

To load a dataset, use the "feature" parameters. Each "feature" corresponds to a data set track within IGB. 

Required Properties - one per feature

server_url :- List of servers to be enabled before looking for the features. e.g. http%3A%2F%2Fbioviz.org%2Fdas2%2FgenomeIGB attempts to access the data files indicated in the bookmark (see below).

query_url :- URLs of features to be loaded.  e.g. http%3A%2F%2Fbioviz.org%2Fdas2%2Fgenome%2FA_thaliana_Jun_2009%2FEST%2B%2528multiple%2Bmap%2529 

Optional properties (per track)

feature_url_0 :- Url of feature to which the track belongs to. e.g. feature_url_0=http%3A%2F%2Figbquickload.org%2Fquickload%2FA_thaliana_Jun_2009%2FTAIR10_mRNA.bed.gz

...

sym_bg_0 :- Background color of track in hexadecimal. e.g. sym_bg_0=0x000000

sym_name_0 :- Preferred human user-friend display name for the track. e.g sym_name_0=TAIR10+mRNA

(For multiple optional properties corresponding names would be sym_method_1, sym_yheight_1, sym_method_2, sym_yheight_2 etc.)Following optional

Optional properties

...

- graphs only

graph_float_0 :- Boolean value to indicate if graph should be floating. e.g. graph_float_0=false

...