Last updated

API / geotoolkit / controls / shapes / tableview / DataProvider / DataProvider

Class: DataProvider

tableview.DataProvider.DataProvider

Base class for TableView data provider. Override its methods in specific purposes.

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new DataProvider()

new DataProvider()

Methods

getContentData

getContentData(column, row): string

Return optionally formatted content text field at col, row

Parameters

Name Type Description
columnnumberindex at the column
rownumberindex at the column

Returns

string

formatted content value


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


getHeaderData

getHeaderData(column): string

Return header text at column

Parameters

Name Type Description
columnnumberindex where the header text will be returned

Returns

string

header name


getHeaderFormat

getHeaderFormat(column, headerStyle): CellStyle

Return custom header style for header row

Parameters

Name Type Description
columnnumberColumn index
headerStyleCellStyleCurrent header style

Returns

CellStyle

Header style


getIndexData

getIndexData(row): string

Return optionally formatted index value at row

Parameters

Name Type Description
rownumberindex value at row

Returns

string

formatted index value


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


getMarkerData

getMarkerData(row): boolean

Show marker at row

Parameters

Name Type Description
rownumberindex value at row

Returns

boolean

true to show marker, false otherwise


prepareContent

prepareContent(fromRow, toRow, fromColumn, toColumn): string | void

Run once before rendering content data. This should be used to prepare content data output formatting.

Parameters

Name Type Description
fromRownumberfromRow used to prepare content data output formatting
toRownumbertoRow used to prepare content data output formatting
fromColumnnumberfromColumn used to prepare content data output formatting
toColumnnumbertoColumn used to prepare content data output formatting

Returns

string | void


prepareIndex

prepareIndex(fromRow, toRow): string | void

Run once before rendering index data. This should be used to prepare index data output formatting

Parameters

Name Type Description
fromRownumberfromRow used to prepare index data output formatting
toRownumbertoRow used to prepare index data output formatting

Returns

string | void

formatted index value