getCellFilter

returns the filter set in a cell

object getCellFilter(number row,number column, [string page] );
rownumberthe row id
columnnumberthe column id
pagestringoptional, the name of the sheet
objectan object with a set of options and the IDs of the row and column (see the details)

Example

// setting the cell filter
$$("ssheet").setCellFilter(2, 1, ["", "Europe", "Asia", "America"], "Sheet1");
 
// getting the cell filter
$$("ssheet").getCellFilter(2, 1, "Sheet1"); 
// -> { options: Array(4), row: 2, column: 1 }

Details

The returned object contains 3 properties:

  • options - (string/array) a string or an array with the filter option(s)
  • row - (number) the ID of the row
  • column - (number) the ID of the column
See also
Back to top