API / geotoolkit / data / AbstractDataTable / AbstractDataTable
data.AbstractDataTable.AbstractDataTable
Define an abstract class for data table representation
↳
AbstractDataTable↳↳
DataTable
Constructors
Methods
Constructors
• new AbstractDataTable()
EventDispatcher.constructor
Methods
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ Abstract getColumn(columnIndex): AbstractDataSeries<any>
Returns the column at the specified index.
| Name | Type | Description |
|---|---|---|
columnIndex | number | column index |
AbstractDataSeries<any>
▸ Abstract getColumnById(id): AbstractDataSeries<any>
Returns column by specified identifier. If multiple columns have the same identifier, the first one will be returned.
| Name | Type | Description |
|---|---|---|
id | string | number | identifier of the column |
AbstractDataSeries<any>
a column
▸ Abstract getColumnByName(name): AbstractDataSeries<any>
Returns column by specified name. If multiple columns have the same name, the first one will be returned.
| Name | Type | Description |
|---|---|---|
name | string | name of the column |
AbstractDataSeries<any>
a column
▸ getColumnProperties(columnIndex): Record<string, any>
Returns the map of all properties of specified column.
| Name | Type | Description |
|---|---|---|
columnIndex | number | index of the column |
Record<string, any>
▸ Abstract getMetaData(): Record<string, any>
Returns the map of all meta data of the data table. This method returns the reference to the meta data.
Record<string, any>
▸ getName(): string
Returns table name
string
▸ Abstract getNumberOfColumns(): number
Returns the number of columns in the data table.
number
number of columns
▸ Abstract getNumberOfRows(): number
Returns number of rows.
number
▸ Abstract getValue(rowIndex, columnIndex): any
Return the value of a cell.
| Name | Type | Description |
|---|---|---|
rowIndex | number | index of the row. It should be a number greater than or equal to zero, and less than the number of rows as returned by the getNumberOfRows() method. |
columnIndex | number | index of the column. should be a number greater than or equal to zero, and less than the number of columns as returned by the getNumberOfColumns() method. |
any
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
EventDispatcher.hasEventListener
▸ Abstract indexOfColumn(column): number
Returns the index of specified column.
| Name | Type | Description |
|---|---|---|
column | AbstractDataSeries<any> | column |
number
index
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify(type, source, args?): AbstractDataTable
Notify listeners
| Name | Type | Description |
|---|---|---|
type | string | event types |
source | any | of the event |
Optional args | any | arguments of the event |
this
▸ off(type?, callback?): AbstractDataTable
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.
| Name | Type | Description |
|---|---|---|
Optional type | string | type of the event |
Optional callback | EventListener | function to be called |
this
▸ off<E>(type, callback): AbstractDataTable
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: AbstractDataTable, args: EventMap[E]) => void |
▸ on(type, callback, options?): AbstractDataTable
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.
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
callback | EventListener | to be called |
Optional options | Options | options of subscription |
this
▸ on<E>(type, callback, options?): AbstractDataTable
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: AbstractDataTable, args: EventMap[E]) => void |
Optional options | Options |
▸ setName(name): AbstractDataTable
Sets name of the table
| Name | Type | Description |
|---|---|---|
name | string | new table name |
▸ setSilent(bool): AbstractDataTable
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string