Class: AbstractDataSeries<T>

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

• Protected new AbstractDataSeries<T>(options?)

DataObject.constructor

▸ addChild(data): AbstractDataSeries<T>

Add a child object

AbstractDataSeries<T>

this

DataObject.addChild

▸ addProperties(properties): AbstractDataSeries<T>

Add additional properties

AbstractDataSeries<T>

this

DataObject.addProperties

▸ clearChildren(): AbstractDataSeries<T>

Remove all child data

AbstractDataSeries<T>

this

DataObject.clearChildren

▸ clone(copyData?): DataObject

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

DataObject

clone

DataObject.clone

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

Converts values from one unit to another specified unit.

U

▸ Protected copyConstructor(src): AbstractDataSeries<T>

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

AbstractDataSeries<T>

this

DataObject.copyConstructor

▸ dispose(): void

Dispose data object and all children. Clear all listeners

void

DataObject.dispose

▸ getChild(i): DataObject

Return data by index

DataObject

child

DataObject.getChild

▸ getChildren(filter?): Iterator<DataObject>

Return iterator by child data objects

Iterator<DataObject>

DataObject.getChildren

▸ getChildrenCount(): number

Return number of child data

number

DataObject.getChildrenCount

▸ getClassName(): string

string

DataObject.getClassName

▸ getDataOrder(): Order

Returns data ordering of the data series.

Order

▸ getId(): string | number

Returns the identifier of the data series.

string | number

▸ Abstract getLength(): number

Returns the number of values in the data series.

number

▸ getName(): string

Returns data object name

string

DataObject.getName

▸ getParent(): DataObject

Gets parent data item

DataObject

DataObject.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

JSON options object

DataObject.getProperties

▸ getProperty(name): any

Gets property by name

any

DataObject.getProperty

▸ Protected getTimeStamp(): number

Returns the timestamp of the data series.

number

▸ getType(): string

Returns data type

string

DataObject.getType

▸ Abstract getUnit(): AbstractUnit

Returns unit of the data series.

AbstractUnit

unit

▸ getUri(): string

Returns unique resource identifier

string

DataObject.getUri

▸ Abstract getValue(index): T

Returns the value at the given index. The type of the returned value depends on the data series type.

T

▸ hasEventListener(type, callback?): boolean

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

boolean

DataObject.hasEventListener

▸ hasProperty(name): boolean

Returns whether data object contains specific property

boolean

DataObject.hasProperty

▸ indexOfChild(data): number

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

number

DataObject.indexOfChild

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

Insert item by index

AbstractDataSeries<T>

this

DataObject.insertChild

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

DataObject.isDisposed

▸ Abstract isReadOnly(): boolean

Returns whether the data series is immutable and cannot be changed.

boolean

▸ isSilent(): boolean

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

boolean

DataObject.isSilent

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

Notify listeners

AbstractDataSeries<T>

this

DataObject.notify

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

AbstractDataSeries<T>

this

DataObject.off

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

AbstractDataSeries<T>

this

DataObject.on

▸ onPropertyChanged(prop): AbstractDataSeries<T>

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

AbstractDataSeries<T>

this

DataObject.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

DataObject.query

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

Remove child data object

AbstractDataSeries<T>

this

DataObject.removeChild

▸ set(index, item): DataObject

Sets item by index

DataObject

DataObject.set

▸ setId(id): AbstractDataSeries<T>

Sets the identifier of the data series.

AbstractDataSeries<T>

this

▸ setName(name): AbstractDataSeries<T>

Sets data object name

AbstractDataSeries<T>

this

DataObject.setName

▸ setParent(parent): AbstractDataSeries<T>

Sets parent data item

AbstractDataSeries<T>

this

DataObject.setParent

▸ setProperties(properties?): AbstractDataSeries<T>

Sets all the properties pertaining to this object

AbstractDataSeries<T>

this

DataObject.setProperties

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

Sets property by name

AbstractDataSeries<T>

this

DataObject.setProperty

▸ setSilent(bool): AbstractDataSeries<T>

Set silent mode

AbstractDataSeries<T>

this

DataObject.setSilent

▸ setType(type): AbstractDataSeries<T>

Sets data object type

AbstractDataSeries<T>

this

DataObject.setType

▸ setUri(uri): AbstractDataSeries<T>

Sets unique resource identifier

AbstractDataSeries<T>

this

DataObject.setUri

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

Returns an array of objects in the data series.

T[]

▸ update(args?): AbstractDataSeries<T>

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

Fires

Events.Updated

AbstractDataSeries<T>

this

▸ Protected updateTimeStamp(): AbstractDataSeries<T>

Updates timestamp of the data series.

AbstractDataSeries<T>

▸ updating(args?): AbstractDataSeries<T>

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

Fires

Events.Updating

AbstractDataSeries<T>

this

▸ Static getClassName(): string

string

DataObject.getClassName