Last updated

API / geotoolkit / data / DataSource / DataSource

Class: DataSource

data.DataSource.DataSource

Define Abstract Data Model

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new DataSource()

new DataSource()

Overrides

EventDispatcher.constructor

Methods

addChild

addChild(data): DataSource

Add a child object

Parameters

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

Returns

DataSource

this


beginUpdate

beginUpdate(): DataSource

begin transaction

Returns

DataSource

this


clearChildren

clearChildren(): DataSource

Remove all child data

Returns

DataSource

this


dispose

dispose(): void

Dispose.

Returns

void

Inherited from

EventDispatcher.dispose


endUpdate

endUpdate(): DataSource

end transaction

Returns

DataSource


getChild

getChild(i): DataObject

Return data by index

Parameters

Name Type Description
inumberindex of the data

Returns

DataObject


getChildrenCount

getChildrenCount(): number

Return number of child data

Returns

number


getClassName

getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName


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

EventDispatcher.hasEventListener


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

EventDispatcher.isDisposed


isSilent

isSilent(): boolean

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

Returns

boolean

Inherited from

EventDispatcher.isSilent


notify

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

Notify listeners

Type parameters

NameType
Eextends string

Parameters

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

Returns

DataSource

this

Overrides

EventDispatcher.notify


off

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

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: DataSource, args: EventMap[E]) => voidfunction to be called

Returns

DataSource

this

Overrides

EventDispatcher.off


on

on<E>(type, callback): DataSource

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: DataSource, args: EventMap[E]) => voidto be called

Returns

DataSource

this

Overrides

EventDispatcher.on


query

query(): QueryBuilder<any>

Query data object items

Returns

QueryBuilder<any>


removeChild

removeChild(data): DataSource

Remove child data object

Parameters

Name Type Description
dataDataObjectdata to be removed

Returns

DataSource

this


setSilent

setSilent(bool): DataSource

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

DataSource

this

Inherited from

EventDispatcher.setSilent


update

update(): DataSource

Load a part of the data

Returns

DataSource

this


getClassName

Static getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName