Skip to content

API / geotoolkit / widgets / data / DataTableAdapter / DataTableAdapter

Class: DataTableAdapter

data.DataTableAdapter.DataTableAdapter

<p> DataTableAdapter allows use of DataTables with the tableView Widget. </p>

Hierarchy

Table of contents

Constructors
  • [new DataTableAdapter(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.widgets-1.data.datatableadapter.datatableadapter.md#new datatableadapter(options))
Methods

Contents

Constructors

new DataTableAdapter(options)

• new DataTableAdapter(options)

Parameters

Name Type Description
optionsOptionsDataTableAdapter Options

Overrides

DataProvider.constructor

Methods

filter

▸ filter(column, filterValue): DataTableAdapter

Filtering in TableViewWidget by value specified by filter. By default, this method will return all column - cellvalues containing value to filter. External function for filtering can also be provided.

Example

// Filtering term can be string or function.
// For using function, which filters value containing 'a'.
const filteringFunction = function (index , value){
return value.toString().indexOf('a') !== -1;
}

Parameters

Name Type Description
columnnumbercolumn-number to filter column-specific data
filterValuestring | Functionfiltering term

Returns

DataTableAdapter

this


getColumnsCount

▸ getColumnsCount(): number

Gives number of columns

Returns

number

number of column


getContentData

▸ getContentData(column, row): any

Returns the cell values of Table View Widget

Parameters

Name Type Description
columnnumbercolumn-number
rownumberrow-number

Returns

any

cell-value

Overrides

DataProvider.getContentData


getContentFormat

▸ getContentFormat(column, row, cellStyle): CellStyle

Return custom cell style for table content

Parameters

Name Type Description
columnnumberColumn index
rownumberRow index
cellStyleCellStyleCurrent cell style

Returns

CellStyle

Cell style

Inherited from

DataProvider.getContentFormat


getData

▸ getData(): Data

Returns

Data


getDataTable

▸ getDataTable(): DataTable

Gets a data table associated with this adapter

Returns

DataTable


getHeaderData

▸ getHeaderData(column): string

Returns header data of Table View Widget

Parameters

Name Type Description
columnnumbercolumn-number

Returns

string

column header

Overrides

DataProvider.getHeaderData


getHeaderFormat

▸ getHeaderFormat(column, headerStyle): CellStyle

Returns Header style

Parameters

Name Type Description
columnnumbercolumn number
headerStyleCellStyleheaderstyle

Returns

CellStyle

Header style

Overrides

DataProvider.getHeaderFormat


getIndexData

▸ getIndexData(row): string

Return optionally formatted index value at row

Parameters

Name Type Description
rownumberindex value at row

Returns

string

formatted index value

Inherited from

DataProvider.getIndexData


getIndexFormat

▸ getIndexFormat(row, cellStyle): CellStyle

Return custom cell style for index column

Parameters

Name Type Description
rownumberRow index
cellStyleCellStyleCurrent cell style

Returns

CellStyle

Cell style

Inherited from

DataProvider.getIndexFormat


getMarkerData

▸ getMarkerData(row): boolean

Show marker at row

Parameters

Name Type Description
rownumberindex value at row

Returns

boolean

true to show marker, false otherwise

Inherited from

DataProvider.getMarkerData


getRowsCount

▸ getRowsCount(): number

Gives number of rows

Returns

number

Number of Rows


getSortedByColumn

▸ getSortedByColumn(): Object

Gets sorted column number.

Returns

Object

NameType
columnnumber
reverseboolean

prepareContent

▸ prepareContent(fromRow, toRow): void

Setting Content prepare

Parameters

Name Type Description
fromRownumberRow-number
toRownumberRow-number

Returns

void

Overrides

DataProvider.prepareContent


prepareIndex

▸ prepareIndex(fromRow, toRow): void

Prepare Index Run before rendering table

Parameters

Name Type Description
fromRownumberfromrow
toRownumbertoRow

Returns

void

Overrides

DataProvider.prepareIndex


sortByColumn

▸ sortByColumn(column, comparator): void

Sorting by column in TableViewWidget using specified comparator function.

Parameters

Name Type Description
columnnumbercolumn number
comparatorComparatorCallback<any&gt;comparator function

Returns

void