Class Biojs.InteractionsTable

Version 1.0.0.

Extends Biojs.Table.

Defined in: Biojs.InteractionsTable.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Biojs.InteractionsTable(options) Table to show binary molecular interactions.

Field Summary
Field Attributes	Field Name and Description
<inner>	eventTypes Array containing the supported event names
<inner>	opt Default values for the options

Method Summary
Method Attributes	Method Name and Description
	constructor(options)
	getQuery() Get the actual query.
	setDataSource(dataSet) Rebuild the table
	setQuery(columns) Do a query to PSICQUIC server by using the provided query in MIQL.

Methods borrowed from class Biojs.Table:: addDataRow, getProxy, getProxyDataType, getSelectedRows, getTotalRecords, hideColumns, orderBy, removeDataRow, showColumns, toggleColumns
Methods borrowed from class Biojs:: addListener, extend, getId, listen, raiseEvent, setEventHandlers, setOptions

Events borrowed from class Biojs.Table:: onCellClicked, onDataArrived, onHeaderClicked, onRowSelected

Class Detail

Biojs.InteractionsTable(options)

Table to show binary molecular interactions.
Author: John Gomez.

var myTable = new Biojs.InteractionsTable({
 	target: "YourOwnDivId",
 	dataSet: {
 		psicquicUrl: 'http://www.ebi.ac.uk/Tools/webservices/psicquic/intact/webservices/current/search/query',
 		proxyUrl: '../biojs/dependencies/proxy/proxy.php',
 		query: "brca2",
         version: "MITAB_VERSION_2_5",
         filter: false
     },
     rowSelection: true
});

Parameters:
{Object} options: An object with the options for InteractionTable' component.

Options detailed:

{string[][]|Object} dataSet

Either 2D string array containing the whole data to be displayed or a plain object defining the data source.

   {
		url: <url>,
		proxyUrl: <proxy>,
		paramsMap: { "iDisplayStart": <newName1>, "iDisplayLength": <newName2>, ... },
		filter: <flag>,
		version: <MITAB_VERSION>,
     totalRecords:<number>
   }

where:

url is string containing the url data source.
paramsMap Customize the name of the following params which will be passed to server:
- iDisplayStart: index of the first expected record for paging.
- iDisplayLength: size of the fetched data (page size).
- sSearch: filter string entered by the user in case of filter is enabled.
filter is a boolean to show/hide the search box on the table top. The entered string will be passed to the server by means of 'sSearch' parameter. Personalize the parameter name using paramsMap.
proxyUrl optional string containing the url of the proxy in case of needing access to server through a proxy.
version either string or integer containing the version of MITAB format as follows:
- "MITAB_VERSION_2_5" or 15: to set MITAB format v2.5
- "MITAB_VERSION_2_5_EXT" or 31: to set MITAB format v2.5 extended
- "MITAB_VERSION_2_6" or 36: to set MITAB format v2.6
- "MITAB_VERSION_2_7" or 42: to set MITAB format v2.7
totalRecords integer containing the number of total records. MITAB format does not contains this value on the response. You must do a request to ask for it.

   {
		psiquicUrl: 'http://www.ebi.ac.uk/Tools/webservices/psicquic/intact/webservices/current/search/query',
		proxyUrl: '../biojs/dependencies/proxy/proxy.php',
     version: "MITAB_VERSION_2_5_EXT",
     query: "species:human",
     filter: false
   }

   ...soon

Field Detail

<inner> eventTypes

Array containing the supported event names

<inner> opt

Default values for the options

Method Detail

constructor(options)

Parameters:
options

{string} getQuery()

Get the actual query. Uses the structure of the URL to fetch data from PSICQUIC.

alert( "The query is " + myTable.getQuery() );

Returns:: {string} Current query.

setDataSource(dataSet)

Rebuild the table

myTable.setDataSource({
		psicquicUrl: 'http://www.ebi.ac.uk/Tools/webservices/psicquic/intact/webservices/current/search/query',
 	proxyUrl: '../biojs/dependencies/proxy/proxy.php',
 	query: "pubid:(10837477 OR 12029088)",
     version: "MITAB_VERSION_2_5",
     filter: false
});

Parameters:
dataSet

setQuery(columns)

Do a query to PSICQUIC server by using the provided query in MIQL. Uses the structure of the URL to fetch data from PSICQUIC.

myTable.setQuery("species:human");

Parameters:
{string} columns: Column indexes to be hided.

Classes

Class Biojs.InteractionsTable