类: OutlineInfo

Sheets.Outlines.OutlineInfo

Table of contents

构造方法

• constructor

属性

• children
• end
• level
• model
• parent
• start

方法

• addChild
• contains
• state

构造方法

constructor

• new OutlineInfo(model, start, end, level)

区域分组信息

参数

属性

children

• children: any[]

分组的子级

代码示例

activeSheet.rowOutlines.group(2, 10);
activeSheet.rowOutlines.group(4, 2);
var outlineInfo = activeSheet.rowOutlines.find(2, 0);
console.log(outlineInfo.children[0] === activeSheet.rowOutlines.find(4, 1)); // true

end

• end: number

分组的结束索引

代码示例

activeSheet.rowOutlines.group(2, 10);
var outlineInfo = activeSheet.rowOutlines.find(2, 0);
console.log(outlineInfo.end); // 11

level

• level: number

分组的级别

代码示例

activeSheet.rowOutlines.group(2, 10);
var outlineInfo = activeSheet.rowOutlines.find(2, 0);
console.log(outlineInfo.level); // 0

model

• model: Outline

分组的所在者

代码示例

activeSheet.rowOutlines.group(2, 10);
var outlineInfo = activeSheet.rowOutlines.find(2, 0);
console.log(outlineInfo.model === activeSheet.rowOutlines); // true

parent

• parent: OutlineInfo

分组的父级

代码示例

activeSheet.rowOutlines.group(2, 10);
activeSheet.rowOutlines.group(4, 2);
var outlineInfo = activeSheet.rowOutlines.find(4, 1);
console.log(outlineInfo.parent === activeSheet.rowOutlines.find(2, 0)); // true

start

• start: number

分组的起始索引

代码示例

activeSheet.rowOutlines.group(2, 10);
var outlineInfo = activeSheet.rowOutlines.find(2, 0);
console.log(outlineInfo.start); // 2

方法

addChild

▸ addChild(child): void

添加子级

参数

返回值

void

contains

▸ contains(index): boolean

将此实例与指定的OutlineInfo对象进行比较，并返回其相对值的指示

代码示例

activeSheet.rowOutlines.group(2, 10);
activeSheet.rowOutlines.group(4, 2);
var outlineInfo1 = activeSheet.rowOutlines.find(2, 0);
var outlineInfo2 = activeSheet.rowOutlines.find(4, 1);
console.log(outlineInfo1.contains(5)); // true;
console.log(outlineInfo2.contains(5)); // true;
console.log(outlineInfo1.contains(6)); // true;
console.log(outlineInfo2.contains(6)); // false;

参数

返回值

boolean

如果区域分组包含指定的索引，返回true;否则返回false

state

▸ state(value?): OutlineState

获取或设置此区域分组的状态

代码示例

activeSheet.rowOutlines.group(2, 10);
activeSheet.rowOutlines.group(4, 2);
var outlineInfo = activeSheet.rowOutlines.find(4, 1);
console.log(outlineInfo.state()); // equals to GC.Spread.Sheets.Outlines.OutlineState.expanded
outlineInfo.state(GC.Spread.Sheets.Outlines.OutlineState.collapsed);
console.log(outlineInfo.state()); // equals to GC.Spread.Sheets.Outlines.OutlineState.collapsed
activeSheet.repaint(); // the outline is collapsed

参数

返回值

OutlineState

区域分组的状态