类: TableColumn

Sheets.Tables.TableColumn

Table of contents

构造方法

• constructor

方法

• cellType
• dataField
• dataStyle
• footerStyle
• formatter
• headerStyle
• id
• name
• value

构造方法

constructor

• new TableColumn(id, dataField?, name?, formatter?, cellType?, value?, dataStyle?, headerStyle?, footerStyle?)

表格列信息

参数

属性名	类型	说明
id	number	表列ID
dataField?	string	表列数据字段
name?	string	表格列名称
formatter?	string	表列格式
cellType?	Base	表列的cellType
value?	Function	表列值转换函数
dataStyle?	string | Style	the data style of the table column
headerStyle?	string | Style	the header style of the table column
footerStyle?	string | Style	the footer style of the table column

方法

cellType

▸ cellType(value?): any

获取或设置用于自定义单元格类型的表列cellType

代码示例

var data = {
     sales: [
         { name: 'Pencil', isMakeMoney: true },
         { name: 'Binder', isMakeMoney: true },
         { name: 'Pen Set', isMakeMoney: false }
     ]
 };
 var table = sheet.tables.add('tableSales', 0, 0, 5, 2);
 var tableColumn1 = new GC.Spread.Sheets.Tables.TableColumn();
 tableColumn1.name("name");
 tableColumn1.dataField("name");
 var tableColumn2 = new GC.Spread.Sheets.Tables.TableColumn();
 tableColumn2.name("IsMakeMoney");
 tableColumn2.dataField("isMakeMoney");
 tableColumn2.cellType(new GC.Spread.Sheets.CellTypes.CheckBox());
 table.autoGenerateColumns(false);
 table.bind([tableColumn1, tableColumn2], 'sales', data);

参数

属性名	类型	说明
value?	Base	表列的cellType

返回值

any

如果未设置任何值，则返回表列cellType;否则，返回表列

---

dataField

▸ dataField(value?): any

获取或设置用于访问表数据源的表列数据字段

代码示例

var data = {
     sales: [
         { name: 'Pencil' },
         { name: 'Binder' },
         { name: 'Pen Set' }
     ]
 };
 var table = sheet.tables.add('tableSales', 0, 0, 5, 2);
 var tableColumn1 = new GC.Spread.Sheets.Tables.TableColumn();
 tableColumn1.name("name");
 tableColumn1.dataField("name");
 table.bind([tableColumn1], 'sales', data);

参数

属性名	类型	说明
value?	string	表列数据字段

返回值

any

如果未设置任何值，则返回表列数据字段；否则，返回表列

---

dataStyle

▸ dataStyle(value?): any

Gets or sets the table column dataStyle.

参数

属性名	类型
value?	string | Style

返回值

any

If no value is set, returns the table column dataStyle; otherwise, returns the table column.

---

footerStyle

▸ footerStyle(value?): any

Gets or sets the table column footerStyle.

参数

属性名	类型
value?	string | Style

返回值

any

If no value is set, returns the table column footerStyle; otherwise, returns the table column.

---

formatter

▸ formatter(value?): any

获取或设置表列格式的格式显示值

代码示例

var data = {
     sales: [
         { name: 'Pencil', orderDate: new Date(2013, 3, 1) },
         { name: 'Binder', orderDate: new Date(2013, 4, 1) },
         { name: 'Pen Set', orderDate: new Date(2013, 6, 8) }
     ]
 };
 var table = sheet.tables.add('tableSales', 0, 0, 5, 2);
 var tableColumn1 = new GC.Spread.Sheets.Tables.TableColumn();
 tableColumn1.name("name");
 tableColumn1.dataField("name");
 var tableColumn2 = new GC.Spread.Sheets.Tables.TableColumn();
 tableColumn2.name("Order Date");
 tableColumn2.dataField("orderDate");
 tableColumn2.formatter("d/M/yy");
 table.autoGenerateColumns(false);
 table.bind([tableColumn1, tableColumn2], 'sales', data);

参数

属性名	类型	说明
value?	string	表列格式

返回值

any

如果未设置任何值，则返回表列格式；否则，返回表列

---

headerStyle

▸ headerStyle(value?): any

Gets or sets the table column headerStyle.

参数

属性名	类型
value?	string | Style

返回值

any

If no value is set, returns the table column headerStyle; otherwise, returns the table column.

---

id

▸ id(value?): any

获取或设置表列ID

代码示例

var data = {
     sales: [
         { name: 'Pencil' },
         { name: 'Binder' },
         { name: 'Pen Set' }
     ]
 };
 var table = sheet.tables.add('tableSales', 0, 0, 5, 2);
 var tableColumn1 = new GC.Spread.Sheets.Tables.TableColumn();
 tableColumn1.id("name");
 tableColumn1.dataField("name");
 table.bind([tableColumn1], 'sales', data);

参数

属性名	类型	说明
value?	number	表列ID

返回值

any

如果未设置任何值，则返回表的列ID;否则，返回表列

---

name

▸ name(value?): any

获取或设置要显示的表列名称

代码示例

var data = {
     sales: [
         { name: 'Pencil' },
         { name: 'Binder' },
         { name: 'Pen Set' }
     ]
 };
 var table = sheet.tables.add('tableSales', 0, 0, 5, 2);
 var tableColumn1 = new GC.Spread.Sheets.Tables.TableColumn();
 tableColumn1.name("name");
 tableColumn1.dataField("name");
 table.bind([tableColumn1], 'sales', data);

参数

属性名	类型	说明
value?	string	表格列名称

返回值

any

如果未设置任何值，则返回表的列名；否则，返回表列

---

value

▸ value(value?): Function

获取或设置显示值的表列值转换功能

代码示例

var data = {
     sales: [
         { name: 'Pencil', orderDate: new Date(2013, 3, 1), cost: 1.99 },
         { name: 'Binder', orderDate: new Date(2013, 4, 1), cost: 4.99 },
         { name: 'Pen Set', orderDate: new Date(2013, 6, 8), cost: 15.99 }
     ]
 };
 var table = sheet.tables.add('tableSales', 0, 0, 5, 3);
 var tableColumn1 = new GC.Spread.Sheets.Tables.TableColumn();
 tableColumn1.name("name");
 tableColumn1.dataField("name");
 var tableColumn2 = new GC.Spread.Sheets.Tables.TableColumn();
 tableColumn2.name("Order Date");
 tableColumn2.dataField("orderDate");
 tableColumn2.formatter("d/M/yy");
 var tableColumn3 = new GC.Spread.Sheets.Tables.TableColumn();
 tableColumn3.name("Cost");
 tableColumn3.dataField("cost");
 tableColumn3.value(function (item) {
     return item['cost'] + '$';
 });
 table.autoGenerateColumns(false);
 table.bind([tableColumn1, tableColumn2, tableColumn3], 'sales', data);

参数

属性名	类型	说明
value?	Function	表列值转换函数

返回值

Function

如果未设置任何值，则返回表列的值转换函数；否则，返回表列