workbook.TableColumn

Note:

The content in this help topic applies to SuiteScript 2.x.

Object Description

A table column. A table column is used when you create a table definition.

You can create a table column using workbook.createTableColumn(options).

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/workbook Module

Methods and Properties

TableColumn Object Members

Since

2020.2

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/workbook Module Script Samples.

            // Add additional code
...
// Create a basic TableColumn
var myTableColumn = workbook.createTableColumn({
    sort: mySort
    datasetColumnId: myDatasetColumnId
});
// Create a TableColumn with filters
var myTableColumn = workbook.createTableColumn({
    filters: [myTableFilter],
    sort: mySort,
    datasetColumnId: myDatasetColumnId
});
// Create a full TableColumn
var myTableColumn = workbook.createTableColumn({
    filters: [myTableFilter],
    width: 50,
    datasetColumnAlias: 'Column7',
    fieldContext: myFieldContext,
    label: 'My Complex Table Column',
    alias: 'myComplexTableColumn',
    sort: mySort
});

// View a workbook.TableColumn used in a TableDefinition
var myWorkbook = workbook.load ({
    id: myWorkbookId
});

var myTableColumn = myWorkbook.tableDefinitions[0].columns[0];

// Note that some TableColumn properties may be empty/null based on the loaded workbook
log.audit({
    title: 'TableColumn.datasetColumnId = ',
    details: myTableColumn.datasetColumnId
});
log.audit({
    title: 'TableColumn.datasetColumnAlias = ',
    details: myTableColumn.datasetColumnAlias
});

log.audit({
    title: 'TableColumn.sort = ',
    details: myTableColumn.sort
});

log.audit({
    title: 'TableColumn.filters = ',
    details: myTableColumn.filters
});

log.audit({
    title: 'TableColumn.label = ',
    details: myTableColumn.label
});

log.audit({
    title: 'TableColumn.width = ',
    details: myTableColumn.width
});

log.audit({
    title: 'TableColumn.fieldContext = ',
    details: myTableColumn.fieldContext
});

log.audit({
    title: 'TableColumn.alias = ',
    details: myTableColumn.alias
});
...
// Add additional code

Syntax

Related Topics