SpreadJS 13
GC.Spread.Sheets.Slicers Namespace / Slicer type / sortState Method
The sort state of the slicer.
In This Topic
    sortState Method
    In This Topic
    Gets or sets the sort state of the slicer.
    Syntax
    var instance = new GC.Spread.Sheets.Slicers.Slicer(name, table, columnName);
    var returnValue; // Type: any
    returnValue = instance.sortState(value);
    function sortState( 
       (optional) value : SortState
    ) : any;

    Parameters

    value
    The sort state of the slicer.

    Return Value

    If no value is set, returns the sort state of the slicer; otherwise, returns the slicer.
    Example
    This example sets the sort order of the items in the slicer.
    //create a table
    datas = [
        ["1", "NewYork", "1968/6/8", "80", "180"],
        ["4", "NewYork", "1972/7/3", "72", "168"],
        ["4", "NewYork", "1964/3/2", "71", "179"],
        ["5", "Washington", "1972/8/8","80", "171"],
        ["6", "Washington", "1986/2/2", "89", "161"],
        ["7", "Washington", "2012/2/15", "71", "240"]];
    var table = activeSheet.tables.addFromDataSource("table1", 2, 2, datas);
    dataColumns = ["Name", "City", "Birthday", "Weight", "Height"];
    table.setColumnName(0, dataColumns[0]);
    table.setColumnName(1, dataColumns[1]);
    table.setColumnName(2, dataColumns[2]);
    table.setColumnName(3, dataColumns[3]);
    table.setColumnName(4, dataColumns[4]);
    
    var style1 = new GC.Spread.Sheets.Slicers.SlicerStyles.light4();
    //add a slicer to the sheet and return the slicer instance
    var slicer = activeSheet.slicers.add("slicer1",table.name(),"Height");
    //set slicer properties
    slicer.position(new GC.Spread.Sheets.Point(100, 200));
    slicer.sortState(GC.Spread.Sheets.SortState.descending);
    slicer.style(style1);
    See Also

    Reference

    Slicer type