addRow
void  addRow( Object )

Adds a row (Object[]) to the dataset.

Parameters
Object  row  the row values

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

addRow
void  addRow( Number, Object )

Adds a row (Object[]) to the dataset.

Parameters
Number  index  the index
Object  row  the row values

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

appendCellFont
void  appendCellFont( Number, Number, String, String, Number, Number )

Append the textFont attributes to the end of the cell (row, column, textFont)

Parameters
Number  row:int  the row
Number  column:int  the column
String  font:String  the font
String  color:String  the color
Number  kerning:int  the kerning
Number  spacing:int  the spacing

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

cellClearFormatting
void  cellClearFormatting( Number, Number )

Removes all cell formatting.

Parameters
Number  row  the row
Number  column  the column

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

getColumnCount
Number  getColumnCount( )

Retrieve the number of columns.

Returns
Number  count int

Supported Clients
SmartClient, WebClient, NGClient

getColumnName
String  getColumnName( Number )

Returns a column name based on index.

Parameters
Number  column  the column

Returns
String  name String

Supported Clients
SmartClient, WebClient, NGClient

getColumnNames
Array<String>  getColumnNames( )

Returns an array of column names.

Returns
Array<String>  names String[]

Supported Clients
SmartClient, WebClient, NGClient

getMaxColumnIndex
Number  getMaxColumnIndex( )

Retrieve the number of columns.

Returns
Number  index int

Supported Clients
SmartClient, WebClient, NGClient

getMaxRowIndex
Number  getMaxRowIndex( )

Retrieve the number of rows.

Returns
Number  index int

Supported Clients
SmartClient, WebClient, NGClient

getValue
Object  getValue( Number, Number )

Returns a value from the dataset.

Parameters
Number  row  the row
Number  column  the column

Returns
Object  value Object

Supported Clients
SmartClient, WebClient, NGClient

removeRow
void  removeRow( Number )

Removes a row from the dataset.

Parameters
Number  row  the row

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellBorder
void  setCellBorder( Number, Number, Number, Number, Number, String )

Sets the specified cell border to the specified line style, width and color (use BORDERTYPE and LINESTYLE properties).

Parameters
Number  row  the row
Number  column  the column
Number  type  BORDERTYPE the border type
Number  style  LINESTYLE the line style
Number  width  the width
String  color  the color

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellBorders
void  setCellBorders( Number, Number, Number, Number, String )

Sets all cell borders to the specified line style, width and color(use LINESTYLE property).

Parameters
Number  row  the row
Number  column  the column
Number  style  LINE_STYLE the line style
Number  width  the width
String  color  the color

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellDateFormat
void  setCellDateFormat( Number, Number, String )

Set the format of the cell date (e.g. "dd.MM.yyyy").

Parameters
Number  row  the row
Number  column  the column
String  format  the format

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellFitText
void  setCellFitText( Number, Number, Boolean )

If true, fits text in the cell, compressing each paragraph to the width of the cell.

Parameters
Number  row  the row
Number  column  the column
Boolean  fit  the fit text

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellFont
void  setCellFont( Number, Number, String, String, Number, Number )

Set the textFont attributes for the cell (row, column, textFont)

Parameters
Number  row:int  the row
Number  column:int  the column
String  font:String  the font
String  color:String  the color
Number  kerning:int  the kerning
Number  spacing:int  the spacing

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellHorizontalAlignment
void  setCellHorizontalAlignment( Number, Number, Number )

Specifies the horizontal alignment of text in the cell (use ALIGMENT property).

Parameters
Number  row  the row
Number  column  the column
Number  alignment  ALIGNMENT the alignment

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellHorizontalMerge
void  setCellHorizontalMerge( Number, Number, Number )

Specifies how the cell is merged horizontally with other cells in the row (use CELL_MERGE property).

Parameters
Number  row  the row
Number  column  the column
Number  merge  CELL_MERGE the cell merge

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellNumberFormat
void  setCellNumberFormat( Number, Number, String )

Set the format of the cell number (e.g. "EUR #,###.00").

Parameters
Number  row  the row
Number  column  the column
String  format  the format

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellPadding
void  setCellPadding( Number, Number, Number, Number, Number, Number )

Specifies the amount of space (in points) to add to the contents of cell.

Parameters
Number  row  the row
Number  column  the column
Number  top  the top
Number  left  the left
Number  bottom  the bottom
Number  right  the right

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellShading
void  setCellShading( Number, Number, Number, String, String )

Specifies the shading formatting for the cell..

Parameters
Number  row  the row
Number  column  the column
Number  texture  TEXTURE the texture
String  backgroundColor  the background color
String  foregroundColor  the foreground color

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellVerticalAlignment
void  setCellVerticalAlignment( Number, Number, Number )

Specifies the vertical alignment of text in the cell (use VERTICAL_ALIGMENT property).

Parameters
Number  row  the row
Number  column  the column
Number  alignment  VERTICAL_ALIGNMENT the vertical alignment

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellVerticalMerge
void  setCellVerticalMerge( Number, Number, Number )

Specifies how the cell is merged with other cells vertically (use CELL_MERGE property).

Parameters
Number  row  the row
Number  column  the column
Number  merge  CELL_MERGE the cell merge

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setCellWrapText
void  setCellWrapText( Number, Number, Boolean )

If true, wrap text for the cell.

Parameters
Number  row  the row
Number  column  the column
Boolean  wrapText  the wrap text

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setColumnBorder
void  setColumnBorder( Number, Number, Number, Number, String )

Sets the specified column border to the specified line style, width and color (use BORDERTYPE and LINESTYLE properties).

Parameters
Number  column  the column
Number  type  BORDER_TYPE the border type
Number  style  LINE_STYLE the line style
Number  width  the width
String  color  the color

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setColumnBorders
void  setColumnBorders( Number, Number, Number, String )

Sets all column borders to the specified line style, width and color(use LINESTYLE property).

Parameters
Number  column  the column
Number  style  LINE_STYLE the line style
Number  width  the width
String  color  the color

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setColumnDateFormat
void  setColumnDateFormat( Number, String )

Set the format of the column date (e.g. "dd.MM.yyyy").

Parameters
Number  column  the column
String  format  the format

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setColumnFitText
void  setColumnFitText( Number, Boolean )

If true, fits text in the column cell, compressing each paragraph to the width of the cell.

Parameters
Number  column  the column
Boolean  fitText  the fit text

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setColumnFont
void  setColumnFont( Number, Number, String, Number, Number )

Set the textFont attributes for the column cell.

Parameters
Number  column:int  the column
Number  font:int  the font
String  color:String  the color
Number  kerning:int  the kerning
Number  spacing:int  the spacing

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setColumnHorizontalAlignment
void  setColumnHorizontalAlignment( Number, Number )

Specifies the horizontal alignment of text in the column cell (use ALIGMENT property).

Parameters
Number  column  the column
Number  alignment  ALIGNMENT the alignment

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setColumnNumberFormat
void  setColumnNumberFormat( Number, String )

Set the format of the column cell number (e.g. "EUR #,###.00").

Parameters
Number  column  the column
String  format  the format

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setColumnPadding
void  setColumnPadding( Number, Number, Number, Number, Number )

Specifies the amount of space (in points) to add to the contents of column cell.

Parameters
Number  column  the column
Number  top  the top
Number  left  the left
Number  bottom  the bottom
Number  right  the right

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setColumnShading
void  setColumnShading( Number, Number, String, String )

Specifies the shading formatting for the column cell..

Parameters
Number  column  the column
Number  texture  TEXTURE the texture
String  backgroundColor  the background color
String  foregroundColor  the foreground color

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setColumnVerticalAlignment
void  setColumnVerticalAlignment( Number, Number )

Specifies the vertical alignment of text in the column cell (use VERTICAL_ALIGMENT property).

Parameters
Number  column  the column
Number  alignment  VERTICAL_ALIGNMENT the vertical alignment

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setColumnWidth
void  setColumnWidth( Number, Number )

Sets the width of the column in points.

Parameters
Number  column  the column
Number  width  the width

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setColumnWrapText
void  setColumnWrapText( Number, Boolean )

If true, wrap text for the column cell.

Parameters
Number  column  the column
Boolean  wrapText  the wrap text

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setImageSize
void  setImageSize( Number, Number, Number )

Set the image size mode (IMAGEMODE property) or width and height.

Parameters
Number  row  the row
Number  column  the column
Number  mode  /[width

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setImageSize
void  setImageSize( Number, Number, Number, Number )

Set the image size mode (IMAGEMODE property) or width and height.

Parameters
Number  row  the row
Number  column  the column
Number  width  the width
Number  height  the height

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRow
void  setRow( Number, Array<Object> )

Set the values of a row by row index and an array of values.

Parameters
Number  index  the the index
Array<Object>  row  the row

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowAllowBreakAcrossPages
void  setRowAllowBreakAcrossPages( Number, Boolean )

Allow the row to break across pages (or keep together).

Parameters
Number  row  the row
Boolean  allow  the allow

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowBorder
void  setRowBorder( Number, Number, Number, Number, String )

Sets the specified row border to the specified line style, width and color (use BORDERTYPE and LINESTYLE properties).

Parameters
Number  row  the row
Number  type  BORDER_TYPE the border type
Number  style  LINE_STYLE the line style
Number  width  the width
String  color  the color

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowBorder
void  setRowBorder( Number, Number, Number, Number )

Sets the specified row border to the specified line style, width and color (use BORDERTYPE and LINESTYLE properties).

Parameters
Number  row  the row
Number  type  BORDER_TYPE the border type
Number  style  LINE_STYLE the line style
Number  width  the width

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowBorders
void  setRowBorders( Number, Number, Number, String )

Sets all row borders to the specified line style, width and color(use LINESTYLE property).

Parameters
Number  row  the row
Number  style  LINE_STYLE the line style
Number  width  the width
String  color  the color

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowBorders
void  setRowBorders( Number, Number, Number )

Sets all row borders to the specified line style, width and color(use LINESTYLE property).

Parameters
Number  row  the row
Number  style  LINE_STYLE the line style
Number  width  the width

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowDateFormat
void  setRowDateFormat( Number, String )

Set the format of the row cell date (e.g. "dd.MM.yyyy").

Parameters
Number  row  the row
String  format  the format

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowFitText
void  setRowFitText( Number, Boolean )

If true, fits text in the cell, compressing each paragraph to the width of the row cell.

Parameters
Number  row  the row
Boolean  fitText  the fit text

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowFont
void  setRowFont( Number, String, String, Number, Number )

Set the textFont attributes for the row cell.

Parameters
Number  row:int  the row
String  font:String  the font
String  color:String  the color
Number  kerning:int  the kerning
Number  spacing:int  the spacing

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowHeight
void  setRowHeight( Number, Number )

Sets the height of the row in points.

Parameters
Number  row  the row
Number  height  the height

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowHorizontalAlignment
void  setRowHorizontalAlignment( Number, Number )

Specifies the horizontal alignment of text in the row cell (use ALIGMENT property).

Parameters
Number  row  the row
Number  alignment  ALIGNMENT the alignment

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowIsHeader
void  setRowIsHeader( Number, Boolean )

When a row is set as header it will be repeated when the table breaks across pages.

Parameters
Number  row  the row
Boolean  isHeader  the is header

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowNumberFormat
void  setRowNumberFormat( Number, String )

Set the format of the row cell number (e.g. "EUR #,###.00").

Parameters
Number  row  the row
String  format  the format

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowPadding
void  setRowPadding( Number, Number, Number, Number, Number )

Specifies the amount of space (in points) to add to the contents of row cell.

Parameters
Number  row  the row
Number  top  the top
Number  left  the left
Number  bottom  the bottom
Number  right  the right

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowShading
void  setRowShading( Number, Number, String, String )

Specifies the shading formatting for the row cell..

Parameters
Number  row  the row
Number  texture  TEXTURE the texture
String  backgroundColor  the background color
String  foregroundColor  the foreground color

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowVerticalAlignment
void  setRowVerticalAlignment( Number, Number )

Specifies the vertical alignment of text in the row cell (use VERTICAL_ALIGMENT property).

Parameters
Number  row  the row
Number  alignment  VERTICAL_ALIGNMENT the vertical alignment

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setRowWrapText
void  setRowWrapText( Number, Boolean )

If true, wrap text for the row cell.

Parameters
Number  row  the row
Boolean  wrapText  the wrap text

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

setValue
void  setValue( Number, Number, Object )

Set/replace a value in the dataset (use row = -1 to set columnname).

Parameters
Number  row  the row
Number  column  the column
Object  value  the value

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient

sort
void  sort( Number, Boolean )

Sort a row, ascending or descending.

Parameters
Number  column  the column
Boolean  order  asc/desc

Returns
void  

Supported Clients
SmartClient, WebClient, NGClient