Class WorkBookDataService

WorkBookDataService

Class Summary
Constructor Attributes Constructor Name and Description
 
A Class to handle All Kind of Data Services Associated with Nexcel Sheet

Method Summary

Class Detail

WorkBookDataService()
A Class to handle All Kind of Data Services Associated with Nexcel Sheet
require('WorkBookDataService')

Method Detail

  • <static> {Void} WorkBookDataService.addColumn(sheetId, pos, columns)
    An Asynchronous process. It adds a Column in the workbook
    Parameters:
    sheetId
    The sheet Id
    pos
    the position where the rows are added.
    columns
    {Integer} The number of columns are added.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.addRow(sheetId, pos, rows)
    An Asynchronous process. It adds a Row in the workbook
    Parameters:
    sheetId
    The sheet Id
    pos
    the position where the rows are added.
    rows
    {Integer} The number of rows are added.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.addSheet(wsid, sheetObj, callback)
    An Asynchronous process. It calls the server with sheet details
    Parameters:
    wsid
    the Workbook id,
    sheetObj
    The sheet Object contains id, rows, columns
    callback
    The function need to be called once the response received.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.addWorkBook(name, folderId, callback)
    An Asynchronous process. It calls the server with parent ID, so that it will return the list of files/Workbooks and folders under it. Then it parses the data and send back to the callback function.
    Parameters:
    name
    The name of the WorkBook need to be added.
    folderId
    the Parent folder where the workbook is created.
    callback
    The call back function will be called once the Asynchronous process is completed.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.deleteSheet(sheetId, name)
    An Asynchronous process. It calls the server with updated sheet details
    Parameters:
    sheetId
    The sheet Id which need to be renamed
    name
    The new name for the Sheet
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.duplicateWorkBook(wsId, callback)
    An Asynchronous process. It calls the server with workbook id, It duplicates all the data associated with the workbook including Sheets, ranges cell and formulas.
    Parameters:
    wsId
    the Workbook id, which need to be duplicated.
    callback
    The call back function will be called once the Asynchronous process is completed.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.loadCellsOnSheet(wsid, sheetObj, callback)
    An Asynchronous process. It calls the server with workbook id,sheetId, Hence it can load the entire data cells in the sheet Obj. It will ensure entire server data is present in the cient side as well. for the sheet view.
    Parameters:
    wsid
    the Workbook id,
    sheetObj
    The sheet Object contains id, rows, columns
    callback
    The function need to be called once the response received.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.loadColumnSize(wsId, callback)
    An Asynchronous process. It loads the column size for the workbook for each sheets in the workbook.
    Parameters:
    wsId
    The worksheet Id
    callback
    {Function} The given callback function will be called once the data loading is completed.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.loadRowSize(wsId, callback)
    An Asynchronous process. It loads the row size for the workbook for each sheets in the workbook.
    Parameters:
    wsId
    The worksheet Id
    callback
    {Function} The given callback function will be called once the data loading is completed.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.loadWorkBooks(parentId, callback)
    An Asynchronous process. It calls the server with parent ID, so that it will return the list of files/Workbooks and folders under it. Then it parses the data and send back to the callback function.
    Parameters:
    parentId
    the Parent folder Id
    callback
    The call back function will be called once the Asynchronous process is completed.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.loadWorkBookSheets(wsid, callback)
    An Asynchronous process. It calls the server with workbook id, Once it gets the JSON response of the list of sheets in the workbook, It calls the callback function
    Parameters:
    wsid
    the Workbook id,
    callback
    The function need to be called once the response received.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.loadZeroSheetInitialData(wsid, sheetObj, maxRow, callback)
    An Asynchronous process. It calls the server with workbook id,sheetId, Hence it can load only the initial view data is loaded with respect to teh Size of teh Sheet to ensure it happens very fastly.
    Parameters:
    wsid
    the Workbook id,
    sheetObj
    The sheet Object contains id, rows, columns
    maxRow
    The maximum number of rows can be viewed initially in the screen.
    callback
    The function need to be called once the response received.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.renameSheet(sheetId, name)
    An Asynchronous process. It calls the server with updated sheet details
    Parameters:
    sheetId
    The sheet Id which need to be renamed
    name
    The new name for the Sheet
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.renameWorkBook(id, name)
    An Asynchronous process. It calls the server with workbook id, It renames the work book with the new name.
    Parameters:
    id
    the Workbook id, which need to be renamed.
    name
    The new name for the Workbook
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.setActiveSheet(wsid, sheetId)
    An Asynchronous process. It calls the server with workbook id, It renames the work book with the new name.
    Parameters:
    wsid
    the Workbook id, where the active sheet number need to be updated.
    sheetId
    The new active sheet id
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.updateColumnSize(sheetId, colIndex, width)
    An Asynchronous process. It calls the server with updated column details
    Parameters:
    sheetId
    The sheet Id which need to be renamed
    colIndex
    The column index A is 1
    width
    The column width in pixel.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.updateListOfCells(wsid, sheetObj, callback)
    An Asynchronous process. It calls the server with updated list of cells, It ensures that multiple cell update can be applied together in the server with making delays. It ensures that it calls batch update in server side.
    Parameters:
    wsid
    the Workbook id,
    sheetObj
    The sheet Object contains id, rows, columns
    callback
    The function need to be called once the response received.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.updateRowSize(sheetId, rowIndex, height)
    An Asynchronous process. It calls the server with updated row size details
    Parameters:
    sheetId
    The sheet Id which need to be renamed
    rowIndex
    The column index A is 1
    height
    The height of the rows in pixel.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.updateSheetOrder(wsId, sheetOrder)
    An Asynchronous process. It updates the server with which order the sheets are arranges in the UI.
    Parameters:
    wsId
    The worksheet Id
    sheetOrder
    {Array} An Array of the order of the sheets.
    Returns:
    {Void}
  • <static> {Void} WorkBookDataService.updateSheetSize(sheetId, rows, columns)
    An Asynchronous process. It calls the server with updated sheet details
    Parameters:
    sheetId
    The sheet Id which need to be renamed
    rows
    The new rows in the sheet
    columns
    The new rows in the sheet
    Returns:
    {Void}