Class $.wijmo.wijspread.RangeGroup

Class Summary
Constructor Attributes	Constructor Name and Description
	$.wijmo.wijspread.RangeGroup(count) Represents a range group for the worksheet.

Method Summary
Method Attributes	Method Name and Description
	createRangeGroup() Re-creates the range group.
	equals(obj) Determines whether the specified outline (range group) is equal to the current range group.
	expand(level, expand) Expands all outlines (range groups), by the specified level.
	expandGroup(groupInfo, expand) Expands or collapses the specified outline (range group) of rows or columns.
	find(index, level) Gets the outline (range group) with a specified group level and row or column index.
	getCollapsed(index) Gets the collapsed internal.
	getLevel(index) Gets the level of a specified row or column.
	getMaxLevel() Gets the number of the deepest level.
	getState(group) Gets the state for the specified group.
	group(index, count) Groups a range of rows or columns into an outline (range group) from a specified start index using a specified amount.
	isCollapsed(index) Determines whether the range group at the specified index is collapsed.
	isGroupEnd(index, indexNext, processLevel) Determines whether [is group end] [the specified index].
	rangeGroupItemInfoEquals(item1, item2) Compares the information for two range groups to see if the information is equal.
	refresh() Refreshes this range group.
	resumeAdding() Resumes the adding.
	setCollapsed(index, collapsed) Sets the collapsed level.
	suspendAdding() Suspends the adding.
	ungroup() Removes all outlines (range groups).
	ungroupRange(index, count) Removes a range of rows or columns from the outline (range group) at the specified start index by a specified amount.

Class Detail

$.wijmo.wijspread.RangeGroup(count)

Represents a range group for the worksheet.

Parameters:
{number} count: The count of rows or columns.

Method Detail

{RangeGroupInfo} createRangeGroup()

Re-creates the range group.

Returns:: {RangeGroupInfo} The range group info.

{boolean} equals(obj)

Determines whether the specified outline (range group) is equal to the current range group.

Parameters:
{object} obj: The range group to compare with the current range group.

Returns:: {boolean} true if the specified range group is equal to the current range group; otherwise, false.

expand(level, expand)

Expands all outlines (range groups), by the specified level.

Parameters:
{number} level: The level of the outline to expand or collapse.
{boolean} expand: Whether to expand the groups.

expandGroup(groupInfo, expand)

Expands or collapses the specified outline (range group) of rows or columns.

Parameters:
{RangeGroupInfo} groupInfo: The group information of the range group.
{boolean} expand: Whether to expand the group.

{boolean} find(index, level)

Gets the outline (range group) with a specified group level and row or column index.

Parameters:
{number} index: The index of the row or column.
{number} level: The level of the outline (range group).

Returns:: {boolean} Returns the specified range group.

{boolean} getCollapsed(index)

Gets the collapsed internal.

Parameters:
{boolean} index: The index.

Returns:: {boolean} true if collapsed; otherwise, false.

{number} getLevel(index)

Gets the level of a specified row or column. remark: The level's index is zero-based.

Parameters:
{number} index: The index of the row or column.

Returns:: {number} Returns the level for the row or column.

{number} getMaxLevel()

Gets the number of the deepest level. remark: The level index is zero-based.

Returns:: {number} The number of the deepest level.

{GroupState} getState(group)

Gets the state for the specified group.

Parameters:
{RangeGroupInfo} group: The group.

Returns:: {GroupState} The group state.

group(index, count)

Groups a range of rows or columns into an outline (range group) from a specified start index using a specified amount.

Parameters:
{number} index: The group starting index.
{number} count: The number of rows or columns to group.

{boolean} isCollapsed(index)

Determines whether the range group at the specified index is collapsed.

Parameters:
index: The index of the row or column in the range group.

Returns:: {boolean} true if the specified row or column is collapsed; otherwise, false.

{boolean} isGroupEnd(index, indexNext, processLevel)

Determines whether [is group end] [the specified index].

Parameters:
{number} index: The index.
{number} indexNext: The next index.
{number} processLevel: The process level.

Returns:: {boolean} true if [is group end] [the specified index]; otherwise, false.

{boolean} rangeGroupItemInfoEquals(item1, item2)

Compares the information for two range groups to see if the information is equal.

Parameters:
{RangeGroupItemInfo} item1: The first group.
{RangeGroupItemInfo} item2: The second group.

Returns:: {boolean} true if the information is equal; otherwise, false.

refresh()

Refreshes this range group.

resumeAdding()

Resumes the adding.

Returns:

setCollapsed(index, collapsed)

Sets the collapsed level.

Parameters:
{number} index: The index.
{boolean} collapsed: Set to true to collapse the level.

suspendAdding()

Suspends the adding.

Returns:

ungroup()

Removes all outlines (range groups).

ungroupRange(index, count)

Removes a range of rows or columns from the outline (range group) at the specified start index by a specified amount.

Parameters:
{number} index: The group starting index.
{number} count: The number of rows or columns to remove.

Classes

Class $.wijmo.wijspread.RangeGroup