Class: NumericalDataSeriesView

• new NumericalDataSeriesView(options)

• new NumericalDataSeriesView(options?)

Create NumericalDataSeriesView

DataSeriesView<number>.constructor

▸ addChild(data): NumericalDataSeriesView

Add a child object

NumericalDataSeriesView

this

INumericalDataSeries.addChild

DataSeriesView.addChild

▸ addFilter(filter, filterType?): NumericalDataSeriesView

Adds a value filter to the end of existing filters.

NumericalDataSeriesView

this

DataSeriesView.addFilter

▸ addProperties(properties): NumericalDataSeriesView

Add additional properties

NumericalDataSeriesView

this

INumericalDataSeries.addProperties

DataSeriesView.addProperties

▸ clearChildren(): NumericalDataSeriesView

Remove all child data

NumericalDataSeriesView

this

INumericalDataSeries.clearChildren

DataSeriesView.clearChildren

▸ clearFilters(): NumericalDataSeriesView

Clears all filters.

NumericalDataSeriesView

this

DataSeriesView.clearFilters

▸ clone(): NumericalDataSeriesView

Returns a clone of the numerical data series view.

NumericalDataSeriesView

clone

INumericalDataSeries.clone

DataSeriesView.clone

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

Converts values from one unit to another specified unit.

U

INumericalDataSeries.convertValues

DataSeriesView.convertValues

▸ Protected copyConstructor(src): NumericalDataSeriesView

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

NumericalDataSeriesView

this

INumericalDataSeries.copyConstructor

DataSeriesView.copyConstructor

▸ dispose(): void

Dispose data object and all children. Clear all listeners

void

INumericalDataSeries.dispose

DataSeriesView.dispose

▸ getChild(i): DataObject

Return data by index

DataObject

child

INumericalDataSeries.getChild

DataSeriesView.getChild

▸ getChildren(filter?): Iterator<DataObject>

Return iterator by child data objects

Iterator<DataObject>

INumericalDataSeries.getChildren

DataSeriesView.getChildren

▸ getChildrenCount(): number

Return number of child data

number

INumericalDataSeries.getChildrenCount

DataSeriesView.getChildrenCount

▸ getClassName(): string

string

INumericalDataSeries.getClassName

DataSeriesView.getClassName

▸ getDataOrder(): Order

Returns data ordering of the data series.

Order

INumericalDataSeries.getDataOrder

DataSeriesView.getDataOrder

▸ getFilters(): (number | DataSeriesView<number> | FilterCallback<number>)[]

Return the array of value filters as functions or DataSeriesView or series item.

(number | DataSeriesView<number> | FilterCallback<number>)[]

DataSeriesView.getFilters

▸ getId(): string | number

Returns the identifier of the data series.

string | number

INumericalDataSeries.getId

DataSeriesView.getId

▸ getLength(): number

Returns the number of values in the data series.

number

INumericalDataSeries.getLength

DataSeriesView.getLength

▸ getMax(unit?): number

Gets max value

number

max

INumericalDataSeries.getMax

▸ getMin(unit?): number

Gets min value

number

min

INumericalDataSeries.getMin

▸ getName(): string

Returns data object name

string

INumericalDataSeries.getName

DataSeriesView.getName

▸ getParent(): DataObject

Gets parent data item

DataObject

INumericalDataSeries.getParent

DataSeriesView.getParent

▸ getPostProcessor(): ProcessorCallback<number>

Returns post-processor function.

ProcessorCallback<number>

DataSeriesView.getPostProcessor

▸ getPreProcessor(): ProcessorCallback<number>

Returns pre-processor function.

ProcessorCallback<number>

DataSeriesView.getPreProcessor

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

JSON options object

INumericalDataSeries.getProperties

DataSeriesView.getProperties

▸ getProperty(name): any

Gets property by name

any

INumericalDataSeries.getProperty

DataSeriesView.getProperty

▸ Protected getTimeStamp(): number

Returns the timestamp of the data series.

number

INumericalDataSeries.getTimeStamp

DataSeriesView.getTimeStamp

▸ getType(): string

Returns data type

string

INumericalDataSeries.getType

DataSeriesView.getType

▸ getUnit(): AbstractUnit

Returns unit of the data series.

AbstractUnit

unit

INumericalDataSeries.getUnit

DataSeriesView.getUnit

▸ getUri(): string

Returns unique resource identifier

string

INumericalDataSeries.getUri

DataSeriesView.getUri

▸ getValue(index): number

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

number

INumericalDataSeries.getValue

DataSeriesView.getValue

▸ getViewUnit(): AbstractUnit

Returns view unit of the data series view. This method returns unit set through setUnit() method, which can be different from getUnit() if view unit is not convertible to data unit.

AbstractUnit

DataSeriesView.getViewUnit

▸ hasEventListener(type, callback?): boolean

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

boolean

INumericalDataSeries.hasEventListener

DataSeriesView.hasEventListener

▸ hasProperty(name): boolean

Returns whether data object contains specific property

boolean

INumericalDataSeries.hasProperty

DataSeriesView.hasProperty

▸ indexOfChild(data): number

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

number

INumericalDataSeries.indexOfChild

DataSeriesView.indexOfChild

▸ insertChild(index, item, silent?): NumericalDataSeriesView

Insert item by index

NumericalDataSeriesView

this

INumericalDataSeries.insertChild

DataSeriesView.insertChild

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

INumericalDataSeries.isDisposed

DataSeriesView.isDisposed

▸ isReadOnly(): boolean

Returns true

boolean

true

INumericalDataSeries.isReadOnly

DataSeriesView.isReadOnly

▸ isSilent(): boolean

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

boolean

INumericalDataSeries.isSilent

DataSeriesView.isSilent

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

Notify listeners

NumericalDataSeriesView

this

INumericalDataSeries.notify

DataSeriesView.notify

▸ off<E>(type?, callback?): NumericalDataSeriesView

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.

NumericalDataSeriesView

this

INumericalDataSeries.off

DataSeriesView.off

▸ on<E>(type, callback): NumericalDataSeriesView

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.

NumericalDataSeriesView

this

INumericalDataSeries.on

DataSeriesView.on

▸ onPropertyChanged(prop): NumericalDataSeriesView

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

NumericalDataSeriesView

this

INumericalDataSeries.onPropertyChanged

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

INumericalDataSeries.query

DataSeriesView.query

▸ removeChild(data, silent?): NumericalDataSeriesView

Remove child data object

NumericalDataSeriesView

this

INumericalDataSeries.removeChild

DataSeriesView.removeChild

▸ removeFilter(filter): NumericalDataSeriesView

Removes a value filter from the data series view.

NumericalDataSeriesView

this

DataSeriesView.removeFilter

▸ replaceFilter(oldFilter, newFilter, filterType?): NumericalDataSeriesView

Replaces an existing filter with a new filter.

NumericalDataSeriesView

this

DataSeriesView.replaceFilter

▸ set(index, item): DataObject

Sets item by index

DataObject

INumericalDataSeries.set

DataSeriesView.set

▸ setId(id): NumericalDataSeriesView

Sets the identifier of the data series.

NumericalDataSeriesView

this

INumericalDataSeries.setId

DataSeriesView.setId

▸ setName(name): NumericalDataSeriesView

DataSeriesView does not support setName() method.

NumericalDataSeriesView

this

INumericalDataSeries.setName

DataSeriesView.setName

▸ setParent(parent): NumericalDataSeriesView

Sets parent data item

NumericalDataSeriesView

this

INumericalDataSeries.setParent

DataSeriesView.setParent

▸ setPostProcessor(postProcessor?): NumericalDataSeriesView

Sets post-processor function. This processor will be called after filters.

NumericalDataSeriesView

DataSeriesView.setPostProcessor

▸ setPreProcessor(preProcessor?): NumericalDataSeriesView

Sets pre-processor function. This processor will be called before filters.

NumericalDataSeriesView

DataSeriesView.setPreProcessor

▸ setProperties(properties?): NumericalDataSeriesView

Sets all the properties pertaining to this object

NumericalDataSeriesView

INumericalDataSeries.setProperties

DataSeriesView.setProperties

▸ setProperty(name, value): NumericalDataSeriesView

Sets property by name

NumericalDataSeriesView

this

INumericalDataSeries.setProperty

DataSeriesView.setProperty

▸ setSilent(bool): NumericalDataSeriesView

Set silent mode

NumericalDataSeriesView

this

INumericalDataSeries.setSilent

DataSeriesView.setSilent

▸ setType(type): NumericalDataSeriesView

Sets data object type

NumericalDataSeriesView

this

INumericalDataSeries.setType

DataSeriesView.setType

▸ setUnit(unit?): NumericalDataSeriesView

Sets view unit of the data series view.

NumericalDataSeriesView

DataSeriesView.setUnit

▸ setUri(uri): NumericalDataSeriesView

Sets unique resource identifier

NumericalDataSeriesView

this

INumericalDataSeries.setUri

DataSeriesView.setUri

▸ Protected synchronize(): void

Synchronizes internal mapping for filters.

void

DataSeriesView.synchronize

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

Returns an array of objects in the data series.

number[]

INumericalDataSeries.toArray

DataSeriesView.toArray

▸ update(args?): NumericalDataSeriesView

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

Fires

Events.Updated

NumericalDataSeriesView

this

INumericalDataSeries.update

DataSeriesView.update

▸ Protected updateTimeStamp(): NumericalDataSeriesView

Updates timestamp of the data series.

NumericalDataSeriesView

INumericalDataSeries.updateTimeStamp

DataSeriesView.updateTimeStamp

▸ updating(args?): NumericalDataSeriesView

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

Fires

Events.Updating

NumericalDataSeriesView

this

INumericalDataSeries.updating

DataSeriesView.updating

▸ Static getClassName(): string

string

DataSeriesView.getClassName