API / geotoolkit / data / CalculatedDataSeries / CalculatedDataSeries
data.CalculatedDataSeries.CalculatedDataSeries
Read-only data series view which calculates values, depending on other series
Example
// using callback
const ds1 = new NumericalDataSeries({'data': [1, 4, 6, 7]}).setName('alfa');
const ds2 = new NumericalDataSeries({'data': [1, 4, 6, 7]}).setName('beta');
const calcds = new CalculatedDataSeries({
'name': 'calculated',
'sources': [ds1, ds2],
'formula': (val) => val('alfa') + val('beta')
});Example
// using string
const ds1 = new NumericalDataSeries({'data': [1, 4, 6, 7]}).setName('alfa');
const ds2 = new NumericalDataSeries({'data': [1, 4, 6, 7]}).setName('beta');
const calcds = new CalculatedDataSeries({
'name': 'calculated',
'sources': [ds1, ds2],
'formula': '2 * alfa + beta'
});| Name | Type |
|---|---|
T | any |
DataSeries<T>↳
CalculatedDataSeries
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
id | number | string | Unique id of the data series |
name | string | Name |
type | string | Type |
unit | string | Unit of the data series |
uri | string | Unique resource identifier |
Constructors
• new CalculatedDataSeries<T>(options?)
| Name | Type |
|---|---|
T | any |
| Name | Type |
|---|---|
Optional options | Options<T> |
DataSeries<T&gt;.constructor
Methods
▸ addChild(data): CalculatedDataSeries<T>
Add a child object
| Name | Type | Description |
|---|---|---|
data | DataObject | DataObject[] | the child data to be added |
this
▸ addProperties(properties): CalculatedDataSeries<T>
Add additional properties
| Name | Type | Description |
|---|---|---|
properties | Record<string, any> | additional properties of the dataobject |
this
▸ addValue(value): CalculatedDataSeries<T>
Does nothing
| Name | Type | Description |
|---|---|---|
value | T | a new value |
this
▸ addValues(array): CalculatedDataSeries<T>
Does nothing
| Name | Type | Description |
|---|---|---|
array | T[] | an array of values |
this
▸ calculate(name): any
Run function. See available formulas list by DataSeries.getFormulas
| Name | Type | Description |
|---|---|---|
name | string | name |
any
▸ clearChildren(): CalculatedDataSeries<T>
Remove all child data
this
▸ clearValues(): CalculatedDataSeries<T>
Does nothing
this
▸ clone(copyData?): DataObject
All subclasses should override copyConstructor or provide custom implementation for this method
| Name | Type | Description |
|---|---|---|
Optional copyData | boolean | flag to copy data |
clone
▸ Protected convertValues<U>(values, fromUnit?, toUnit?): U
Converts values from one unit to another specified unit.
| Name |
|---|
U |
| Name | Type | Description |
|---|---|---|
values | U | array of values or a single value |
Optional fromUnit | string | AbstractUnit | the original unit of the value(s) |
Optional toUnit | string | AbstractUnit | the unit to convert the value(s) to |
U
▸ Protected copyConstructor(src, copyData?): CalculatedDataSeries<T>
Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.
| Name | Type | Description |
|---|---|---|
src | CalculatedDataSeries<T> | Source to copy from |
Optional copyData | boolean | copy data |
▸ dispose(): void
Dispose data object and all children. Clear all listeners
void
▸ getChild(i): DataObject
Return data by index
| Name | Type | Description |
|---|---|---|
i | number | index of the data |
child
▸ getChildren(filter?): Iterator<DataObject>
Return iterator by child data objects
| Name | Type | Description |
|---|---|---|
Optional filter | (data: DataObject) => boolean | a filter function. Returns all child data objects if the value is null. |
▸ getChildrenCount(): number
Return number of child data
number
▸ getClassName(): string
string
▸ getDataOrder(): Order
Returns data ordering of the data series.
▸ getId(): string | number
Returns the identifier of the data series.
string | number
▸ getLength(): number
Returns the number of values in the data series.
number
▸ getName(): string
Returns data object name
string
▸ getParent(): DataObject
Gets parent data item
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
JSON options object
▸ getProperty(name): any
Gets property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
any
▸ Protected getTimeStamp(): number
Returns the timestamp of the data series.
number
▸ getType(): string
Returns data type
string
▸ getUnit(): AbstractUnit
Returns unit of the data series.
unit
▸ getUri(): string
Returns unique resource identifier
string
▸ getValue(index): T
Returns the value at given index.
| Name | Type | Description |
|---|---|---|
index | number | the index should be a number greater than or equal to zero, and less than the number of values as returned by getLength() method. |
T
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
▸ hasProperty(name): boolean
Returns whether data object contains specific property
| Name | Type | Description |
|---|---|---|
name | string | property name |
boolean
▸ indexOfChild(data): number
Return index of child data ( index of the specified child or -1 if data is not found)
| Name | Type | Description |
|---|---|---|
data | DataObject | data object to check index |
number
▸ insertChild(index, item, silent?): CalculatedDataSeries<T>
Insert item by index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
item | DataObject | node |
Optional silent | boolean | will not fire any events if true |
this
▸ insertValue(index, value): CalculatedDataSeries<T>
Does nothing
| Name | Type | Description |
|---|---|---|
index | number | the index number where to insert the value. |
value | T | the value to insert |
this
▸ insertValues(index, array): CalculatedDataSeries<T>
Does nothing
| Name | Type | Description |
|---|---|---|
index | number | the index number where to insert the values. Values will be added starting at the index number. |
array | T[] | the array of values to insert |
this
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isReadOnly(): boolean
Returns true
boolean
true
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): CalculatedDataSeries<T>
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | AbstractDataSeries<any> | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): CalculatedDataSeries<T>
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: CalculatedDataSeries<T>, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): CalculatedDataSeries<T>
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: CalculatedDataSeries<T>, args: EventMap[E]) => void | to be called |
this
▸ onPropertyChanged(prop): CalculatedDataSeries<T>
This method is called if property bag is changed using setProperty method
| Name | Type | Description |
|---|---|---|
prop | Object | property |
prop.name | string | |
prop.value | any |
this
▸ query(): QueryBuilder<any>
Query data item and child items by different conditions
Example
// Select by function
import {DataObject} from '@int/geotoolkit/data/DataObject';
const dataobject = new DataObject({'name': 'test', 'uri': 'testuri', 'type': 'testtype'});
const item1 = new DataObject({'name': 'item1', 'uri': 'item1', 'type': 'test'});
const item2 = new DataObject({'name': 'item2', 'uri': 'item2', 'type': 'test'});
dataobject.addChild([item1, item2]);
const item5 = new DataObject({'name': 'item5', 'uri': 'item5', 'type': 'test'});
item2.addChild(item5);
let founditem = null;
dataobject.query()
.where( (item: DataObject) => item.getParent() === dataobject)
.where( (item: DataObject) => item.getUri() === 'item2')
.select((item: DataObject) => {
founditem = item;
});Example
// Select by expression
dataobject.query()
.where( 'item => uri(item) == "item5"')
.select((item: DataObject) => {
founditem = item;
});QueryBuilder<any>
query object which has methods 'where' tp specify conditions, 'select' to run query, 'selectToArray' select results to array Expressions syntax: "item => expression", where expression:
- logical and arithmetic operators
- embedded functions: name(item) - gets name of the data object url(item) - gets url of the data object type(item) - gets type of the data object
▸ removeChild(data, silent?): CalculatedDataSeries<T>
Remove child data object
| Name | Type | Description |
|---|---|---|
data | DataObject | data object to be removed |
Optional silent | boolean | will not fire any events if true |
this
▸ removeValues(index, count?): CalculatedDataSeries<T>
Does nothing
| Name | Type | Description |
|---|---|---|
index | number | the index number where to start removing the values |
Optional count | number | the amount of values to remove |
this
▸ reverseValues(): CalculatedDataSeries<T>
Reverse values
▸ set(index, item): DataObject
Sets item by index
| Name | Type | Description |
|---|---|---|
index | number | index of the item |
item | DataObject | node |
▸ setFormula(formula?): CalculatedDataSeries<T>
Set formula. String version supports Math functions such as cos, sin, sqrt etc.
Example
const ds1 = new NumericalDataSeries({'data': [1.1, 1.4, 1.6, 1.7]}).setName('alfa');
const calcds = new CalculatedDataSeries({
'name': 'calculated',
'sources': [ds1]
});
calcds.setFormula('round(alfa)');| Name | Type | Description |
|---|---|---|
Optional formula | string | FormulaCallback<T> | callback or string to calculate values of the series |
▸ setId(id): CalculatedDataSeries<T>
Sets the identifier of the data series.
| Name | Type | Description |
|---|---|---|
id | string | number | a new identifier |
this
▸ setName(name): CalculatedDataSeries<T>
Sets data object name
| Name | Type | Description |
|---|---|---|
name | string | data object name |
this
▸ setParent(parent): CalculatedDataSeries<T>
Sets parent data item
| Name | Type | Description |
|---|---|---|
parent | DataObject | parent data item |
this
▸ setProperties(properties?): CalculatedDataSeries<T>
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options<any> | JSON options object |
this
▸ setProperty(name, value): CalculatedDataSeries<T>
Sets property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setSilent(bool): CalculatedDataSeries<T>
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setSources(sources?): CalculatedDataSeries<T>
Set sources
| Name | Type | Description |
|---|---|---|
Optional sources | AbstractDataSeries<T>[] | set of sources to be used by function |
this
▸ setType(type): CalculatedDataSeries<T>
Sets data object type
| Name | Type | Description |
|---|---|---|
type | string | data type |
this
▸ setUnit(unit?): CalculatedDataSeries<T>
Sets unit of the data series.
| Name | Type | Description |
|---|---|---|
Optional unit | string | AbstractUnit | unit to be set |
this
▸ setUri(uri): CalculatedDataSeries<T>
Sets unique resource identifier
| Name | Type | Description |
|---|---|---|
uri | string | unique identifier |
this
▸ setValue(index, value): CalculatedDataSeries<T>
Does nothing
| Name | Type | Description |
|---|---|---|
index | number | the index should be a number greater than or equal to zero, and less than the number of values as returned by getLength() method. |
value | T | value to set |
this
▸ setValues(array, copy?): CalculatedDataSeries<T>
Does nothing
| Name | Type | Description |
|---|---|---|
array | T[] | an array of values to set |
Optional copy | boolean | make a deep copy of the values |
this
▸ toArray(copy?, unit?): T[]
Returns an array of objects in the data series.
| Name | Type | Description |
|---|---|---|
Optional copy | boolean | whether creating a copy of data |
Optional unit | string | AbstractUnit | unit optional output unit to convert the data to. if not specified, data will not be converted |
T[]
▸ update(args?): CalculatedDataSeries<T>
Notifies the data series has been updated. The timestamp will be updated and Events.Updated event will be fired.
Fires
| Name | Type | Description |
|---|---|---|
Optional args | Object | event args |
args.count | number | |
args.index | number | |
args.type | StateChanges |
this
▸ Protected updateTimeStamp(): CalculatedDataSeries<T>
Updates timestamp of the data series.
▸ updating(args?): CalculatedDataSeries<T>
Notifies the data series has been started updating. The Events.Updating event will be fired.
Fires
| Name | Type | Description |
|---|---|---|
Optional args | Object | event args |
args.count | number | |
args.index | number | |
args.type | StateChanges |
this
▸ Static getClassName(): string
string
▸ Static getFormulaDescription(name?): string
Get formula's description
| Name | Type | Description |
|---|---|---|
Optional name | string | name of function |
string
DataSeries.getFormulaDescription
▸ Static getFormulas(): string[]
List formulas
string[]
▸ Static setFormula(name, func?, desc?): void
Set function which can be used to calculate some value (e.g. sum, avg etc.)
Example
DataSeries.setFormula('concat', (series) => {
return series.toArray().join(' ');
});
const series = new DataSeries({
'type': 'string',
'data': ['just', 'some', 'text']
});
console.log(series.calculate('concat')); // 'just some text'| Name | Type | Description |
|---|---|---|
name | string | FormulaDescription | name of function or parameters object |
Optional func | Formula | handler, use null to unset |
Optional desc | string | description |
void