Class: DataSeries<T>

• new DataSeries&lt;T&amp;gt;(options)

• new DataSeries<T>(options?)

AbstractDataSeries&lt;T&amp;gt;.constructor

▸ addChild(data): DataSeries<T>

Add a child object

DataSeries<T>

this

AbstractDataSeries.addChild

▸ addProperties(properties): DataSeries<T>

Add additional properties

DataSeries<T>

this

AbstractDataSeries.addProperties

▸ addValue(value): DataSeries<T>

Adds a value to the data series.

DataSeries<T>

this

▸ addValues(array): DataSeries<T>

Adds an array of values to the data series.

DataSeries<T>

this

▸ calculate(name): any

Run function. See available formulas list by DataSeries.getFormulas

any

▸ clearChildren(): DataSeries<T>

Remove all child data

DataSeries<T>

this

AbstractDataSeries.clearChildren

▸ clearValues(): DataSeries<T>

Clears all values of the data series.

DataSeries<T>

this

▸ clone(copyData?): DataObject

All subclasses should override copyConstructor or provide custom implementation for this method

DataObject

clone

AbstractDataSeries.clone

▸ Protected convertValues<U>(values, fromUnit?, toUnit?): U

Converts values from one unit to another specified unit.

U

AbstractDataSeries.convertValues

▸ Protected copyConstructor(src, copyData?): DataSeries<T>

Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.

DataSeries<T>

AbstractDataSeries.copyConstructor

▸ dispose(): void

Dispose data object and all children. Clear all listeners

void

AbstractDataSeries.dispose

▸ getChild(i): DataObject

Return data by index

DataObject

child

AbstractDataSeries.getChild

▸ getChildren(filter?): Iterator<DataObject>

Return iterator by child data objects

Iterator<DataObject>

AbstractDataSeries.getChildren

▸ getChildrenCount(): number

Return number of child data

number

AbstractDataSeries.getChildrenCount

▸ getClassName(): string

string

AbstractDataSeries.getClassName

▸ getDataOrder(): Order

Returns data ordering of the data series.

Order

AbstractDataSeries.getDataOrder

▸ getId(): string | number

Returns the identifier of the data series.

string | number

AbstractDataSeries.getId

▸ getLength(): number

Returns the number of values in the data series.

number

AbstractDataSeries.getLength

▸ getName(): string

Returns data object name

string

AbstractDataSeries.getName

▸ getParent(): DataObject

Gets parent data item

DataObject

AbstractDataSeries.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

JSON options object

AbstractDataSeries.getProperties

▸ getProperty(name): any

Gets property by name

any

AbstractDataSeries.getProperty

▸ Protected getTimeStamp(): number

Returns the timestamp of the data series.

number

AbstractDataSeries.getTimeStamp

▸ getType(): string

Returns data type

string

AbstractDataSeries.getType

▸ getUnit(): AbstractUnit

Returns unit of the data series.

AbstractUnit

unit

AbstractDataSeries.getUnit

▸ getUri(): string

Returns unique resource identifier

string

AbstractDataSeries.getUri

▸ getValue(index): T

Returns the value at given index.

T

AbstractDataSeries.getValue

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

AbstractDataSeries.hasEventListener

▸ hasProperty(name): boolean

Returns whether data object contains specific property

boolean

AbstractDataSeries.hasProperty

▸ indexOfChild(data): number

Return index of child data ( index of the specified child or -1 if data is not found)

number

AbstractDataSeries.indexOfChild

▸ insertChild(index, item, silent?): DataSeries<T>

Insert item by index

DataSeries<T>

this

AbstractDataSeries.insertChild

▸ insertValue(index, value): DataSeries<T>

Inserts a value at the specified index.

DataSeries<T>

this

▸ insertValues(index, array): DataSeries<T>

Inserts an array of values at the specified index.

DataSeries<T>

this

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractDataSeries.isDisposed

▸ isReadOnly(): boolean

Returns false

boolean

false

AbstractDataSeries.isReadOnly

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

AbstractDataSeries.isSilent

▸ notify<E>(type, source, args?): DataSeries<T>

Notify listeners

DataSeries<T>

this

AbstractDataSeries.notify

▸ off<E>(type?, callback?): DataSeries<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.

DataSeries<T>

this

AbstractDataSeries.off

▸ on<E>(type, callback): DataSeries<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.

DataSeries<T>

this

AbstractDataSeries.on

▸ onPropertyChanged(prop): DataSeries<T>

This method is called if property bag is changed using setProperty method

DataSeries<T>

this

AbstractDataSeries.onPropertyChanged

▸ 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

AbstractDataSeries.query

▸ removeChild(data, silent?): DataSeries<T>

Remove child data object

DataSeries<T>

this

AbstractDataSeries.removeChild

▸ removeValues(index, count?): DataSeries<T>

Removes a specified amount of values at the specified index.

DataSeries<T>

this

▸ reverseValues(): DataSeries<T>

Reverse values

DataSeries<T>

▸ set(index, item): DataObject

Sets item by index

DataObject

AbstractDataSeries.set

▸ setId(id): DataSeries<T>

Sets the identifier of the data series.

DataSeries<T>

this

AbstractDataSeries.setId

▸ setName(name): DataSeries<T>

Sets data object name

DataSeries<T>

this

AbstractDataSeries.setName

▸ setParent(parent): DataSeries<T>

Sets parent data item

DataSeries<T>

this

AbstractDataSeries.setParent

▸ setProperties(properties?): DataSeries<T>

Sets all the properties pertaining to this object

DataSeries<T>

this

AbstractDataSeries.setProperties

▸ setProperty(name, value): DataSeries<T>

Sets property by name

DataSeries<T>

this

AbstractDataSeries.setProperty

▸ setSilent(bool): DataSeries<T>

Set silent mode

DataSeries<T>

this

AbstractDataSeries.setSilent

▸ setType(type): DataSeries<T>

Sets data object type

DataSeries<T>

this

AbstractDataSeries.setType

▸ setUnit(unit?): DataSeries<T>

Sets unit of the data series.

DataSeries<T>

this

▸ setUri(uri): DataSeries<T>

Sets unique resource identifier

DataSeries<T>

this

AbstractDataSeries.setUri

▸ setValue(index, value): DataSeries<T>

Sets the value at given index.

DataSeries<T>

this

▸ setValues(array, copy?): DataSeries<T>

Sets an array of values to the data series.

DataSeries<T>

this

▸ toArray(copy?, unit?): T[]

Returns an array of objects in the data series.

T[]

AbstractDataSeries.toArray

▸ update(args?): DataSeries<T>

Notifies the data series has been updated. The timestamp will be updated and Events.Updated event will be fired.

Fires

Events.Updated

DataSeries<T>

this

AbstractDataSeries.update

▸ Protected updateTimeStamp(): DataSeries<T>

Updates timestamp of the data series.

DataSeries<T>

AbstractDataSeries.updateTimeStamp

▸ updating(args?): DataSeries<T>

Notifies the data series has been started updating. The Events.Updating event will be fired.

Fires

Events.Updating

DataSeries<T>

this

AbstractDataSeries.updating

▸ Static getClassName(): string

string

AbstractDataSeries.getClassName

▸ Static getFormulaDescription(name?): string

Get formula's description

string

▸ 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'

void