[]
• new StatusBar(host, options?)
表示状态栏。
example
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'),
{items: [new GC.Spread.Sheets.StatusBar.StatusItem('labelItem', {menuContent: 'label'})]});
| Name | Type | Description |
|---|---|---|
host |
HTMLElement |
DOM元素。 |
options? |
IStatusBarOptions |
配置状态栏的选项。 |
▸ add(item, position): boolean
向状态栏添加项目实例。
example
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);
| Name | Type | Description |
|---|---|---|
item |
StatusItem |
StatusItem子类的实例。子类继承自StatusItem。 |
position |
number |
项目在所有项目数组中的索引位置。从0开始。项目的显示位置也与对齐方式有关。如果位置无效或未定义,则按默认方式放置。 |
boolean
添加项目的结果。如果添加成功返回true,否则失败。
▸ all(): StatusItem[]
获取所有项目列表。
example
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]);
状态栏上的项目列表。
▸ bind(context): void
绑定状态栏的上下文。
example
let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'));
statusBar.bind(spread);
| Name | Type | Description |
|---|---|---|
context |
Workbook |
状态栏的上下文。上下文可以触发状态栏的状态变化。这里的上下文是GC.Spread.Sheets.Workbook的实例。 |
void
▸ dispose(): void
释放状态栏并解绑所有事件。
example
let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'));
statusBar.bind(spread);
// do something
statusBar.dispose();
void
▸ get(itemName): StatusItem
通过项目名称获取项目。
example
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);
| Name | Type | Description |
|---|---|---|
itemName |
string |
项目名称 |
指定名称的StatusItem实例
▸ remove(itemName): boolean
从状态栏中移除项目。
example
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);
// do something
statusBar.remove(spanItemName);
| Name | Type | Description |
|---|---|---|
itemName |
string |
StatusItem的名称 |
boolean
如果为true表示移除成功,否则失败
▸ unbind(): void
解绑状态栏的上下文。
example
let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'));
statusBar.bind(spread);
// do something
statusBar.unbind();
void
▸ update(): void
更新状态栏。
example
let spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
let statusBar = new GC.Spread.Sheets.StatusBar.StatusBar(document.getElementById('statusBar'));
statusBar.update();
void