Column.context

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

The field context for values in the query result column.

This property is set when Query.createColumn(options) or Component.createColumn(options) is executed. The field context determines how field values are displayed in a column. For example, you can specify that a column should display raw data (such as internal IDs), consolidated or converted amounts (such as currency totals), or user-friendly values (such as names).

This property is an Object that includes the name of the context (which is a value in the query.FieldContext enum) and any parameters that apply to that context. In this release, only the query.FieldContext.CONVERTED context uses parameters. For information about these parameters, see Query.createColumn(options) or Component.createColumn(options).

Type

Object (read-only)

Module

N/query Module

Parent Object

query.Column

Sibling Object Members

Column Object Members

Since

2019.1

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/query Module Script Samples.

            // Add additional code
...
var myTransactionQuery = query.create({ type: query.Type.TRANSACTION
}); var myTranLinesJoin = myTransactionQuery.autoJoin({ fieldId: 'transactionlines'
}); myTransactionQuery.condition = myTranLinesJoin.createCondition({ fieldId: 'netamount', operator: query.Operator.GREATER, values: 50000
}); myTransactionQuery.columns = [ myTranLinesJoin.createColumn({ fieldId: 'netamount' })
]; var unconsolidatedResultSet = myTransactionQuery.run(); // Log unconsolidated amounts
for (var i in unconsolidatedResultSet.results) log.debug(unconsolidatedResultSet.results[i].values[0]); myTransactionQuery.columns = [ myTranLinesJoin.createColumn({ fieldId: 'netamount', context: query.FieldContext.CURRENCY_CONSOLIDATED })
]; var consolidatedResultSet = myTransactionQuery.run(); // Log consolidated amounts
for (var i in consolidatedResultSet.results) log.debug(consolidatedResultSet.results[i].values[0]);
...
// Add additional code

Syntax

Related Topics