GetColumnsConfig()
This Method will return an object with Columns (After Passing them to JExcel), AgColumns (After
Updating passed columns with new column data types), AgColumnsBeforeSetup (Original Columns
passed by the Developer)
GetJSpreadsheetObject()
This Method will return full object of the JExcel
GetData(onlyHighlighedCells: boolean = false)
JExcel Docs - getData: Get the full or partial table data @Param boolan
onlyHighlighedCells - Get only highlighted cells
GetRowData(rowNumber: number)
JExcel Docs - getRowData: Get the data from one row by number @Param integer rowNumber -
Row number
SetRowData(rowNumber: number, rowData: Array)
JExcel Docs - setRowData: Set the data from one row by number @Param integer rowNumber -
Row number @param array rowData - Row data
GetColumnData(columnNumber: number)
JExcel Docs - getColumnData: Get the data from one column by number @Param integer
columnNumber - Column number
SetColumnData(columnNumber: number, colData: Array)
JExcel Docs - setColumnData: Set the data from one column by number @Param integer
columnNumber - Column number @param array colData - Column data
SetData(newData: any)
JExcel Docs - setData: Set the table data @Param json newData - New json data, null will
reload what is in memory.
SetMerge(columnName: string, colspan: number, rowspan: number)
JExcel Docs - setMerge: Merge cells @Param string columnName - Column name, such as A1.
@Param integer colspan - Number of columns @Param integer rowspan - Number of rows
GetMerge(columnName: string)
JExcel Docs - getMerge: Get merged cells properties @Param string columnName - Column
name, such as A1.
RemoveMerge(columnName: string)
JExcel Docs - removeMerge: Destroy merged by column name @Param string columnName - Column
name, such as A1.
DestroyMerged()
JExcel Docs - destroyMerged: Destroy all merged cells
GetCell(columnName: string)
JExcel Docs - getCell: get current cell DOM @Param string columnName - str compatible with
excel, or as object.
GetLabel(columnName: string)
JExcel Docs - getLabel: get current cell DOM innerHTML @Param string columnName - str
compatible with excel, or as object.
GetValue(cellIdent: any)
JExcel Docs - getValue: get current cell value @Param mixed cellIdent - str compatible
with excel, or as object.
GetValueFromCoords(x: number, y: number)
JExcel Docs - getValueFromCoords: get value from coords @Param integer x @Param integer y
SetValue(cellIdent: any, Value: string, force: boolean)
JExcel Docs - setValue: change the cell value @Param mixed cellIdent - str compatible with
excel, or as object. @Param string Value - new value for the cell @Param bool force - update
readonly columns
SetValueFromCoords(x: number, y: number, Value: string, force: boolean)
JExcel Docs - setValueFromCoords: get value from coords @Param integer x @Param integer y
@Param string Value - new value for the cell @Param bool force - update readonly columns
ResetSelection(executeBlur: any)
JExcel Docs - resetSelection: Reset the table selection @Param boolean executeBlur -
execute the blur from the table
UpdateSelection(startCell: any, endCell: any, ignoreEvents: boolean)
JExcel Docs - updateSelection: select cells @Param object startCell - cell object @Param
object endCell - cell object @Param boolean ignoreEvents - ignore onselection event
UpdateSelectionFromCoords(x1: number, y1: number, x2: number, y2: number)
JExcel Docs - updateSelectionFromCoords: select cells @Param integer x1 @Param integer y1
@Param integer x2 @Param integer y2
GetWidth(columnNumber: number)
JExcel Docs - getWidth: get the current column width @Param integer columnNumber - column
number starting on zero
SetWidth(columnNumber: number, newColumnWidth: string)
JExcel Docs - setWidth: change column width @Param integer columnNumber - column number
starting on zero @Param string newColumnWidth - New column width
GetHeight(rowNumber: number)
JExcel Docs - getHeight: get the current row height @Param integer rowNumber - row number
starting on zero
SetHeight(rowNumber: number, newRowHeight: string)
JExcel Docs - setHeight: change row height @Param integer rowNumber - row number starting
on zero @Param string newRowHeight- New row height
GetHeader(columnNumber: number)
JExcel Docs - getHeader: get the current header by column number @Param integer
columnNumber - Column number starting on zero
GetHeaders()
JExcel Docs - getHeaders: get all header titles
SetHeader(columnNumber: number, columnTitle: string)
JExcel Docs - setHeader: change header by column @Param integer columnNumber - column
number starting on zero @Param string columnTitle - New header title
GetStyle(cell: any)
JExcel Docs - getStyle: get table or cell style @Param mixed - cell identification or null
for the whole table.
SetStyle(data: any, k: string | undefined = undefined, v: string | undefined = undefined)
JExcel Docs - setStyle: set cell(s) CSS style @Param mixed - json with whole table style
information or just one cell identification. Ex. A1. @param k [optional]- CSS key @param v
[optional]- CSS value
ResetStyle(columnName: string)
JExcel Docs - resetStyle: remove all style from a cell @Param string columnName - Column
name, example: A1, B3, etc
GetComments(cellIdentification: any = null)
JExcel Docs - getComments: get cell comments @Param mixed - cell identification or null
for the whole table.
SetComments(cell: any, text: string)
JExcel Docs - setComments: set cell comments @Param cell - cell identification @Param text
- comments
OrderBy(columnNumber: number, sortType: boolean)
JExcel Docs - orderBy: reorder a column asc or desc @Param integer columnNumber - column
number starting on zero @Param smallint sortType - One will order DESC, zero will order ASC,
anything else will toggle the current order
GetConfig()
JExcel Docs - getConfig: get table definitions
InsertColumn(numOfColumns: any, columnNumber: number, insertBefore: boolean, properties: any)
JExcel Docs - insertColumn: add a new column @param mixed - num of columns to be added or
data to be added in one single column @param int columnNumber - number of columns to be created
@param boolean insertBefore @param object properties - column properties
DeleteColumn(columnNumber: number, numOfColumns: number)
JExcel Docs - deleteColumn: remove column by number @Param integer columnNumber - Which
column should be excluded starting on zero @param integer numOfColumns - number of columns to be
excluded from the reference column
MoveColumn(columnPosition: number, newColumnPosition: number)
JExcel Docs - moveColumn: change the column position @Param integer columnPosition @Param
integer newColumnPosition
InsertRow(numberOfBlankLines: any, rowNumber: number, insertBefore: boolean)
JExcel Docs - insertRow: add a new row @Param mixed - number of blank lines to be insert
or a single array with the data of the new row @Param integer rowNumber - reference row number
@param boolean insertBefore
DeleteRow(rowNumber: number, numOfRows: number)
JExcel Docs - deleteRow: remove row by number @Param integer rowNumber - Which row should
be excluded starting on zero @Param integer numOfRows - number of lines to be excluded
MoveRow(rowPosition: number, newRowPosition: number)
JExcel Docs - moveRow: change the row position @Param integer rowPosition @Param integer
newRowPosition
Download(parsedFormulas: boolean = false)
JExcel Docs - download: get the current data as a CSV file @Param bool - true to download
parsed formulas.
GetMeta(cellIdentification: any)
JExcel Docs - getMeta: get the table or cell meta information @Param mixed - cell
identification or null for the whole table.
SetMeta(Data: any)
JExcel Docs - setMeta: set the table or cell meta information @Param mixed - json with
whole table meta information.
Fullscreen(fullscreen: boolean)
JExcel Docs - fullscreen: Toogle table fullscreen mode @Param boolan fullscreen - define
fullscreen status as true or false
GetSelectedRows(asIds: boolean)
JExcel Docs - getSelectedRows: Get the selected rows @Param boolan asIds - Get the
rowNumbers or row DOM elements
GetSelectedColumns()
JExcel Docs - getSelectedColumns: Get the selected columns
ShowIndex()
JExcel Docs - showIndex: show column of index numbers
HideIndex()
JExcel Docs - hideIndex: hide column of index numbers
Search(searchString: string)
JExcel Docs - search: search in the table, only if directive is enabled during
inialization. @Param string - Search for word
ResetSearch()
JExcel Docs - resetSearch: reset search table
WhichPage()
JExcel Docs - whichPage: Which page showing on Jspreadsheet - Valid only when pagination
is true.
Page(pageNumber: number)
JExcel Docs - page: Go to page number- Valid only when pagination is true. @Param integer
- Go to page number
Undo()
JExcel Docs - undo: Undo last changes
Redo()
JExcel Docs - redo: Redo changes