Commit 06c51ac6 authored by Sascha Herzinger's avatar Sascha Herzinger
Browse files

added some documentation

parent 45a60f2c
Pipeline #6913 passed with stages
in 6 minutes and 1 second
{
"name": "fractalis",
"version": "1.2.10-test",
"version": "1.2.12",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
......@@ -5218,25 +5218,6 @@
"integrity": "sha1-mMI9qxF1ZXuMBXPozszZGw/xjIQ=",
"dev": true
},
"fractalis": {
"version": "1.2.10-test",
"resolved": "https://registry.npmjs.org/fractalis/-/fractalis-1.2.10-test.tgz",
"integrity": "sha512-BMaa6Ol/36nv+uKWrIMKSZoKiSAlpI03tBa0Yk6Bp2aUF0AxWpfTlTblRftvF2EcB3bQ8FpydHvlae3nkErj+A==",
"requires": {
"@babel/runtime": "7.0.0-beta.46",
"axios": "0.16.1",
"d3": "4.13.0",
"deep-freeze-strict": "1.1.1",
"html2canvas": "1.0.0-alpha.12",
"lodash": "4.17.5",
"resize-observer-polyfill": "1.5.0",
"tippy.js": "2.2.2",
"uuid": "3.2.1",
"vue": "2.5.13",
"vue-async-computed": "3.3.1",
"vuex": "3.0.1"
}
},
"fragment-cache": {
"version": "0.2.1",
"resolved": "https://registry.npmjs.org/fragment-cache/-/fragment-cache-0.2.1.tgz",
......
......@@ -17,7 +17,6 @@ class FractalJS {
this._versionCheck()
}
// noinspection JSMethodCanBeStatic
async _versionCheck () {
const rv = await store.getters.requestManager.getVersion()
const fractaljsVersions = version.split('.')
......@@ -32,47 +31,72 @@ class FractalJS {
}
}
// noinspection JSMethodCanBeStatic
/**
* Trigger ETL processes for the given list of descriptors to populate the data cache.
* @param descriptors {[object]}. Descriptors that contain information for the ETLs. (Depends on ETL implementation).
* @returns {promise}
*/
loadData (descriptors) {
return store.getters.requestManager.createData(descriptors)
}
// noinspection JSMethodCanBeStatic
/**
* Put chart into a container identified by selector.
* A list of charts can be obtained by {@link getAvailableCharts}.
* IMPORTANT: Make sure that the container has a relative or fixed height/width (e.g. width: 10vw)
* @param chart {string}
* @param selector {string} CSS selector (of div that will contain the chart.)
* @returns {Vue}
*/
setChart (chart, selector) {
return store.getters.chartManager.setChart(chart, selector)
}
// noinspection JSMethodCanBeStatic
/**
* Remove all charts.
* IMPORTANT: This does not remove the surrounding containers!
*/
removeAllCharts () {
return store.getters.chartManager.removeAllCharts()
store.getters.chartManager.removeAllCharts()
}
// noinspection JSMethodCanBeStatic
/**
* Returns list of available charts types that can be used as arguments for {@link setChart}.
* @returns {[string]}
*/
getAvailableCharts () {
return store.getters.chartManager.getAvailableCharts()
}
// noinspection JSMethodCanBeStatic
/**
* Clear data cache.
* @returns {promise}
*/
clearCache () {
return store.getters.requestManager.deleteAllData()
}
// noinspection JSMethodCanBeStatic
/**
* Set list of lists of ids (subsets / cohorts) that will be applied to all charts.
* Example: [caseGroupIds, controlGroupIds]
* By default all ids are in one group.
* @param subsets {[[number]]}
*/
setSubsets (subsets) {
store.dispatch('setSubsets', subsets)
}
// noinspection JSMethodCanBeStatic
/**
* Undo all previous subset selections. {@link setSubsets}.
*/
deleteSubsets () {
store.dispatch('setSubsets', [])
}
// noinspection JSMethodCanBeStatic
chart2id (vm, callback) {
return store.getters.stateManager.chart2id(vm, callback)
}
// noinspection JSMethodCanBeStatic
id2chart (selector, stateID) {
return store.getters.stateManager.id2chart(selector, stateID)
}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment