Managing Sheet with APIs

SheetAPI.updateFloatings

Document -> Managing Sheet Data with APIs -> EnterpriseSheet.api.SheetAPI -> SheetAPI.updateFloatings

updateFloatings( hd, floatings, callback, scope )

SheetAPI.updateFloatings method is used to update a list of floatings for the passed sheet object.

Parameters

hd : object

The handle information of the Sheet application your created.

floatings : Object

An array of the floatings need to be updated, every item of this array will be an object. Each object includes the following items:

sheet	The defined sheet id of the cell you want to update, if ignore, the default is currently active tab id
name	The name of floating to be updated.
ftype	Different type, such as: meg for merge type.
json	json object for the above type.

callback : Function

The callback function which will be called after the file is loaded.

scope : Object

The scope for the callback function.

Example code


	var floatings = [];
	floatings.push( {sheet: _sheetId, name:"2015-01", ftype:"meg", json:"[1,3,1,6]"});
	floatings.push( {sheet: _sheetId, name:"2015-02", ftype:"meg", json:"[1,10,1,12]"});
    
	SHEET_API.updateFloatings(SHEET_API_HD, floatings);

The above method will update cells by merge.

{
        sheet:1,       // the defined sheet id of the cell you want to update
        name: "aha",   // the name of object
        ftype: "meg",  // floating type
        json:{         // json property contains specific information for the type
            
        }
}

To see detail definition for the cell properties, please go to page: Cell Properties Definition