Class: DataObject

• new DataObject(options)

• new DataObject(options?)

EventDispatcher.constructor

▸ addChild(data): DataObject

Add a child object

DataObject

this

▸ addProperties(properties): DataObject

Add additional properties

DataObject

this

▸ clearChildren(): DataObject

Remove all child data

DataObject

this

▸ clone(copyData?): DataObject

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

DataObject

clone

▸ Protected copyConstructor(src): DataObject

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

DataObject

this

▸ dispose(): void

Dispose data object and all children. Clear all listeners

void

EventDispatcher.dispose

▸ getChild(i): DataObject

Return data by index

DataObject

child

▸ getChildren(filter?): Iterator<DataObject>

Return iterator by child data objects

Iterator<DataObject>

▸ getChildrenCount(): number

Return number of child data

number

▸ getClassName(): string

string

EventDispatcher.getClassName

▸ getName(): string

Returns data object name

string

▸ getParent(): DataObject

Gets parent data item

DataObject

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

JSON options object

▸ getProperty(name): any

Gets property by name

any

▸ getType(): string

Returns data type

string

▸ getUri(): string

Returns unique resource identifier

string

▸ hasEventListener(type, callback?): boolean

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

boolean

EventDispatcher.hasEventListener

▸ hasProperty(name): boolean

Returns whether data object contains specific property

boolean

▸ indexOfChild(data): number

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

number

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

Insert item by index

DataObject

this

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

EventDispatcher.isDisposed

▸ isSilent(): boolean

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

boolean

EventDispatcher.isSilent

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

Notify listeners

DataObject

this

EventDispatcher.notify

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

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.

DataObject

this

EventDispatcher.off

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

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.

DataObject

this

EventDispatcher.on

▸ onPropertyChanged(prop): DataObject

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

DataObject

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?): DataObject

Remove child data object

DataObject

this

▸ set(index, item): DataObject

Sets item by index

DataObject

▸ setName(name): DataObject

Sets data object name

DataObject

this

▸ setParent(parent): DataObject

Sets parent data item

DataObject

this

▸ setProperties(properties?): DataObject

Sets all the properties pertaining to this object

DataObject

this

▸ setProperty(name, value): DataObject

Sets property by name

DataObject

this

▸ setSilent(bool): DataObject

Set silent mode

DataObject

this

EventDispatcher.setSilent

▸ setType(type): DataObject

Sets data object type

DataObject

this

▸ setUri(uri): DataObject

Sets unique resource identifier

DataObject

this

▸ Static getClassName(): string

string

EventDispatcher.getClassName