クラス: StatusBar

Sheets.StatusBar.StatusBar

Table of contents

コンストラクタ

• constructor

メソッド

• add
• all
• bind
• dispose
• get
• remove
• unbind
• update

コンストラクタ

constructor

• new StatusBar(host, options?)

ステータスバーを表します。

実例

let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'),
  {items: [new GC.Spread.Sheets.StatusBar.StatusItem('labelItem', {menuContent: 'label'})]});

パラメータ

名前	型	説明
host	HTMLElement	DOM要素。
options?	IStatusBarOptions	-

メソッド

add

▸ add(item, position): boolean

ステータスバーに項目のインスタンスを追加します。

実例

let StatusItem = GC.Spread.Sheets.StatusBar.StatusItem;
let spanItem = new StatusItem('spanItemName', {menuContent: 'span', value: 'spanValue'});
let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'));
statusBar.bind(spread);
statusBar.add(spanItem);

パラメータ

名前	型	説明
item	StatusItem	StatusItemの子インスタンス。 子はStatusItemから拡張されます。
position	number	位置は、すべての項目配列内の項目のインデックスです。 これは、0から開始します。項目の表示位置も配置に関連します。 位置が無効または未定義の場合、デフォルトで配置します。

戻り値

boolean

項目の結果を追加します。 追加された場合はtrueを返し、それ以外の場合はfalseです。

---

all

▸ all(): StatusItem[]

すべての項目のリストを取得します。

実例

let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'));
statusBar.bind(spread);
let itemList = statusBar.all();
statusBar.remove(itemList[0]);

戻り値

StatusItem[]

ステータスバーの項目のリスト。

---

bind

▸ bind(context): void

ステータスバーのコンテキストを連結します。

実例

let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'));
statusBar.bind(spread);

パラメータ

名前	型	説明
context	Workbook	ステータスバーのコンテキスト。 コンテキストは、ステータスバーのステータス変更をトリガーできます。 この場合、コンテキストはGC.Spread.Sheets.Workbookのインスタンスとなります。

戻り値

void

---

dispose

▸ dispose(): void

StatusBarを破棄し、すべてのイベントを非連結します。

実例

let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'));
statusBar.bind(spread);
//ここに実装します。
statusBar.dispose();

戻り値

void

---

get

▸ get(itemName): StatusItem

項目名で項目を取得します。

実例

let StatusItem = GC.Spread.Sheets.StatusBar.StatusItem;
let spanItemName = 'spanItemName';
let spanItem = new StatusItem(spanItemName, {menuContent: 'span', value: 'spanValue'});
let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'));
statusBar.bind(spread);
statusBar.add(spanItem);
let spanItemInstance = statusBar.get(spanItemName);

パラメータ

名前	型
itemName	string

戻り値

StatusItem

itemNameが指定されているStatusItem。

---

remove

▸ remove(itemName): boolean

ステータスバーから項目を削除します。

実例

let StatusItem = GC.Spread.Sheets.StatusBar.StatusItem;
let spanItemName = 'spanItemName';
let spanItem = new StatusItem(spanItemName, {menuContent: 'span', value: 'spanValue'});
let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'));
statusBar.bind(spread);
statusBar.add(spanItem);
//ここに実装します。
statusBar.remove(spanItemName);

パラメータ

名前	型	説明
itemName	string	StatusItemの名前。

戻り値

boolean

削除された場合はtrueを返し、それ以外の場合はfalseです。

---

unbind

▸ unbind(): void

ステータスバーのコンテキストを非連結します。

実例

let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'));
statusBar.bind(spread);
//ここに実装します。
statusBar.unbind();

戻り値

void

---

update

▸ update(): void

ステータスバーを更新します。

実例

let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'));
statusBar.update();

戻り値

void