Page History

Div

style	display:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Div

id	description

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
rowIndex Get or set the record index of the dataset.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addColumn(name) adds a column with the specified name to the dataset.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addColumn(name, index) adds a column with the specified name to the dataset.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addColumn(name, index, type) adds a column with the specified name to the dataset.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addHTMLProperty(row, col, name, value) Add an HTML property to an HTML tag produced in getAsHTML().

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addRow(index, array) Add a row to the dataset.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
addRow(array) Add a row to the dataset.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createDataSource(name) Create a data source from the data set with specified name and using specified types.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createDataSource(name, types) Create a data source from the data set with specified name and using specified types.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
createDataSource(name, types, pkNames) Create a data source from the data set with specified name and using specified types, add .

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getAsHTML() Get the dataset as an html table, do not escape values or spaces, no multi_line_markup, do not add indentation, add column names.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getAsHTML(escape_values) Get the dataset as an html table, do not escape spaces, no multi_line_markup, do not add indentation, add column names.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getAsHTML(escape_values, escape_spaces) Get the dataset as an html table, no multi_line_markup, do not add indentation, add column names.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getAsHTML(escape_values, escape_spaces, multi_line_markup) Get the dataset as an html table, do not add indentation, add column names.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getAsHTML(escape_values, escape_spaces, multi_line_markup, pretty_indent) Get the dataset as an html table, add column names.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getAsHTML(escape_values, escape_spaces, multi_line_markup, pretty_indent, add_column_names) Get the dataset as an html table.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getAsText(column_separator, row_separator, value_delimiter, add_column_names) Get the dataset as formatted text.

Table Row (tr)

Table Cell (td)
Object[]

Table Cell (td)
getColumnAsArray(index) Get the column data of a dataset as an Array.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getColumnName(index) Get a column name based on index.

Table Row (tr)

Table Cell (td)
String[]

Table Cell (td)
getColumnNames() Get the column names of a dataset.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getColumnType(index) Get a column type based on index.

Table Row (tr)

Table Cell (td)
ServoyException

Table Cell (td)
getException() Get the database exception if an error occurred.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getMaxColumnIndex() Get the number of columns in the dataset.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getMaxRowIndex() Get the number of rows in the dataset.

Table Row (tr)

Table Cell (td)
Object[]

Table Cell (td)
getRowAsArray(index) Get the row data of a dataset as an Array.

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
getValue(row, col) Get the value specified by row and column position from the dataset.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
hadMoreData() Return true if there is more data in the resultset then specified by maxReturnedRows at query time.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeColumn(index) Remove a column by index from the dataset.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
removeRow(row) Remove a row from the dataset.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setColumnName(index, columnName) Set a column name based on index.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setValue(row, col, obj) Set the value specified by row and column position from the dataset.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
sort(col, sort_direction) Sort the dataset on the given column (1-based) in ascending or descending.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
sort(comparator) Sort the dataset using the function as comparator.

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Details

Table Body (tbody)

id	rowIndex

Table Row (tr)

id	name

Table Cell (td)
rowIndex

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get or set the record index of the dataset.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
//to set the rowIndex:
dataset.rowIndex = 1 //sets the rowIndex to the first row (dataset is 1-based)
//to retrieve the rowIndex of the currently selected row
var currRow = dataset.rowIndex

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	addColumn-String

Table Row (tr)

id	name

Table Cell (td)
addColumn

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addColumn

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

adds a column with the specified name to the dataset.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - column name.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if succeeded, else false.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
var success = dataset.addColumn('columnName',1);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addColumn-String_Number

Table Row (tr)

id	name

Table Cell (td)
addColumn

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addColumn

Span
(name, index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

adds a column with the specified name to the dataset.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - column name.
{Number} index - column index number between 1 and getMaxColumnIndex().

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if succeeded, else false.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
var success = dataset.addColumn('columnName',1);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addColumn-String_Number_Number

Table Row (tr)

id	name

Table Cell (td)
addColumn

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addColumn

Span
(name, index, type)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

adds a column with the specified name to the dataset.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - column name.
{Number} index - column index number between 1 and getMaxColumnIndex().
{Number} type - the type of column, see JSColumn constants.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if succeeded, else false.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
var success = dataset.addColumn('columnName',1);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addHTMLProperty-Number_Number_String_String

Table Row (tr)

id	name

Table Cell (td)
addHTMLProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addHTMLProperty

Span
(row, col, name, value)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add 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 cell

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} row - row number
{Number} col - column number
{String} name - String property name
{String} value - String property value

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//adds a container property (to TABLE tag)
dataset.addHTMLProperty(-1,-1,'cellspacing','3');
dataset.addHTMLProperty(-1,-1,'style','border-collapse:collapse;'); //to have a single line border

//adds a row property to all rows (to TR tag)
dataset.addHTMLProperty(0,0,'class','text');

//adds a row property to second row (to TR tag)
dataset.addHTMLProperty(2,0,'class','text');

//adds a column property to all 3rd columns (to TD tag)
dataset.addHTMLProperty(0,3,'class','redcolumn') ;

//adds a specific cell property (to TD tag)
dataset.addHTMLProperty(2,4,'color','blue');

scopes.globals.html_field = '<html>'+dataset.getAsHTML()+'</html>';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addRow-Number_ObjectArray

Table Row (tr)

id	name

Table Cell (td)
addRow

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addRow

Span
(index, array)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a row to the dataset.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index - index to add row (1-based)
{Object[]} array - row data

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
dataset.addRow(new Array(1,2,3,4,5,6,7,7)); //adds a row with 8 columns
dataset.addRow(2, new Array(1,2,3,4,5,6,7,7)); //adds a row with 8 columns at row 2

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addRow-ObjectArray

Table Row (tr)

id	name

Table Cell (td)
addRow

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

addRow

Span
(array)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object[]} array - row data

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
dataset.addRow(new Array(1,2,3,4,5,6,7,7)); //adds a row with 8 columns
dataset.addRow(2, new Array(1,2,3,4,5,6,7,7)); //adds a row with 8 columns at row 2

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createDataSource-String

Table Row (tr)

id	name

Table Cell (td)
createDataSource

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

createDataSource

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a data source from the data set with specified name and using specified types.
The types are inferred from the data if possible.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - data source name

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String uri reference to the created data source.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

ds.addColumn('my_id'); // note: use regular javascript identifiers so they can be used in scripting
ds.addColumn('my_label');
var uri = ds.createDataSource('mydata', [JSColumn.INTEGER, JSColumn.TEXT]);
var jsform = solutionModel.newForm(fname, uri, null, true, 300, 300);

var query = 'select customerid, address, city, country  from customers';
var ds2 = databaseManager.getDataSetByQuery('example_data', query, null, 999);
var uri2 = ds2.createDataSource('mydata2'); // types are inferred from query result

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createDataSource-String_Object

Table Row (tr)

id	name

Table Cell (td)
createDataSource

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

createDataSource

Span
(name, types)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a data source from the data set with specified name and using specified types.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - data source name
{Object} types - array of types as defined in JSColumn

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String uri reference to the created data source.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

ds.addColumn('my_id'); // note: use regular javascript identifiers so they can be used in scripting
ds.addColumn('my_label');
var uri = ds.createDataSource('mydata', [JSColumn.INTEGER, JSColumn.TEXT]);
var jsform = solutionModel.newForm(fname, uri, null, true, 300, 300);

var query = 'select customerid, address, city, country  from customers';
var ds2 = databaseManager.getDataSetByQuery('example_data', query, null, 999);
var uri2 = ds2.createDataSource('mydata2'); // types are inferred from query result

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	createDataSource-String_Object_StringArray

Table Row (tr)

id	name

Table Cell (td)
createDataSource

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

createDataSource

Span
(name, types, pkNames)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Create a data source from the data set with specified name and using specified types, add .

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - data source name
{Object} types - array of types as defined in JSColumn, when null types are inferred from the query result
{String[]} pkNames - array of pk names, when null a hidden pk-column will be added

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String uri reference to the created data source.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

ds.addColumn('my_id'); // note: use regular javascript identifiers so they can be used in scripting
ds.addColumn('my_label');
var uri = ds.createDataSource('mydata', [JSColumn.INTEGER, JSColumn.TEXT], ['my_id']);
var jsform = solutionModel.newForm(fname, uri, null, true, 300, 300);

var query = 'select customerid, address, city, country  from customers';
var ds2 = databaseManager.getDataSetByQuery('example_data', query, null, 999);
var uri2 = ds2.createDataSource('mydata2', null, ['customerid']); // types are inferred from query result, use customerid as pk

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAsHTML

Table Row (tr)

id	name

Table Cell (td)
getAsHTML

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getAsHTML

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String html.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets a dataset based on a query
//useful to limit the number of rows
var maxReturnedRows = 10;
var query = 'select c1,c2,c3 from test_table where start_date = ?';

//to access data by name, do not use '.' or special characters in names or aliases
var args = new Array();
args[0] = order_date //or new Date();
var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()),query,args,maxReturnedRows);

// gets a dataset with escape values; escape spaces (lines will not wrap); no multi-line markup; with pretty indentation; shows column names
var htmlTable = dataset.getAsHTML(true, true, false, true, true);

//assigns the dataset to a field and sets the display type to HTML_AREA
//assuming the html_field is a global text variable
scopes.globals.html_field = '<html>'+dataset.getAsHTML()+'</html>';

//Note: To display an HTML_AREA field as an HTML page, add HTML tags at the beginning '<html>' and at the end '</html>'.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAsHTML-Boolean

Table Row (tr)

id	name

Table Cell (td)
getAsHTML

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getAsHTML

Span
(escape_values)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} escape_values - if true, replaces illegal HTML characters with corresponding valid escape sequences.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String html.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets a dataset based on a query
//useful to limit the number of rows
var maxReturnedRows = 10;
var query = 'select c1,c2,c3 from test_table where start_date = ?';

//to access data by name, do not use '.' or special characters in names or aliases
var args = new Array();
args[0] = order_date //or new Date();
var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()),query,args,maxReturnedRows);

// gets a dataset with escape values; escape spaces (lines will not wrap); no multi-line markup; with pretty indentation; shows column names
var htmlTable = dataset.getAsHTML(true, true, false, true, true);

//assigns the dataset to a field and sets the display type to HTML_AREA
//assuming the html_field is a global text variable
scopes.globals.html_field = '<html>'+dataset.getAsHTML()+'</html>';

//Note: To display an HTML_AREA field as an HTML page, add HTML tags at the beginning '<html>' and at the end '</html>'.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAsHTML-Boolean_Boolean

Table Row (tr)

id	name

Table Cell (td)
getAsHTML

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getAsHTML

Span
(escape_values, escape_spaces)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} escape_values - if true, replaces illegal HTML characters with corresponding valid escape sequences.
{Boolean} escape_spaces - if true, replaces text spaces with non-breaking space tags ( ) and tabs by four non-breaking space tags.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String html.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets a dataset based on a query
//useful to limit the number of rows
var maxReturnedRows = 10;
var query = 'select c1,c2,c3 from test_table where start_date = ?';

//to access data by name, do not use '.' or special characters in names or aliases
var args = new Array();
args[0] = order_date //or new Date();
var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()),query,args,maxReturnedRows);

// gets a dataset with escape values; escape spaces (lines will not wrap); no multi-line markup; with pretty indentation; shows column names
var htmlTable = dataset.getAsHTML(true, true, false, true, true);

//assigns the dataset to a field and sets the display type to HTML_AREA
//assuming the html_field is a global text variable
scopes.globals.html_field = '<html>'+dataset.getAsHTML()+'</html>';

//Note: To display an HTML_AREA field as an HTML page, add HTML tags at the beginning '<html>' and at the end '</html>'.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAsHTML-Boolean_Boolean_Boolean

Table Row (tr)

id	name

Table Cell (td)
getAsHTML

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getAsHTML

Span
(escape_values, escape_spaces, multi_line_markup)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} escape_values - if true, replaces illegal HTML characters with corresponding valid escape sequences.
{Boolean} escape_spaces - if true, replaces text spaces with non-breaking space tags ( ) and tabs by four non-breaking space tags.
{Boolean} multi_line_markup - if true, multiLineMarkup will enforce new lines that are in the text; single new lines will be replaced by , multiple new lines will be replaced by

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String html.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets a dataset based on a query
//useful to limit the number of rows
var maxReturnedRows = 10;
var query = 'select c1,c2,c3 from test_table where start_date = ?';

//to access data by name, do not use '.' or special characters in names or aliases
var args = new Array();
args[0] = order_date //or new Date();
var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()),query,args,maxReturnedRows);

// gets a dataset with escape values; escape spaces (lines will not wrap); no multi-line markup; with pretty indentation; shows column names
var htmlTable = dataset.getAsHTML(true, true, false, true, true);

//assigns the dataset to a field and sets the display type to HTML_AREA
//assuming the html_field is a global text variable
scopes.globals.html_field = '<html>'+dataset.getAsHTML()+'</html>';

//Note: To display an HTML_AREA field as an HTML page, add HTML tags at the beginning '<html>' and at the end '</html>'.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAsHTML-Boolean_Boolean_Boolean_Boolean

Table Row (tr)

id	name

Table Cell (td)
getAsHTML

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getAsHTML

Span
(escape_values, escape_spaces, multi_line_markup, pretty_indent)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the dataset as an html table, add column names.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} escape_values - if true, replaces illegal HTML characters with corresponding valid escape sequences.
{Boolean} escape_spaces - if true, replaces text spaces with non-breaking space tags ( ) and tabs by four non-breaking space tags.
{Boolean} multi_line_markup - if true, multiLineMarkup will enforce new lines that are in the text; single new lines will be replaced by , multiple new lines will be replaced by 
{Boolean} pretty_indent - if true, adds indentation for more readable HTML code.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String html.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets a dataset based on a query
//useful to limit the number of rows
var maxReturnedRows = 10;
var query = 'select c1,c2,c3 from test_table where start_date = ?';

//to access data by name, do not use '.' or special characters in names or aliases
var args = new Array();
args[0] = order_date //or new Date();
var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()),query,args,maxReturnedRows);

// gets a dataset with escape values; escape spaces (lines will not wrap); no multi-line markup; with pretty indentation; shows column names
var htmlTable = dataset.getAsHTML(true, true, false, true, true);

//assigns the dataset to a field and sets the display type to HTML_AREA
//assuming the html_field is a global text variable
scopes.globals.html_field = '<html>'+dataset.getAsHTML()+'</html>';

//Note: To display an HTML_AREA field as an HTML page, add HTML tags at the beginning '<html>' and at the end '</html>'.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAsHTML-Boolean_Boolean_Boolean_Boolean_Boolean

Table Row (tr)

id	name

Table Cell (td)
getAsHTML

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getAsHTML

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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the dataset as an html table.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} escape_values - if true, replaces illegal HTML characters with corresponding valid escape sequences.
{Boolean} escape_spaces - if true, replaces text spaces with non-breaking space tags ( ) and tabs by four non-breaking space tags.
{Boolean} multi_line_markup - if true, multiLineMarkup will enforce new lines that are in the text; single new lines will be replaced by , multiple new lines will be replaced by 
{Boolean} pretty_indent - if true, adds indentation for more readable HTML code.
{Boolean} add_column_names - if false, column headers will not be added to the table.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String html.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//gets a dataset based on a query
//useful to limit the number of rows
var maxReturnedRows = 10;
var query = 'select c1,c2,c3 from test_table where start_date = ?';

//to access data by name, do not use '.' or special characters in names or aliases
var args = new Array();
args[0] = order_date //or new Date();
var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()),query,args,maxReturnedRows);

// gets a dataset with escape values; escape spaces (lines will not wrap); no multi-line markup; with pretty indentation; shows column names
var htmlTable = dataset.getAsHTML(true, true, false, true, true);

//assigns the dataset to a field and sets the display type to HTML_AREA
//assuming the html_field is a global text variable
scopes.globals.html_field = '<html>'+dataset.getAsHTML()+'</html>';

//Note: To display an HTML_AREA field as an HTML page, add HTML tags at the beginning '<html>' and at the end '</html>'.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAsText-String_String_String_Boolean

Table Row (tr)

id	name

Table Cell (td)
getAsText

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getAsText

Span
(column_separator, row_separator, value_delimiter, add_column_names)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the dataset as formatted text.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} column_separator - any specified column separator; examples: tab '\t'; comma ','; semicolon ';'; space ' ' .
{String} row_separator - the specified row separator; examples: new line '\n'.
{String} value_delimiter - the specified value delimiter; example: double quote '"'.
{Boolean} add_column_names - if true column names will be added as a first row.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String formatted text.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
//you can create csv or tab delimited results
var csv = dataset.getAsText(',','\n','"',true)
var tab = dataset.getAsText('\t','\n','"',true)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getColumnAsArray-Number

Table Row (tr)

id	name

Table Cell (td)
getColumnAsArray

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object[]

Span

style	font-weight: bold;

getColumnAsArray

Span
(index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the column data of a dataset as an Array.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index - index of column (1-based).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object[] - Object array of data.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
var dataArray = dataset.getColumnAsArray(1); //puts the contents from the first column of the dataset into an array
//once you have it as an array you can loop through it or feed it to a custom valuelist for example

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getColumnName-Number

Table Row (tr)

id	name

Table Cell (td)
getColumnName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getColumnName

Span
(index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get a column name based on index.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index - index of column (1-based).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - String column name.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
var firstColumName = dataset.getColumnName(1) //retrieves the first columnname into the variable firstColumName
//using a loop you can get all columnames in an array:
var query = 'select * from customers';
var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 100);
var colArray = new Array()
for (var i = 1; i <= dataset.getMaxColumnIndex(); i++)
{
	colArray[i-1] = dataset.getColumnName(i)
	//note the -1, because an array is zero based and dataset is 1 based.
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getColumnNames

Table Row (tr)

id	name

Table Cell (td)
getColumnNames

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getColumnNames

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the column names of a dataset.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String[] - String[] column names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var query = 'select * from customers';
var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 100);
var columnNames = dataset.getColumnNames();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getColumnType-Number

Table Row (tr)

id	name

Table Cell (td)
getColumnType

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getColumnType

Span
(index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get a column type based on index.

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

6.1.4

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index - index of column (1-based).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - Number the column type (JSColumn constant)

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
var firstColumnType = dataset.getColumnType(1) //retrieves the first column's type into the variable firstColumnType
if (firstColumnType == JSColumn.NUMBER) { }

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getException

Table Row (tr)

id	name

Table Cell (td)
getException

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

ServoyException

Span

style	font-weight: bold;

getException

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the database exception if an error occurred.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

ServoyException - ServoyException exception or null when not available.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
var dbException = dataset.getException();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMaxColumnIndex

Table Row (tr)

id	name

Table Cell (td)
getMaxColumnIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getMaxColumnIndex

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the number of columns in the dataset.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - int number of columns.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
for (var i = 1; i <= dataset.getMaxColumnIndex(); i++)
{
	colArray[i-1] = dataset.getColumnName(i)
	//have to subtract 1, because an array is zero based and a dataset is 1 based.
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMaxRowIndex

Table Row (tr)

id	name

Table Cell (td)
getMaxRowIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getMaxRowIndex

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the number of rows in the dataset.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - int number of rows.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
var totalRows = dataset.getMaxRowIndex();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRowAsArray-Number

Table Row (tr)

id	name

Table Cell (td)
getRowAsArray

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object[]

Span

style	font-weight: bold;

getRowAsArray

Span
(index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the row data of a dataset as an Array.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index - index of row (1-based).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object[] - Object array of data.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
var dataArray = dataset.getRowAsArray(1); //puts the contents from the first row of the dataset into an array
//once you have it as an array you can loop through it

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getValue-Number_Number

Table Row (tr)

id	name

Table Cell (td)
getValue

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

getValue

Span
(row, col)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the value specified by row and column position from the dataset.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} row - row number, 1-based
{Number} col - column number, 1-based

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object - Object value

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
var dataAtRow2Col1 = dataset.getValue(2, 1);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	hadMoreData

Table Row (tr)

id	name

Table Cell (td)
hadMoreData

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

hadMoreData

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - boolean more data available

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var ds = databaseManager.getDataSetByQuery('example_data', 'select order_id from orders', null, 10000)
if (ds.hadMoreData())
{
	// handle large result
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeColumn-Number

Table Row (tr)

id	name

Table Cell (td)
removeColumn

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeColumn

Span
(index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Remove a column by index from the dataset.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index - index of column to remove (1-based)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if succeeded, else false.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
var success = dataset.removeColumn(1); // removes first column

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeRow-Number

Table Row (tr)

id	name

Table Cell (td)
removeRow

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

removeRow

Span
(row)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Remove a row from the dataset.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} row - row index to remove, -1 for all rows

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
dataset.removeRow(1); //removes the first row
dataset.removeRow(-1); //removes all rows

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setColumnName-Number_String

Table Row (tr)

id	name

Table Cell (td)
setColumnName

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setColumnName

Span
(index, columnName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set a column name based on index.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index - index of column (1-based).
{String} columnName - new column name.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var query = 'select customerid, customername from customers';
var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, -1);
dataset.setColumnName(2, 'name_of_customer') // change the column name for second column.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setValue-Number_Number_Object

Table Row (tr)

id	name

Table Cell (td)
setValue

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setValue

Span
(row, col, obj)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} row - row number, 1-based
{Number} col - column number, 1-based
{Object} obj - the value to be stored at the given row and column.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//assuming the variable dataset contains a dataset
dataset.getValue(2, 1,'data');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	sort-Number_Boolean

Table Row (tr)

id	name

Table Cell (td)
sort

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

sort

Span
(col, sort_direction)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} col - column number, 1-based
{Boolean} sort_direction - ascending (true) or descending (false)

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// sort using column number
//assuming the variable dataset contains a dataset
dataset.sort(1, false)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	sort-Function

Table Row (tr)

id	name

Table Cell (td)
sort

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

sort

Span
(comparator)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sort 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 anymore

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} comparator - comparator function

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//sort using comparator
dataset.sort(mySortFunction);

function mySortFunction(r1, r2)
{
	var o = 0;
	if(r1[0] < r2[0])
	{
		o = -1;
	}
	else if(r1[0] > r2[0])
	{
		o = 1;
	}
	return o;
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 24

New Version Current

Key

rowIndex

addColumn

addColumn

addColumn

addHTMLProperty

addRow

addRow

createDataSource

createDataSource

createDataSource

getAsHTML

getAsHTML

getAsHTML

getAsHTML

getAsHTML

getAsHTML

getAsText

getColumnAsArray

getColumnName

getColumnNames

getColumnType

getException

getMaxColumnIndex

getMaxRowIndex

getRowAsArray

getValue

hadMoreData

removeColumn

removeRow

setColumnName

setValue

sort

sort