- GC
- GC.Data
- GC.Pivot
- GC.Spread.Pivot
- GC.Spread.Slicers
- GC.Spread.CalcEngine
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Report
- GC.Spread.Sheets
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.DataCharts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.DataRange
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Sheets.Designer
- GC.Spread.Sheets.GanttSheet
- GC.Spread.Excel
GC.Spread.Sheets.Outlines.Outline
クラス: Outline
Table of contents
コンストラクタ
メソッド
- direction
- expand
- expandGroup
- find
- getCollapsed
- getLevel
- getMaxLevel
- getState
- group
- isCollapsed
- isGroupEnd
- refresh
- resumeAdding
- setCollapsed
- suspendAdding
- ungroup
- ungroupRange
コンストラクタ
constructor
• new Outline(count)
ワークシートのアウトライン（範囲グループ）を表します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
count |
number |
行または列の数。 |
メソッド
direction
▸ direction(direction?): any
アウトライン（範囲グループ）の方向を指定します。
実例
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(3,2);
activeSheet.columnOutlines.group(4,1);
activeSheet.rowOutlines.direction(GC.Spread.Sheets.Outlines.OutlineDirection.forward);
activeSheet.resumePaint();
パラメータ
| 名前 | 型 |
|---|---|
direction? |
OutlineDirection |
戻り値
any
値が設定されていない場合は、アウトライン（範囲グループ）の方向を返します。値が設定されている場合は、アウトラインを返します。
expand
▸ expand(level, expand): void
指定したレベルを使用してすべてのアウトライン（範囲グループ）を展開します。
実例
// 次のサンプルコードは、expandメソッドを使用します。
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.expand(0,false);
activeSheet.resumePaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
level |
number |
展開または折りたたむアウトラインのレベル。 |
expand |
boolean |
グループを展開するかどうか。 |
戻り値
void
expandGroup
▸ expandGroup(groupInfo, expand): void
指定した行または列のアウトライン（範囲グループ）を展開または折りたたみます。
実例
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(2, 5);
var groupInfo = activeSheet.rowOutlines.find(2, 0);
activeSheet.rowOutlines.expandGroup(groupInfo, false);
activeSheet.resumePaint();//グループが作成され、折りたたまれた。
activeSheet.rowOutlines.expandGroup(groupInfo, true);//グループを展開します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
groupInfo |
OutlineInfo |
範囲グループのグループ情報。 |
expand |
boolean |
グループを展開するかどうか。 |
戻り値
void
find
▸ find(index, level): OutlineInfo
指定したグループレベルと行または列インデックスを持つアウトライン（範囲グループ）を取得します。
実例
// 次のサンプルコードは、findメソッドを使用します。
activeSheet.rowOutlines.group(0,5);
var rgi = activeSheet.rowOutlines.find(1, 0);
rgi.state(GC.Spread.Sheets.Outlines.OutlineState.collapsed);
spread.invalidateLayout();
spread.repaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
index |
number |
行または列のインデックス。 |
level |
number |
アウトライン（範囲グループ）のレベル。 |
戻り値
指定した範囲グループ。
getCollapsed
▸ getCollapsed(index): boolean
内部の折りたたみ状態を取得します。
実例
// 次のサンプルコードは、getCollapsedメソッドを使用します。
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.expand(0,true);
activeSheet.resumePaint();
alert(activeSheet.rowOutlines.isCollapsed(0));
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
index |
number |
インデックス。 |
戻り値
boolean
折りたたまれている場合はtrue、 それ以外の場合はfalse。
getLevel
▸ getLevel(index): number
指定した行または列のレベルを取得します。レベルのインデックスは0から始まります。
実例
// 次のサンプルコードは、getLevelメソッドを使用します。
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.expand(0,true);
activeSheet.resumePaint();
alert(activeSheet.rowOutlines.getLevel(0));
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
index |
number |
行または列のインデックス。 |
戻り値
number
行または列のレベル。
getMaxLevel
▸ getMaxLevel(): number
最も深いレベルのレベル数を取得します。
備考 レベルインデックスは0から始まります。
実例
// 次のサンプルコードは、getMaxLevelメソッドを使用します。
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.group(1,4);
activeSheet.rowOutlines.expand(0,true);
activeSheet.columnOutlines.group(0,1);
activeSheet.resumePaint();
alert(activeSheet.rowOutlines.getMaxLevel());
戻り値
number
最も深いレベルのレベル数。
getState
▸ getState(groupInfo): OutlineState
指定したグループの状態を取得します。
実例
// 次のサンプルコードは、getStateメソッドを使用します。
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
var rgi = activeSheet.rowOutlines.find(1, 0);
rgi.state(GC.Spread.Sheets.Outlines.OutlineState.collapsed);
alert(activeSheet.rowOutlines.getState(rgi));
activeSheet.resumePaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
groupInfo |
OutlineInfo |
グループ情報。 |
戻り値
グループの状態。
group
▸ group(index, count): void
指定した開始インデックスから始まる行または列の範囲をアウトライン（範囲グループ）にグループ化します。
実例
// 次のサンプルコードは、groupメソッドを使用します。
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.expand(0,false);
activeSheet.resumePaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
index |
number |
グループ開始インデックス。 |
count |
number |
グループ化する行または列の数。 |
戻り値
void
isCollapsed
▸ isCollapsed(index): boolean
範囲グループが指定したインデックスで折りたたまれているかどうかを判断します。
実例
// 次のサンプルコードは、isCollapsedメソッドを使用します。
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.expand(0,true);
activeSheet.resumePaint();
alert(activeSheet.rowOutlines.isCollapsed(0));
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
index |
number |
範囲グループ内の行または列のインデックス。 |
戻り値
boolean
指定した行または列が折りたたまれている場合はtrue、それ以外の場合はfalse。
isGroupEnd
▸ isGroupEnd(index, processLevel): boolean
指定したインデックスがグループの最後のインデックスかどうかを判断します。
実例
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(2, 5);
activeSheet.rowOutlines.group(3, 2);
activeSheet.resumePaint();
console.log(activeSheet.rowOutlines.isGroupEnd(2, 0)); // false
console.log(activeSheet.rowOutlines.isGroupEnd(4, 0)); // false
console.log(activeSheet.rowOutlines.isGroupEnd(4, 1)); // true
console.log(activeSheet.rowOutlines.isGroupEnd(6, 0)); // true
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
index |
number |
インデックス。 |
processLevel |
number |
処理レベル。 |
戻り値
boolean
指定したインデックスがグループの最後のインデックスである場合はtrue、それ以外の場合はfalse。
refresh
▸ refresh(): void
この範囲グループを更新します。
戻り値
void
resumeAdding
▸ resumeAdding(): void
行/列がグループ範囲に挿入されたとき、グループの追加を再開します。
実例
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(2, 5);
activeSheet.resumePaint();
console.log(activeSheet.rowOutlines.find(3, 0).end); // 6
console.log(activeSheet.rowOutlines.find(5, 0).end); // 6
activeSheet.addRows(4, 1);
console.log(activeSheet.rowOutlines.find(3, 0).end); // 7
console.log(activeSheet.rowOutlines.find(5, 0).end); // 7
activeSheet.rowOutlines.suspendAdding();
activeSheet.addRows(4, 1);
console.log(activeSheet.rowOutlines.find(3,0).end);//3//Suspendedを追加すると、グループは2つの部分に分かれました。
console.log(activeSheet.rowOutlines.find(5, 0).end); // 8
activeSheet.rowOutlines.resumeAdding();
戻り値
void
setCollapsed
▸ setCollapsed(index, collapsed): void
折りたたまれたレベルを設定します。
実例
// 次のサンプルコードは、setCollapsedメソッドを使用します。
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.setCollapsed(0,false);
activeSheet.resumePaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
index |
number |
インデックス。 |
collapsed |
boolean |
レベルを折りたたむ場合、trueに設定します。 |
戻り値
void
suspendAdding
▸ suspendAdding(): void
行/列がグループ範囲に挿入されたとき、グループの追加を一時停止します。
実例
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(2, 5);
activeSheet.resumePaint();
console.log(activeSheet.rowOutlines.find(3, 0).end); // 6
console.log(activeSheet.rowOutlines.find(5, 0).end); // 6
activeSheet.addRows(4, 1);
console.log(activeSheet.rowOutlines.find(3, 0).end); // 7
console.log(activeSheet.rowOutlines.find(5, 0).end); // 7
activeSheet.rowOutlines.suspendAdding();
activeSheet.addRows(4, 1);
console.log(activeSheet.rowOutlines.find(3,0).end);//3//Suspendedを追加すると、グループは2つの部分に分かれました。
console.log(activeSheet.rowOutlines.find(5, 0).end); // 8
activeSheet.rowOutlines.resumeAdding();
戻り値
void
ungroup
▸ ungroup(): void
すべてのアウトライン（範囲グループ）を削除します。
実例
// 次のサンプルコードは、ungroupメソッドを使用します。
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.ungroup();
activeSheet.resumePaint();
戻り値
void
ungroupRange
▸ ungroupRange(index, count): void
指定した開始インデックスから始まる行または列の範囲をアウトライン（範囲グループ）から削除します。
実例
// 次のサンプルコードは、ungroupRangeメソッドを使用します。
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.ungroupRange(0,1);
activeSheet.resumePaint();
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
index |
number |
グループ開始インデックス。 |
count |
number |
削除する行または列の数。 |
戻り値
void