Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Property SummaryGet or set the record index of the dataset.

servoy sSummary12%30%58%height: 30px;3Methods Summaryadds a column with the specified name to the dataset.adds a column with the specified name to the dataset.adds a column with the specified name to the dataset.voidAdd an HTML property to an HTML tag produced in getAsHTML().voidAdd a row to the dataset.voidAdd a row to the dataset.Create a datasource from the data set with specified name and using specified types.Create a datasource from the data set with specified name and using specified types.Create a datasource from the data set with specified name and using specified types.Get the dataset as an html table, do not escape values or spaces, no multi_line_markup, do not add indentation, add column names.Get the dataset as an html table, do not escape spaces, no multi_line_markup, do not add indentation, add column names.Get the dataset as an html table, no multi_line_markup, do not add indentation, add column names.Get the dataset as an html table, do not add indentation, add column names.Get the dataset as an html table, add column names.Get the dataset as an html table.Get the dataset as formatted text.Get the column data of a dataset as an Array.Get a column name based on index.Get the column names of a dataset.Get a column type based on index.Get the database exception if an error occurred.Get the number of columns in the dataset.Get the number of rows in the dataset.Get the row data of a dataset as an Array.Get the value specified by row and column position from the dataset.Return true if there is more data in the resultset then specified by maxReturnedRows at query time.Remove a column by index from the dataset.voidRemove a row from the dataset.voidSet a column name based on index.voidSet the value specified by row and column position from the dataset.voidSort the dataset on the given column (1-based) in ascending or descending.voidSort the dataset using the function as comparator.

propertyservoy sDetail2100%height:30px2Property DetailsrowIndexname

rowIndex

dessIndentGet or set the record index of the dataset.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 

functionservoy sDetail2100%height:30px2Methods DetailsaddColumnname

addColumn(name)

dessIndentadds a column with the specified name to the dataset.prs

Parameters

sIndentnamecolumn name.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow addColumnname

addColumn(name, index)

dessIndentadds a column with the specified name to the dataset.prs

Parameters

sIndentnamecolumn name.indexcolumn index number between 1 and getMaxColumnIndex().
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
addColumnname

addColumn(name, index, type)

dessIndentadds a column with the specified name to the dataset.prs

Parameters

sIndentnamecolumn name.indexcolumn index number between 1 and getMaxColumnIndex().typethe type of column, see JSColumn constants.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
addHTMLPropertyname

addHTMLProperty(row, col, name, value)

dessIndentAdd an HTML property to an HTML tag produced in getAsHTML(). For row and col parameters use: 1 = applies to the container 0 = applies to all >0 = applies to specific cellprs

Parameters

sIndentrowrow numbercolcolumn numbernameString property namevalueString property value
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
addRowname

addRow(index, array)

dessIndentAdd a row to the dataset.prs

Parameters

sIndentindexindex to add row (1-based)arrayrow data
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
addRowname

addRow(array)

dessIndentAdd a row to the dataset. The row will be added as the last row.prs

Parameters

sIndentarrayrow data
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
createDataSourcename

createDataSource(name)

dessIndentCreate a datasource from the data set with specified name and using specified types. The types are inferred from the data if possible. A temporary datasource cannot be removed because once created there may always be forms or relations that refer to it. When the client exits, all datasources used by that client are removed automatically. Most resources used by the datasource can be released by deleting all records: dataset.removeRow(-1) or databaseManager.getFoundSet(datasource).deleteAllRecords()prs

Parameters

sIndentnamedatasource name
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
createDataSourcename

createDataSource(name, types)

dessIndentCreate a datasource from the data set with specified name and using specified types. A temporary datasource cannot be removed because once created there may always be forms or relations that refer to it. When the client exits, all datasources used by that client are removed automatically. Most resources used by the datasource can be released by deleting all records: dataset.removeRow(-1) or databaseManager.getFoundSet(datasource).deleteAllRecords() A datasource can be reused if the data has the same signature (column names and types). A new createDataSource() call will clear the datasource contents from a previous call and insert the current data.prs

Parameters

sIndentnamedatasource nametypesarray of types as defined in JSColumn
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
createDataSourcename

createDataSource(name, types, pkNames)

dessIndentCreate a datasource from the data set with specified name and using specified types. A temporary datasource cannot be removed because once created there may always be forms or relations that refer to it. When the client exits, all datasources used by that client are removed automatically. Most resources used by the datasource can be released by deleting all records: dataset.removeRow(-1) or databaseManager.getFoundSet(datasource).deleteAllRecords()prs

Parameters

sIndentnamedatasource nametypesarray of types as defined in JSColumn, when null types are inferred from the query resultpkNamesarray of pk names, when null a hidden pk-column will be added
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getAsHTMLname

getAsHTML()

dessIndentGet the dataset as an html table, do not escape values or spaces, no multi_line_markup, do not add indentation, add column names.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getAsHTMLname

getAsHTML(escape_values)

dessIndentGet the dataset as an html table, do not escape spaces, no multi_line_markup, do not add indentation, add column names.prs

Parameters

sIndentescape_valuesif true, replaces illegal HTML characters with corresponding valid escape sequences.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getAsHTMLname

getAsHTML(escape_values, escape_spaces)

dessIndentGet the dataset as an html table, no multi_line_markup, do not add indentation, add column names.prs

Parameters

sIndentescape_valuesif true, replaces illegal HTML characters with corresponding valid escape sequences.escape_spacesif true, replaces text spaces with non-breaking space tags ( ) and tabs by four non-breaking space tags.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getAsHTMLname

getAsHTML(escape_values, escape_spaces, multi_line_markup)

dessIndentGet the dataset as an html table, do not add indentation, add column names.prs

Parameters

sIndentescape_valuesif true, replaces illegal HTML characters with corresponding valid escape sequences.escape_spacesif true, replaces text spaces with non-breaking space tags ( ) and tabs by four non-breaking space tags.multi_line_markupif true, multiLineMarkup will enforce new lines that are in the text; single new lines will be replaced by <br>, multiple new lines will be replaced by <p>
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getAsHTMLname

getAsHTML(escape_values, escape_spaces, multi_line_markup, pretty_indent)

dessIndentGet the dataset as an html table, add column names.prs

Parameters

sIndentescape_valuesif true, replaces illegal HTML characters with corresponding valid escape sequences.escape_spacesif true, replaces text spaces with non-breaking space tags ( ) and tabs by four non-breaking space tags.multi_line_markupif true, multiLineMarkup will enforce new lines that are in the text; single new lines will be replaced by <br>, multiple new lines will be replaced by <p>pretty_indentif true, adds indentation for more readable HTML code.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getAsHTMLname

getAsHTML(escape_values, escape_spaces, multi_line_markup, pretty_indent, add_column_names)

dessIndentGet the dataset as an html table.prs

Parameters

sIndentescape_valuesif true, replaces illegal HTML characters with corresponding valid escape sequences.escape_spacesif true, replaces text spaces with non-breaking space tags ( ) and tabs by four non-breaking space tags.multi_line_markupif true, multiLineMarkup will enforce new lines that are in the text; single new lines will be replaced by <br>, multiple new lines will be replaced by <p>pretty_indentif true, adds indentation for more readable HTML code.add_column_namesif false, column headers will not be added to the table.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getAsTextname

getAsText(column_separator, row_separator, value_delimiter, add_column_names)

dessIndentGet the dataset as formatted text.prs

Parameters

sIndentcolumn_separatorany specified column separator; examples: tab '\t'; comma ','; semicolon ';'; space ' ' .row_separatorthe specified row separator; examples: new line '\n'.value_delimiterthe specified value delimiter; null means empty string; example: double quote '"'.add_column_namesif true column names will be added as a first row.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getColumnAsArrayname

getColumnAsArray(index)

dessIndentGet the column data of a dataset as an Array.prs

Parameters

sIndentindexindex of column (1-based).
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getColumnNamename

getColumnName(index)

dessIndentGet a column name based on index.prs

Parameters

sIndentindexindex of column (1-based).
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getColumnNamesname

getColumnNames()

dessIndentGet the column names of a dataset.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getColumnTypename

getColumnType(index)

dessIndentGet a column type based on index.prs

Parameters

sIndentindexindex of column (1-based).
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getExceptionname

getException()

dessIndentGet the database exception if an error occurred.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getMaxColumnIndexname

getMaxColumnIndex()

dessIndentGet the number of columns in the dataset.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getMaxRowIndexname

getMaxRowIndex()

dessIndentGet the number of rows in the dataset.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getRowAsArrayname

getRowAsArray(index)

dessIndentGet the row data of a dataset as an Array.prs

Parameters

sIndentindexindex of row (1-based).
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
getValuename

getValue(row, col)

dessIndentGet the value specified by row and column position from the dataset.prs

Parameters

sIndentrowrow number, 1-basedcolcolumn number, 1-based
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
hadMoreDataname

hadMoreData()

dessIndentReturn true if there is more data in the resultset then specified by maxReturnedRows at query time.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
removeColumnname

removeColumn(index)

dessIndentRemove a column by index from the dataset.prs

Parameters

sIndentindexindex of column to remove (1-based)
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
removeRowname

removeRow(row)

dessIndentRemove a row from the dataset.prs

Parameters

sIndentrowrow index to remove, -1 for all rows
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
setColumnNamename

setColumnName(index, columnName)

dessIndentSet a column name based on index.prs

Parameters

sIndentindexindex of column (1-based).columnNamenew column name.
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
setValuename

setValue(row, col, obj)

dessIndentSet the value specified by row and column position from the dataset. Use row = -1, to set columnnames.prs

Parameters

sIndentrowrow number, 1-basedcolcolumn number, 1-basedobjthe value to be stored at the given row and column.
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
sortname

sort(col, sort_direction)

dessIndentSort the dataset on the given column (1-based) in ascending or descending.prs

Parameters

sIndentcolcolumn number, 1-basedsort_directionascending (true) or descending (false)
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
sortname

sort(comparator)

dessIndentSort the dataset using the function as comparator. The comparator function is called to compare two rows, that are passed as arguments, and it will return -1/0/1 if the first row is less/equal/greater then the second row. NOTE: starting with 7.2 release, when called on datasource(foundset) dataset, this function doesn't save the data anymoreprs

Parameters

sIndentcomparatorcomparator function
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;