类: Table

GC.Data.Table

Table of contents

构造方法

• constructor

属性

• columns
• name
• options
• views

方法

• addView
• clearIndexes
• createIndexes
• dropIndexes
• fetch
• getIndexes
• removeView
• search

构造方法

constructor

• new Table(name, dataSourceOption)

表格

参数

属性名	类型	说明
name	string	表格名称
dataSourceOption	IDataSourceOption	表格的数据源选项

属性

columns

• columns: IColumnCollection

表的默认列，只有在提取表后才可用，列名是键，值是列信息实例

---

name

• name: string

表的名称

---

options

• options: IDataSourceOption

表示表的数据源选项

---

views

• views: IViews

表的视图集合键是视图名称，值是 GC.Data.View 实例

方法

addView

▸ addView(name, columnInfos?, includeDefaultColumns?, options?): View

添加一个视图, 以当前表为宿主表

属性 name - 列的唯一名称

property [value] - 列的值可以是数据库中表的字段名称，也可以是使用字段名称的公式

property {string | string[]} [caption] - 列标题

property {number | string} [width] - 列的宽度，以像素为单位的支持 pixel 或 star

property [style] - 列样式选项

property {(GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions)[]} [conditionalFormats] - 条件规则数组

property {GC.Data.NumberValidatorOptions | GC.Data.DateValidatorOptions | GC.Data.TimeValidatorOptions | GC.Data.TextLengthValidatorOptions | GC.Data.FormulaValidatorOptions | GC.Data.FormulaListValidatorOptions | GC.Data.ListValidatorOptions} [validators] - 默认数据验证器

property [isPrimaryKey] - 将该列标记为主键列

property [readonly] - 将列标记为只读

property [required] - 插入新行时需要标记列

property [defaultValue] - 插入新行时提供默认值，可以是常量或公式

property [style] - 列标题样式选项

代码示例

// 按字符串数组列添加视图
productTable.addView("productView", [
    "id", "name", "reorderLevel", "unitPrice", "unitsInStock", "unitsOnOrder"
]);

// 按自定义列添加视图
productTable.addView("productView", [{
    value: "id",
    caption: "ID",
    isPrimaryKey: true
}, {
    value: "name",
    caption: "NAME",
    required: true
}, {
    value: "quantityPerUnit",
    caption: "QUANTITY PER UNIT"
}, {
    value: "unitPrice",
    caption: "UNIT PRICE"
}, {
    value: "unitsInStock",
    caption: "UNITS IN STOCK",
    readonly: true
}, {
    value: "unitsOnOrder",
    caption: "UNITS ON ORDER"
}, {
    value: "reorderLevel",
    caption: "REORDER LEVEL"
}, {
    value: "discontinued",
    caption: "DISCONTINUED",
    defaultValue: false
});

// 添加具有关系列的视图
var supplierRelationship = dataManager.addRelationship(productTable, "supplierId", "supplier", supplierTable, "id", "products");
productTable.addView("productWithSupplierView", [{
    value: "id",
    caption: "ID"
}, {
    value: "name",
    caption: "NAME"
}, {
    value: "supplier.companyName", // 关系
    caption: "SUPPLIER NAME"
}, {
    value: "supplier.contactName", // 关系
    caption: "SUPPLIER CONTACT NAME"
}, {
    value: "supplier.contactTitle", // 关系
    caption: "SUPPLIER CONTACT TITLE"
});

// 添加具有计算字段列的视图
var supplierRelationship = dataManager.addRelationship(productTable, "supplierId", "supplier", supplierTable, "id", "products");
productTable.addView("productWithSupplierView", [{
    value: "id",
    caption: "ID"
}, {
    value: "name",
    caption: "NAME"
}, {
    caption: "TOTAL PRICE",
    value: "=(unitsInStock + unitsOnOrder) * unitPrice"
}, {
    caption: "SUPPLIER'S INFO",
    value: "=CONCAT(supplierTable.companyName, ', ', supplierTable.contactName)"
});

参数

属性名	类型	说明
name	string	视图名称
columnInfos?	string[] | IColumn[]	-
includeDefaultColumns?	boolean	列信息为空时是否包括当前表的缺省列，其默认值为true
options?	ViewOptions	-

返回值

View

Returns the view.

---

clearIndexes

▸ clearIndexes(): void

清除所有索引字段

代码示例

// 清除所有索引字段
table.clearIndexes();

返回值

void

---

createIndexes

▸ createIndexes(fields): void

为字段创建索引

代码示例

// 创建索引
table.createIndexes(["name", "country", "project"]);

参数

属性名	类型	说明
fields	string[]	索引字段

返回值

void

---

dropIndexes

▸ dropIndexes(fields): void

删除索引字段

代码示例

// 删除索引字段
table.dropIndexes(["name", "country", "project"]);

参数

属性名	类型	说明
fields	string[]	索引字段

返回值

void

---

fetch

▸ fetch(reload?): Promise<any>

通过数据源选项，从本地数据源或远程数据源请求表数据

代码示例

// 使用请求的数据构建集算表
productTable.fetch().then(function(data) {
    var productView = productTable.addView("productView");
    var tableSheet = spread.addSheetTab(0, "productTableSheet", GC.Spread.Sheets.SheetType.tableSheet);
    tableSheet.setDataView(productView);
});

参数

属性名	类型
reload?	boolean

返回值

Promise<any>

你可以通过 Promise.then() 获取数据

---

getIndexes

▸ getIndexes(): string[]

获取所有索引字段

代码示例

// 存在索引字段
table.getIndexes(); // 返回 ["name", "country", "project"]
// No indexed field.
table.getIndexes(); // 返回 []

返回值

string[]

索引字段

---

removeView

▸ removeView(name): void

删除视图

代码示例

// 按名称删除视图
dataManager.removeView("productView");

参数

属性名	类型	说明
name	string	要删除的视图的名称

返回值

void

---

search

▸ search(value, field): any[]

使用搜索值搜索记录，返回所有完全匹配的记录

代码示例

// 搜索值value 和 succeed
table.search("SpreadJS", "group"); // 返回 [ {id: 1, project: "DataManager", group: "SpreadJS"}, {id: 3, project: "TableSheet", group: "SpreadJS"} ]
// 搜索value和failed
table.search("WPS", "project"); // 返回 []

参数

属性名	类型	说明
value	any	搜索值始终将非字符串转换为字符串类型
field	string	目标字段

返回值

any[]

所有匹配的记录