new epiviz.measurements.Measurement(id, name, type, datasourceId, datasourceGroup, dataprovider, formula, defaultChartType, annotation, minValue, maxValue, metadata)
measurements/measurement.js, line 25
Name | Type | Description |
---|---|---|
id |
string | |
name |
string | |
type |
epiviz.measurements.Measurement.Type | |
datasourceId |
string | |
datasourceGroup |
string | |
dataprovider |
string | |
formula |
Object | optional |
defaultChartType |
string | optional |
annotation |
Object.<string, string> | optional |
minValue |
number | optional |
maxValue |
number | optional |
metadata |
Array.<string> | optional |
Members
-
staticepiviz.measurements.Measurement.Typestring
-
Properties:
Name Type Default Description FEATURE
string feature RANGE
string range UNORDERED
string unordered
Methods
-
staticepiviz.measurements.Measurement.fromRawObject(o, measurements){epiviz.measurements.Measurement}
measurements/measurement.js, line 380 -
Name Type Description o
Object measurements
Array.<epiviz.measurements.Measurement> optional This argument is used in conjunction with o.formula. If that is null, then this parameter is ignored.
Returns:
Type Description epiviz.measurements.Measurement -
annotation(){Object.<string, string>}
measurements/measurement.js, line 263 -
Returns:
Type Description Object.<string, string> -
componentMeasurements(){epiviz.measurements.MeasurementSet}
measurements/measurement.js, line 294Gets a set of all independent measurements needed to compute this measurement.
-
Gets a set of all independent measurements needed to compute this measurement. If the measurement is independent, then the returned set contains this measurement only.
Returns:
Type Description epiviz.measurements.MeasurementSet -
dataprovider(){string}
measurements/measurement.js, line 186 -
Returns:
Type Description string -
datasource(){epiviz.measurements.Measurement}
measurements/measurement.js, line 165 -
Returns:
Type Description epiviz.measurements.Measurement -
datasourceGroup(){string}
measurements/measurement.js, line 179 -
Returns:
Type Description string -
datasourceId(){string}
measurements/measurement.js, line 172 -
Returns:
Type Description string -
defaultChartType(){string}
measurements/measurement.js, line 256 -
Returns:
Type Description string -
evaluate(values)
measurements/measurement.js, line 221 -
Name Type Description values
epiviz.measurements.MeasurementHashtable.<number> A map between each of the component measurements and their corresponding values. See epiviz.measurements.Measurement.prototype.componentMeasurements() for more.
-
formula(){Object}
measurements/measurement.js, line 193 -
Returns:
Type Description Object -
formulaStr(){string}
measurements/measurement.js, line 200 -
Returns:
Type Description string -
id(){string}
measurements/measurement.js, line 144 -
Returns:
Type Description string -
isComputed(){boolean}
measurements/measurement.js, line 314 -
Returns:
Type Description boolean -
maxValue(){number}
measurements/measurement.js, line 277 -
Returns:
Type Description number -
metadata(){Array.<string>}
measurements/measurement.js, line 284 -
Returns:
Type Description Array.<string> -
minValue(){number}
measurements/measurement.js, line 270 -
Returns:
Type Description number -
name(){string}
measurements/measurement.js, line 151 -
Returns:
Type Description string -
raw(measurementsIndexMap){Object}
measurements/measurement.js, line 321 -
Name Type Description measurementsIndexMap
epiviz.measurements.MeasurementHashtable.<number> Returns:
Type Description Object -
toString(){string}
measurements/measurement.js, line 358 -
Returns:
Type Description string -
type(){epiviz.measurements.Measurement.Type}
measurements/measurement.js, line 158 -
Returns:
Type Description epiviz.measurements.Measurement.Type