Last updated

API / geotoolkit / welllog / widgets / data / CurveDataObject / CurveDataObject

Class: CurveDataObject

data.CurveDataObject.CurveDataObject

Define abstract curve data object which provides samples and indices together

Deprecated

since 4.0

Hierarchy

Table of contents

Constructors
Methods
Css Properties
Name Type Description
namestringName
typestringType
uristringUnique resource identifier

Contents

Constructors

new CurveDataObject(options)

new CurveDataObject(options?)

Parameters

Name Type
Optional optionsOptions

Overrides

DataObject.constructor

Methods

addChild

addChild(data): CurveDataObject

Add a child object

Parameters

Name Type Description
dataDataObject | DataObject[]the child data to be added

Returns

CurveDataObject

this

Inherited from

DataObject.addChild


addProperties

addProperties(properties): CurveDataObject

Add additional properties

Parameters

Name Type Description
propertiesRecord<string, any>additional properties of the dataobject

Returns

CurveDataObject

this

Inherited from

DataObject.addProperties


clearChildren

clearChildren(): CurveDataObject

Remove all child data

Returns

CurveDataObject

this

Inherited from

DataObject.clearChildren


clone

clone(copyData?): DataObject

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

Parameters

Name Type Description
Optional copyDatabooleanflag to copy data

Returns

DataObject

clone

Inherited from

DataObject.clone


copyConstructor

Protected copyConstructor(src): CurveDataObject

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

Parameters

Name Type Description
srcDataObjectSource to copy from

Returns

CurveDataObject

this

Inherited from

DataObject.copyConstructor


dispose

dispose(): void

Dispose data object and all children. Clear all listeners

Returns

void

Inherited from

DataObject.dispose


getChild

getChild(i): DataObject

Return data by index

Parameters

Name Type Description
inumberindex of the data

Returns

DataObject

child

Inherited from

DataObject.getChild


getChildren

getChildren(filter?): Iterator<DataObject>

Return iterator by child data objects

Parameters

Name Type Description
Optional filter(data: DataObject) => booleana filter function. Returns all child data objects if the value is null.

Returns

Iterator<DataObject>

Inherited from

DataObject.getChildren


getChildrenCount

getChildrenCount(): number

Return number of child data

Returns

number

Inherited from

DataObject.getChildrenCount


getClassName

getClassName(): string

Returns

string

Inherited from

DataObject.getClassName


getData

getData(options, callback): void

Request load data

Parameters

Name Type Description
optionsanyadditional parameters of curve data passed to callback function
callback(arg: number[]) => voidfunction called to request data

Returns

void


getName

getName(): string

Returns data object name

Returns

string

Inherited from

DataObject.getName


getParent

getParent(): DataObject

Gets parent data item

Returns

DataObject

Inherited from

DataObject.getParent


getProperties

getProperties(): OptionsOut

Gets all the properties pertaining to this object

Returns

OptionsOut

JSON options object

Inherited from

DataObject.getProperties


getProperty

getProperty(name): any

Gets property by name

Parameters

Name Type Description
namestringproperty name

Returns

any

Inherited from

DataObject.getProperty


getType

getType(): string

Returns data type

Returns

string

Inherited from

DataObject.getType


getUri

getUri(): string

Returns unique resource identifier

Returns

string

Inherited from

DataObject.getUri


hasEventListener

hasEventListener(type, callback?): boolean

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

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

DataObject.hasEventListener


hasProperty

hasProperty(name): boolean

Returns whether data object contains specific property

Parameters

Name Type Description
namestringproperty name

Returns

boolean

Inherited from

DataObject.hasProperty


indexOfChild

indexOfChild(data): number

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

Parameters

Name Type Description
dataDataObjectdata object to check index

Returns

number

Inherited from

DataObject.indexOfChild


insertChild

insertChild(index, item, silent?): CurveDataObject

Insert item by index

Parameters

Name Type Description
indexnumberspecified index
itemDataObjectnode
Optional silentbooleanwill not fire any events if true

Returns

CurveDataObject

this

Inherited from

DataObject.insertChild


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

DataObject.isDisposed


isSilent

isSilent(): boolean

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

Returns

boolean

Inherited from

DataObject.isSilent


notify

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

Notify listeners

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEevent types
sourceDataObjectof the event
Optional argsEventMap[E]arguments of the event

Returns

CurveDataObject

this

Inherited from

DataObject.notify


off

off<E>(type?, callback?): CurveDataObject

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: CurveDataObject, args: EventMap[E]) => voidfunction to be called

Returns

CurveDataObject

this

Inherited from

DataObject.off


on

on<E>(type, callback): CurveDataObject

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: CurveDataObject, args: EventMap[E]) => voidto be called

Returns

CurveDataObject

this

Inherited from

DataObject.on


onPropertyChanged

onPropertyChanged(prop): CurveDataObject

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

Parameters

Name Type Description
propObjectproperty
prop.namestring
prop.valueany

Returns

CurveDataObject

this

Inherited from

DataObject.onPropertyChanged


query

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;
});

Returns

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

Inherited from

DataObject.query


removeChild

removeChild(data, silent?): CurveDataObject

Remove child data object

Parameters

Name Type Description
dataDataObjectdata object to be removed
Optional silentbooleanwill not fire any events if true

Returns

CurveDataObject

this

Inherited from

DataObject.removeChild


set

set(index, item): DataObject

Sets item by index

Parameters

Name Type Description
indexnumberindex of the item
itemDataObjectnode

Returns

DataObject

Inherited from

DataObject.set


setName

setName(name): CurveDataObject

Sets data object name

Parameters

Name Type Description
namestringdata object name

Returns

CurveDataObject

this

Inherited from

DataObject.setName


setParent

setParent(parent): CurveDataObject

Sets parent data item

Parameters

Name Type Description
parentDataObjectparent data item

Returns

CurveDataObject

this

Inherited from

DataObject.setParent


setProperties

setProperties(properties?): CurveDataObject

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional propertiesOptionsJSON options object

Returns

CurveDataObject

this

Inherited from

DataObject.setProperties


setProperty

setProperty(name, value): CurveDataObject

Sets property by name

Parameters

Name Type Description
namestringproperty name
valueanyproperty value

Returns

CurveDataObject

this

Inherited from

DataObject.setProperty


setSilent

setSilent(bool): CurveDataObject

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

CurveDataObject

this

Inherited from

DataObject.setSilent


setType

setType(type): CurveDataObject

Sets data object type

Parameters

Name Type Description
typestringdata type

Returns

CurveDataObject

this

Inherited from

DataObject.setType


setUri

setUri(uri): CurveDataObject

Sets unique resource identifier

Parameters

Name Type Description
uristringunique identifier

Returns

CurveDataObject

this

Inherited from

DataObject.setUri


getClassName

Static getClassName(): string

Returns

string

Inherited from

DataObject.getClassName