SpreadJS 13
GC.Spread.Sheets.FloatingObjects Namespace / FloatingObject type / isLocked Method
The value that indicates whether this floating object is locked.
In This Topic
    isLocked Method
    In This Topic
    Gets or sets whether this floating object is locked.
    Syntax
    var instance = new GC.Spread.Sheets.FloatingObjects.FloatingObject(name, x, y, width, height);
    var returnValue; // Type: any
    returnValue = instance.isLocked(value);
    function isLocked( 
       value : boolean
    ) : any;

    Parameters

    value
    The value that indicates whether this floating object is locked.

    Return Value

    If no value is set, returns whether this floating object is locked; otherwise, returns the floating object.
    Example
    This example creates a floating object. The second example locks a slicer for a table.
    var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
    customFloatingObject.x(10);
    customFloatingObject.y(10);
    customFloatingObject.width(60);
    customFloatingObject.height(64);
    customFloatingObject.isLocked(true);
    var btn = document.createElement('button');
    btn.style.width = "60px";
    btn.style.height = "30px";
    btn.innerText = "button";
    customFloatingObject.content(btn);
    activeSheet.floatingObjects.add(customFloatingObject);
    activeSheet.options.isProtected = true;
    //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");
     //change the slicer properties.
    slicer.position(new GC.Spread.Sheets.Point(100, 200));
    slicer.isLocked(true);
    activeSheet.options.isProtected = true;
    slicer.style(style1);
    See Also