[]
• new TableColumn(id
, dataField?
, name?
, formatter?
, cellType?
, value?
, dataStyle?
, headerStyle?
, footerStyle?
)
Represents the table column information.
Name | Type | Description |
---|---|---|
id |
number |
The table column ID. |
dataField? |
string |
The table column data field. |
name? |
string |
The table column name. |
formatter? |
string |
The table column formatter. |
cellType? |
Base |
The table column cellType. |
value? |
Function |
The table column value convert 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(value?
): any
Gets or sets the table column cellType for custom cell type.
example
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);
Name | Type |
---|---|
value? |
Base |
any
If no value is set, returns the table column cellType; otherwise, returns the table column.
▸ dataField(value?
): any
Gets or sets the table column data field for accessing the table's data source.
example
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);
Name | Type |
---|---|
value? |
string |
any
If no value is set, returns the table column data field; otherwise, returns the table column.
▸ dataStyle(value?
): any
Gets or sets the table column dataStyle.
Name | Type |
---|---|
value? |
string | Style |
any
If no value is set, returns the table column dataStyle; otherwise, returns the table column.
▸ footerStyle(value?
): any
Gets or sets the table column footerStyle.
Name | Type |
---|---|
value? |
string | Style |
any
If no value is set, returns the table column footerStyle; otherwise, returns the table column.
▸ formatter(value?
): any
Gets or sets the table column formatter for format display value.
example
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);
Name | Type | Description |
---|---|---|
value? |
string |
The table column formatter. |
any
If no value is set, returns the table column formatter; otherwise, returns the table column.
▸ headerStyle(value?
): any
Gets or sets the table column headerStyle.
Name | Type |
---|---|
value? |
string | Style |
any
If no value is set, returns the table column headerStyle; otherwise, returns the table column.
▸ id(value?
): any
Gets or sets the table column ID.
example
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);
Name | Type | Description |
---|---|---|
value? |
number |
The table column ID. |
any
If no value is set, returns the table column ID; otherwise, returns the table column.
▸ name(value?
): any
Gets or sets the table column name for display.
example
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);
Name | Type | Description |
---|---|---|
value? |
string |
The table column name. |
any
If no value is set, returns the table column name; otherwise, returns the table column.
▸ value(value?
): Function
Gets or sets the table column value convert function for display value.
example
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);
Name | Type |
---|---|
value? |
Function |
Function
If no value is set, returns the table column value convert function; otherwise, returns the table column.