Class NexcelCellList

NexcelCellList

Class Summary
Constructor Attributes Constructor Name and Description
 
NexcelCellList is a Collection of Cells in the workbook, It is a custom class to handle with all the Cell in the WorkBook

Method Summary

Class Detail

NexcelCellList()
NexcelCellList is a Collection of Cells in the workbook, It is a custom class to handle with all the Cell in the WorkBook
require('NexcelCellList')

Method Detail

  • <static> {Void} NexcelCellList.addCell(cell)
    It adds the given cell to the List. It checks whether the given cell is already existing or not, If existing, it will not add a new Object.
    Parameters:
    cell
    The cell Object
    Returns:
    {Void}
  • <static> {Object} NexcelCellList.addCellWithDetails(sheetId, row, col, formula, value)
    It adds the given cell to the List. It checks whether the given cell is already existing or not, If existing, it will not add a new Object.
    Parameters:
    sheetId
    The sheet where the row is added/Deleted.
    row
    The row of teh cell
    col
    the column number of the cell
    formula
    Formula of teh cell, if no formula it will be null.
    value
    the value of teh cell.
    Returns:
    {Object} if the sheetId, row, col exists it returns Object, otherwise false.
  • <static> {Array[CellObject]} NexcelCellList.getListOfCellWithFormula(sheetId, startPoint, endPoint)
    It returns an array of Cell Object for the given range of cells in the given sheetId. Returns An ArrayList of All the cells which have formulas. if sheetId provided, then filter by sheetId, and if startPoint provided, then it will be filtered.
    Parameters:
    sheetId
    The sheet where the row is added/Deleted.
    startPoint
    {startPoint.row, startPoint.col} An Object with rows and columns
    endPoint
    {endPoint.row, endPoint.col} An Object with rows and columns
    Returns:
    {Array[CellObject]} An Array of Cell Object
  • <static> {Array} NexcelCellList.getRangeCellDataArray(sheetId, startRow, startCol, endRow, endCol)
    It returns an array of data for the given range of cells in the given sheetId
    Parameters:
    sheetId
    The sheet where the row is added/Deleted.
    startRow
    The startRow of teh area.
    startCol
    The start column of the Area.
    endRow
    The end Row of teh area.
    endCol
    The end column of the Area.
    Returns:
    {Array} An Array of Data
  • <static> {Object} NexcelCellList.isExist()
    The function checks whether the given cell is available in the CellList Object , if yest return that object otherwise return false. Cell A1=>1:1 Cell A1 represented as row 1 col 1
    Returns:
    {Object} if the sheetId, row, col exists it returns Object, otherwise false.
  • <static> {Object} NexcelCellList.moveColumn(sheetId, pos, rows)
    It moves a column by all teh cells in the list which is left or right to it accordingly. Rows can be -ve value -> -2 means two columns deleted +2 means added 2 rows
    Parameters:
    sheetId
    The sheet where the row is added/Deleted.
    pos
    The position of the current active row.
    rows
    The number of rows added/deleted +1 means 1 row added, -2 means 2 rows deleted.
    Returns:
    {Object} if the sheetId, row, col exists it returns Object, otherwise false.
  • <static> {Object} NexcelCellList.moveRow(sheetId, pos, rows)
    It moves a row by all teh cells in the list which is above or below it accordingly. Rows can be -ve value -> -2 means two rows deleted +2 means added 2 rows
    Parameters:
    sheetId
    The sheet where the row is added/Deleted.
    pos
    The position of the current active row.
    rows
    The number of rows added/deleted +1 means 1 row added, -2 means 2 rows deleted.
    Returns:
    {Object} if the sheetId, row, col exists it returns Object, otherwise false.