Class: Request

Request

new epiviz.data.Request(id, args, method)

data/request.js, line 15
Name Type Description
id number
args Object.<string, string>
method epiviz.data.Request.Method optional

Members

staticepiviz.data.Request.Actionstring

Properties:
Name Type Default Description
GET_ROWS string getRows
GET_VALUES string getValues
GET_COMBINED string getCombined
GET_MEASUREMENTS string getMeasurements
SEARCH string search
GET_SEQINFOS string getSeqInfos
SAVE_WORKSPACE string saveWorkspace
DELETE_WORKSPACE string deleteWorkspace
GET_WORKSPACES string getWorkspaces
GET_HIERARCHY string getHierarchy
PROPAGATE_HIERARCHY_CHANGES string propagateHierarchyChanges
GET_CHART_SETTINGS string getChartSettings
SET_CHART_SETTINGS string setChartSettings
GET_AVAILABLE_CHARTS string getAvailableCharts
ADD_MEASUREMENTS string addMeasurements
REMOVE_MEASUREMENTS string removeMeasurements
ADD_SEQINFOS string addSeqInfos
REMOVE_SEQNAMES string removeSeqNames
ADD_CHART string addChart
REMOVE_CHART string removeChart
CLEAR_DATASOURCE_GROUP_CACHE string clearDatasourceGroupCache
FLUSH_CACHE string flushCache
NAVIGATE string navigate
REDRAW string redraw
GET_CURRENT_LOCATION string getCurrentLocation
WRITE_DEBUG_MSG string writeMsg
PRINT_WORKSPACE string printWorkspace
REGISTER_CHART_TYPES string registerChartTypes

staticepiviz.data.Request.Methodstring

Properties:
Name Type Default Description
GET string get
POST string post

Methods

staticepiviz.data.Request.createRequest(args, method){epiviz.data.Request}

data/request.js, line 87
Name Type Description
args Object.<string, string>

A map with the arguments for the request

method epiviz.data.Request.Method optional
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.deleteWorkspace(workspace){epiviz.data.Request}

data/request.js, line 303
Name Type Description
workspace epiviz.workspaces.Workspace
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.emptyRequest(){epiviz.data.Request}

data/request.js, line 184
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.fromRawObject(o){epiviz.data.Request}

data/request.js, line 99
Name Type Description
o Object
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.getCombined(measurementsByDatasource, range){epiviz.data.Request}

data/request.js, line 227
Name Type Description
measurementsByDatasource Object.<string, epiviz.measurements.MeasurementSet>
range epiviz.datatypes.GenomicRange
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.getHierarchy(datasourceGroup, nodeId){epiviz.data.Request}

data/request.js, line 331
Name Type Description
datasourceGroup string
nodeId string optional
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.getMeasurements(){epiviz.data.Request}

data/request.js, line 252
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.getRows(datasource, range){epiviz.data.Request}

data/request.js, line 193
Name Type Description
datasource epiviz.measurements.Measurement
range epiviz.datatypes.GenomicRange optional
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.getSeqInfos(){epiviz.data.Request}

data/request.js, line 276
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.getValues(measurement, range){epiviz.data.Request}

data/request.js, line 210
Name Type Description
measurement epiviz.measurements.Measurement
range epiviz.datatypes.GenomicRange optional
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.getWorkspaces(filter, requestWorkspaceId){epiviz.data.Request}

data/request.js, line 317
Name Type Description
filter
requestWorkspaceId
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.propagateHierarchyChanges(datasourceGroup, selection, order, selectedLevels){epiviz.data.Request}

data/request.js, line 347
Name Type Description
datasourceGroup string
selection Object.<string, epiviz.ui.charts.tree.NodeSelectionType> optional
order Object.<string, number> optional
selectedLevels Object.<number, number> optional
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.saveWorkspace(workspace, config){epiviz.data.Request}

data/request.js, line 288
Name Type Description
workspace epiviz.workspaces.Workspace
config epiviz.Config
Returns:
Type Description
epiviz.data.Request

staticepiviz.data.Request.search(query, maxResults){epiviz.data.Request}

data/request.js, line 264
Name Type Description
query string
maxResults number
Returns:
Type Description
epiviz.data.Request

get(arg){string}

data/request.js, line 166
Name Type Description
arg
Returns:
Type Description
string

id(){number}

data/request.js, line 112
Returns:
Type Description
number

isEmpty(){boolean}

data/request.js, line 153
Returns:
Type Description
boolean

joinArgs(keyValGlue, argGlue){string}

data/request.js, line 131

Concatenates all arguments in the request into one string.

Concatenates all arguments in the request into one string. By default, the result will have the following format: =&=...

Name Type Description
keyValGlue string optional

The token used to join keys and values; by default, this is '='

argGlue string optional

The token used to join different arguments together; by default, this is '&'

Returns:
Type Description
string

method(){epiviz.data.Request.Method}

data/request.js, line 122
Returns:
Type Description
epiviz.data.Request.Method

raw(){Object}

data/request.js, line 173
Returns:
Type Description
Object

type(){epiviz.data.MessageType}

data/request.js, line 117
Returns:
Type Description
epiviz.data.MessageType
comments powered by Disqus