クラス: 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()); // GC.Spread.Sheets.Outlines.OutlineState.expanded と等しくなります。
outlineInfo.state(GC.Spread.Sheets.Outlines.OutlineState.collapsed);
console.log(outlineInfo.state()); // GC.Spread.Sheets.Outlines.OutlineState.collapsed と等しくなります。
activeSheet.repaint(); // アウトラインを折りたたみます。

パラメータ

戻り値

OutlineState

このアウトライン（範囲グループ）の状態。