SpreadJS 13
GC.Spread.Sheets.Slicers Namespace / SlicerCollection type / add Method
The name of the slicer.
The name of the table that relates to the slicer.
The name of the table column that relates to the slicer.
The style of the slicer.
In This Topic
    add Method
    In This Topic
    Adds a slicer to the sheet.
    Syntax
    var instance = new GC.Spread.Sheets.Slicers.SlicerCollection(sheet);
    var value; // Type: Slicer
    value = instance.add(name, tableName, columnName, style);
    function add( 
       name : string,
       tableName : string,
       columnName : string,
       style : SlicerStyle
    ) : Slicer;

    Parameters

    name
    The name of the slicer.
    tableName
    The name of the table that relates to the slicer.
    columnName
    The name of the table column that relates to the slicer.
    style
    The style of the slicer.
    Example
    This example uses the addSlicer method.
    //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]);
     
    //add a slicer to the sheet and return the slicer instance.
    var slicer = activeSheet.slicers.add("slicer1",table.name(),"Name");
     //change the slicer properties.
    slicer.position(new GC.Spread.Sheets.Point(100, 200));
    See Also