getCellFilter
returns the filter set in a cell
object getCellFilter(number row,number column, [string page] );
| row | number | the row id |
| column | number | the column id |
| page | string | optional, the name of the sheet |
| object | an 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 the following 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
- mode - (string) the filter mode, if it was set
- value - (object) the filter value, if it was set
- lastRow - (number) the row where the filtering stops, if it was set
See also
Back to top
Join Our Forum
We've retired comments here. Visit our forum for faster technical support,
connect with other developers, and share your feedback there.