autoMerge Method

In This Topic

Applies auto merge for a range.

Syntax

var instance = new GC.Spread.Sheets.Worksheet(name);
var value; // Type: Array
value = instance.autoMerge(range, direction, mode, sheetArea);

function autoMerge( 
   range : Range,
   direction : AutoMergeDirection,
   mode : AutoMergeMode,
   sheetArea : SheetArea
) : Array;

range: The auto merge range.
direction: The auto merge direction. If this parameter is not provided, it defaults to column. Specially, if the direction is none, the auto merge for the range will be canceled.
mode: The auto merge mode. If this parameter is not provided, it defaults to free.
sheetArea: The sheet area of the auto merge range. If this parameter is not provided, it defaults to viewport.

If no parameter is provided, returns all auto merge range infos of current worksheet. Each range info contains range, direction, mode, sheetArea.

Example

var range = new GC.Spread.Sheets.Range(-1, 0, -1, 1);
sheet.autoMerge(range);