Class: EpivizApiDataProvider

EpivizApiDataProvider

new epiviz.data.EpivizApiDataProvider(id, serverEndpoint, measurementAnnotations, maxDepth, selectedLevels)

data/epiviz-api-data-provider.js, line 19
Name Type Description
id string
serverEndpoint string
measurementAnnotations Array.<string> optional
maxDepth number optional
selectedLevels Object.<number, number> optional

Extends

Classes

Request
Response

Members

staticepiviz.data.EpivizApiDataProvider.REQUEST_MAPPINGObject.<string, string>

Methods

getData(request, callback)

data/epiviz-api-data-provider.js, line 86
Name Type Description
request epiviz.data.Request
callback function

inherited id(){string}

data/data-provider.js, line 117
Returns:
Type Description
string

inherited onRequestAddChart(){epiviz.events.Event.<{type: string, visConfigSelection: epiviz.ui.controls.VisConfigSelection, result: epiviz.events.EventResult.<{id: string}>}>}

data/data-provider.js, line 158

The type argument is a string denoting the complete class name of the chart to be used.

The type argument is a string denoting the complete class name of the chart to be used. For example: 'epiviz.plugins.charts.BlocksTrack'.

Returns:
Type Description
epiviz.events.Event.<{type: string, visConfigSelection: epiviz.ui.controls.VisConfigSelection, result: epiviz.events.EventResult.<{id: string}>}>

inherited onRequestAddMeasurements(){epiviz.events.Event.<{measurements: epiviz.measurements.MeasurementSet, result: epiviz.events.EventResult}>}

data/data-provider.js, line 145

Fired whenever the data provider requests the UI to add new measurements

.

Fired whenever the data provider requests the UI to add new measurements

Returns:
Type Description
epiviz.events.Event.<{measurements: epiviz.measurements.MeasurementSet, result: epiviz.events.EventResult}>

inherited onRequestAddSeqInfos(){epiviz.events.Event.<{seqInfos: Array.<Array>, result: epiviz.events.EventResult}>}

data/data-provider.js, line 134

seqInfos: an array of raw seqInfos, which consist of 3-element arrays: name, min and max

.

seqInfos: an array of raw seqInfos, which consist of 3-element arrays: name, min and max

Returns:
Type Description
epiviz.events.Event.<{seqInfos: Array.<Array>, result: epiviz.events.EventResult}>

inherited onRequestClearDatasourceGroupCache(){epiviz.events.Event.<{datasourceGroup: string, result: epiviz.events.EventResult}>}

data/data-provider.js, line 173
Returns:
Type Description
epiviz.events.Event.<{datasourceGroup: string, result: epiviz.events.EventResult}>

inherited onRequestCurrentLocation(){epiviz.events.Event.<{result: epiviz.events.EventResult}>}

data/data-provider.js, line 188
Returns:
Type Description
epiviz.events.Event.<{result: epiviz.events.EventResult}>

inherited onRequestFlushCache(){epiviz.events.Event.<{result: epiviz.events.EventResult}>}

data/data-provider.js, line 168
Returns:
Type Description
epiviz.events.Event.<{result: epiviz.events.EventResult}>

inherited onRequestGetAvailableCharts(){epiviz.events.Event.<{result: epiviz.events.EventResult}>}

data/data-provider.js, line 208
Returns:
Type Description
epiviz.events.Event.<{result: epiviz.events.EventResult}>

inherited onRequestGetChartSettings(){epiviz.events.Event.<{result: epiviz.events.EventResult}>}

data/data-provider.js, line 198
Returns:
Type Description
epiviz.events.Event.<{result: epiviz.events.EventResult}>

inherited onRequestNavigate(){epiviz.events.Event.<{range: epiviz.datatypes.GenomicRange, result: epiviz.events.EventResult}>}

data/data-provider.js, line 178
Returns:
Type Description
epiviz.events.Event.<{range: epiviz.datatypes.GenomicRange, result: epiviz.events.EventResult}>

inherited onRequestPrintWorkspace(){epiviz.events.Event.<{result: epiviz.events.EventResult}>}

data/data-provider.js, line 193
Returns:
Type Description
epiviz.events.Event.<{result: epiviz.events.EventResult}>

inherited onRequestRedraw(){epiviz.events.Event.<{result: epiviz.events.EventResult}>}

data/data-provider.js, line 183
Returns:
Type Description
epiviz.events.Event.<{result: epiviz.events.EventResult}>

inherited onRequestRemoveChart(){epiviz.events.Event.<{id: string, result: epiviz.events.EventResult}>}

data/data-provider.js, line 163
Returns:
Type Description
epiviz.events.Event.<{id: string, result: epiviz.events.EventResult}>

inherited onRequestRemoveMeasurements(){epiviz.events.Event.<{measurements: epiviz.measurements.MeasurementSet, result: epiviz.events.EventResult}>}

data/data-provider.js, line 151

Fired whenever the data provider requests the UI to remove measurements

.

Fired whenever the data provider requests the UI to remove measurements

Returns:
Type Description
epiviz.events.Event.<{measurements: epiviz.measurements.MeasurementSet, result: epiviz.events.EventResult}>

inherited onRequestRemoveSeqNames(){epiviz.events.Event.<{seqNames: Array.<string>, result: epiviz.events.EventResult}>}

data/data-provider.js, line 139
Returns:
Type Description
epiviz.events.Event.<{seqNames: Array.<string>, result: epiviz.events.EventResult}>

inherited onRequestSetChartSettings(){epiviz.events.Event.<{result: epiviz.events.EventResult}>}

data/data-provider.js, line 203
Returns:
Type Description
epiviz.events.Event.<{result: epiviz.events.EventResult}>
comments powered by Disqus