N/workbook Module

Use the N/workbook module to create a new workbook, load an existing workbook, or list all existing workbooks.

A workbook can contain the following:

• Pivots

• Tables with columns, filters, and field contexts

• Selectors

• Sections

• Data dimensions

• Sorts

• Conditional and limiting filters

• Expressions

• Data measures and calculated measures

Workbooks are where you analyze the results of your dataset queries using different components, such as table views. All workbooks are based on a dataset. For more information, see N/dataset Module. For more information about SuiteAnalytics workbooks and datasets, see the following topics:

• SuiteAnalytics Workbook Overview

• Getting Started with SuiteAnalytics Workbook

• Custom Workbooks and Datasets

In This Help Topic

• N/workbook Module Members

• CalculatedMeasure Object Members

• Color Object Members

• ConditionalFilter Object Members

• ConditionalFormat Object Members

• ConditionalFormatRule Object Members

• Currency Object Members

• DataDimension Object Members

• DataDimensionItem Object Members

• DataDimensionItemValue Object Members

• DataDimensionValue Object Members

• DataMeasure Object Members

• DimensionSelector Object Members

• DimensionSort Object Members

• Duration Object Members

• Expression Object Members

• FieldContext Object Members

• FontSize Object Members

• LimitingFilter Object Members

• Measure Object Members

• MeasureSelector Object Members

• MeasureSort Object Members

• MeasureValue Object Members

• MeasureValueSelector Object Members

• PathSelector Object Members

• PivotAxis Object Members

• Pivot Object Members

• PivotIntersection Object Members

• PositionPercent Object Members

• PositionUnits Object Members

• PositionValues Object Members

• Range Object Members

• Record Object Members

• RecordKey Object Members

• ReportStyle Object Members

• ReportStyleRule Object Members

• Section Object Members

• SectionValue Object Members

• Sort Object Members

• SortByDataDimensionItem Object Members

• SortByMeasure Object Members

• SortDefinition Object Members

• Style Object Members

• TableColumn Object Members

• Table Object Members

• TableColumnFilter Object Members

• Workbook Object Members

N/workbook Module Members

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Object	workbook.CalculatedMeasure	Object	Server scripts	A calculated measure.
	workbook.Color	Object	Server scripts	A color.
	workbook.ConditionalFilter	Object	Server scripts	A conditional filter.
	workbook.ConditionalFormat	Object	Server scripts	A conditional format.
	workbook.ConditionalFormatRule	Object	Server scripts	A conditional format rule.
	workbook.Currency	Object	Server scripts	A currency amount and currency type.
	workbook.DataDimension	Object	Server scripts	A data dimension.
	workbook.DataDimensionItem	Object	Server scripts	A data dimension item.
	workbook.DataDimensionItemValue	Object	Server scripts	The value of a data dimension item.
	workbook.DataDimensionValue	Object	Server scripts	The value of a data dimension.
	workbook.DataMeasure	Object	Server scripts	A data measure.
	workbook.DescendantorSelfNodesSelector	Object	Server scripts	A selector for descendant or self nodes.
	workbook.DimensionSelector	Object	Server scripts	A dimension selector.
	workbook.DimensionSort	Object	Server scripts	A dimension sort.
	workbook.Duration	Object	Server scripts	A duration.
	workbook.Expression	Object	Server scripts	An expression.
	workbook.FieldContext	Object	Server scripts	A field context.
	workbook.FontSize	Object	Server scripts	A font size.
	workbook.LimitingFilter	Object	Server scripts	A limiting filter.
	workbook.Measure	Object	Server scripts	A measure.
	workbook.MeasureSelector	Object	Server scripts	A measure selector.
	workbook.MeasureSort	Object	Server scripts	A measure sort.
	workbook.MeasureValue	Object	Server scripts	A measure value.
	workbook.MeasureValueSelector	Object	Server scripts	A measure value selector.
	workbook.PathSelector	Object	Server scripts	A path selector.
	workbook.PivotAxis	Object	Server scripts	A pivot axis.
	workbook.Pivot	Object	Server scripts	A pivot definition. A pivot is a workbook component that enables you to pivot your dataset query results by defining measures and dimensions, so that you can analyze different subsets of data.
	workbook.PivotIntersection	Object	Server scripts	A pivot intersection.
	workbook.PositionPercent	Object	Server scripts	A position defined by percentages of the x and y axes.
	workbook.PositionUnits	Object	Server scripts	A position defined by units.
	workbook.PositionValues	Object	Server scripts	A position defined by horizontal and vertical position values.
	workbook.Range	Object	Server scripts	A date or date-time range.
	workbook.Record	Object	Server scripts	A record.
	workbook.RecordKey	Object	Server scripts	A record key.
	workbook.ReportStyle	Object	Server scripts	A report style.
	workbook.ReportStyleRule	Object	Server scripts	A report style rule.
	workbook.Section	Object	Server scripts	A workbook section.
	workbook.SectionValue	Object	Server scripts	A section value.
	workbook.Sort	Object	Server scripts	A sort.
	workbook.SortByDataDimensionItem	Object	Server scripts	A sort based on a data dimension item.
	workbook.SortByMeasure	Object	Server scripts	A sort based on a measure.
	workbook.SortDefinition	Object	Server scripts	A sort definition.
	workbook.Style	Object	Server scripts	A style.
	workbook.TableColumn	Object	Server scripts	A table column.
	workbook.TableColumnFilter	Object	Server scripts	A table column filter.
	workbook.TableColumnFilter	Object	Server scripts	A table definition. A table is a workbook component that enables you to view your dataset query results in a simple table.
	workbook.Workbook	Object	Server scripts	A workbook. Workbooks are where you analyze the results of your dataset queries using different components, such as table views and pivots. All workbooks are based on a dataset, and a single dataset can be used as the basis for multiple workbooks.
Method	workbook.create(options)	workbook.Workbook	Server scripts	Creates a workbook. Workbooks are where you analyze the results of your dataset queries using different components, such as table views and pivots. All workbooks are based on a dataset, and a single dataset can be used as the basis for multiple workbooks.
	workbook.createCalculatedMeasure(options)	workbook.CalculatedMeasure	Server scripts	Creates a calculated measure.
	workbook.createColor(options)	workbook.Color	Server scripts	Creates a color.
	workbook.createConditionalFilter(options)	workbook.ConditionalFilter	Server scripts	Creates a conditional filter.
	workbook.createConditionalFormat(options)	workbook.ConditionalFormat	Server scripts	Creates a conditional format.
	workbook.createConditionalFormatRule(options)	workbook.ConditionalFormatRule	Server scripts	Creates a conditional format rule.
	workbook.createConstant(options)	workbook.Expression	Server scripts	Creates a constant expression.
	workbook.createDataDimension(options)	workbook.DataDimension	Server scripts	Creates a data dimension.
	workbook.createDataDimensionItem(options)	workbook.DataDimensionItem	Server scripts	Creates a data dimension item.
	workbook.createDataMeasure(options)	workbook.DataMeasure	Server scripts	Creates a data measure.
	workbook.createDimensionSelector(options)	workbook.DimensionSelector	Server scripts	Creates a dimension selector.
	workbook.createDimensionSort(options)	workbook.DimensionSort	Server scripts	Creates a dimension sort.
	workbook.createExpression(options)	workbook.Expression	Server scripts	Creates an expression.
	workbook.createFieldContext(options)	workbook.FieldContext	Server scripts	Creates a field context for table column.
	workbook.createFontSize(options)	workbook.FontSize	Server scripts	Creates a font size.
	workbook.createLimitingFilter(options)	workbook.LimitingFilter	Server scripts	Creates a limiting filter.
	workbook.createMeasure(options)	workbook.Measure	Server scripts	Creates a measure.
	workbook.createMeasureSelector(options)	workbook.MeasureSelector	Server scripts	Creates a measure selector.
	workbook.createMeasureSort(options)	workbook.MeasureSort	Server scripts	Creates a measure sort.
	workbook.createMeasureValueSelector(options)	workbook.MeasureValueSelector	Server scripts	Creates a measure value selector.
	workbook.createPathSelector(options)	workbook.PathSelector	Server scripts	Creates a path selector.
	workbook.createPivotAxis(options)	workbook.PivotAxis	Server scripts	Creates a pivot axis.
	workbook.createPivot(options)	workbook.Pivot	Server scripts	Creates a pivot definition. A pivot is a workbook component that enables you to pivot your dataset query results by defining measures and dimensions, so that you can analyze different subsets of data.
	workbook.createPositionPercent(options)	workbook.PositionPercent	Server scripts	Creates a position defined by percentages of the x and y axes.
	workbook.createPositionUnits(options)	workbook.PositionUnits	Server scripts	Creates a position defined by units.
	workbook.createPositionValues(options)	workbook.PositionValues	Server scripts	Creates a position defined by horizontal and vertical position values.
	workbook.createReportStyle(options)	workbook.ReportStyle	Server scripts	Creates a report style.
	workbook.createReportStyleRule(options)	workbook.ReportStyleRule	Server scripts	Creates a report style rule.
	workbook.createSection(options)	workbook.Section	Server scripts	Creates a section.
	workbook.createSort(options)	workbook.Sort	Server scripts	Creates a sort.
	workbook.createSortByDataDimensionItem(options)	workbook.SortByDataDimensionItem	Server scripts	Creates a sort based on a data dimension item.
	workbook.createSortByMeasure(options)	workbook.SortByMeasure	Server scripts	Creates a sort based on a measure.
	workbook.createSortDefinition(options)	workbook.SortDefinition	Server scripts	Creates a sort definition.
	workbook.createStyle(options)	workbook.Style	Server scripts	Creates a style.
	workbook.createTable(options)	workbook.Table	Server scripts	Creates a table view.
	workbook.createTableColumn(options)	workbook.TableColumn	Server scripts	Creates a table column.
	workbook.createTableColumnFilter(options)	workbook.TableColumnFilter	Server scripts	Creates a table filter.
	workbook.list()	Object[]	Server scripts	Lists all existing workbooks.
	workbook.load(options)	workbook.Workbook	Server scripts	Loads an existing workbook.
Enum	workbook.Aggregation	enum	Server scripts	Holds string values for workbook aggregation types.
	workbook.Color	enum	Server scripts	Holds string values for colors.
	workbook.ConstantType	enum	Server scripts	Holds string values for workbook constant types.
	workbook.DateTimeHierarchy	enum	Server scripts	Holds string values for workbook date-time hierarchy types.
	workbook.DateTimeProperty	enum	Server scripts	Holds string values for workbook date-time property types.
	workbook.ExpressionType	enum	Server scripts	Holds string values for workbook expression types.
	workbook.FontSize	enum	Server scripts	Holds string values for font sizes.
	workbook.FontStyle	enum	Server scripts	Holds string values for font styles.
	workbook.FontWeight	enum	Server scripts	Holds string values for font weights.
	workbook.Image	enum	Server scripts	Holds string values for images you can use in workbooks.
	workbook.Position	enum	Server scripts	Holds string values for positions.
	workbook.TemporalUnit	enum	Server scripts	Holds string values for temporal units, such as hours and minutes.
	workbook.TextAlign	enum	Server scripts	Holds string values for text alignments.
	workbook.TextDecorationLine	enum	Server scripts	Holds string values for text decoration line types, such as underline and strikethrough.
	workbook.TextDecorationStyle	enum	Server scripts	Holds string values for text decoration line styles, such as solid and dashed.
	workbook.TotalLine	enum	Server scripts	Holds string values for predefined total line formats.
	workbook.Unit	enum	Server scripts	Holds string values for units of measurement.

CalculatedMeasure Object Members

The following members are available for a workbook.CalculatedMeasure object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	CalculatedMeasure.expression	workbook.Expression	Server scripts	The expression for the calculated measure.
	CalculatedMeasure.label	string | workbook.Expression	Server scripts	The label of the calculated measure.

Color Object Members

The following members are available for a workbook.Color object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Color.alpha	number	Server scripts	The opacity, or transparency, of the color.
	Color.blue	number	Server scripts	The blue portion of the color.
	Color.green	number	Server scripts	The green portion of the color.
	Color.red	number	Server scripts	The red portion of the color.

ConditionalFilter Object Members

The following members are available for a workbook.ConditionalFilter object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	ConditionalFilter.filteredNodesSelector	workbook.PathSelector | workbook.DimensionSelector	Server scripts	The selected filters.
	ConditionalFilter.measure	workbook.Measure	Server scripts	The measure of the filter.
	ConditionalFilter.otherAxisSelector	workbook.PathSelector | workbook.DimensionSelector	Server scripts	The filter selector for the other axis.
	ConditionalFilter.predicate	workbook.Expression	Server scripts	The actual predicate which indicates if the condition is met.
	ConditionalFilter.row	boolean	Server scripts	The row axis indicator.

ConditionalFormat Object Members

The following members are available for a workbook.ConditionalFormat object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	ConditionalFormat.rules	workbook.ConditionalFormatRule[]	Server scripts	The conditional formatting rules that are included in the conditional format.

ConditionalFormatRule Object Members

The following members are available for a workbook.ConditionalFormatRule object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	ConditionalFormatRule.filter	workbook.TableColumnFilter	Server scripts	The filter that determines which rows or cells to apply the conditional format to.
	ConditionalFormatRule.style	workbook.Style	Server scripts	The style to apply as the conditional format.

Currency Object Members

The following members are available for a workbook.Currency object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Currency.amount	number	Server scripts	The amount of the currency.
	Currency.id	string	Server scripts	The ID of the currency (for example, USD, EUR, GBP, and so on).

DataDimension Object Members

The following members are available for a workbook.DataDimension object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	DataDimension.children	Array<workbook.DataDimension | workbook.Section>	Server scripts	The children of the data dimension.
	DataDimension.items	workbook.DataDimensionItem[]	Server scripts	The items of the data dimension.
	DataDimension.totalLine	string	Server scripts	The formatting option for the total line. Set this value using workbook.TotalLine.

DataDimensionItem Object Members

The following members are available for a workbook.DataDimensionItem object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	DataDimensionItem.expression	workbook.Expression	Server scripts	The expression of data dimension item.
	DataDimensionItem.label	string	Server scripts	The label of the data dimension item.

DataDimensionItemValue Object Members

The following members are available for a workbook.DataDimensionItemValue object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	DataDimensionItemValue.item	workbook.DataDimensionItem	Server scripts	The data dimension item.
	DataDimensionItemValue.value	string | number | Boolean | workbook.Record | workbook.Currency | workbook.Range | workbook.Duration	Server scripts	The value of the data dimension item.

DataDimensionValue Object Members

The following members are available for a workbook.DataDimensionValue object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	DataDimensionValue.dataDimension	workbook.DataDimension	Server scripts	The data dimension.
	DataDimensionValue.itemValues	workbook.DataDimensionItemValue[]	Server scripts	The item values for the data dimension.

DataMeasure Object Members

The following members are available for a workbook.DataMeasure object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	DataMeasure.aggregation	string	Server scripts	The aggregation of the data measure.
	DataMeasure.expression	workbook.Expression	Server scripts	The expression for the data measure. This property is used if the data measure is a single-expression measure.
	DataMeasure.expressions	workbook.Expression[]	Server scripts	The expressions for the data measure. This property is used if the data measure is a multiple-expression measure.
	DataMeasure.label	string | workbook.Expression	Server scripts	The label of the data measure.

DimensionSelector Object Members

The following members are available for a workbook.DimensionSelector object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	DimensionSelector.dimension	workbook.DataDimension | workbook.Section	Server scripts	The dimension of the dimension selector.

DimensionSort Object Members

The following members are available for a workbook.DimensionSort object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	DimensionSort.item	workbook.DataDimensionItem	Server scripts	The item of the dimension sort.
	DimensionSort.sort	workbook.Sort	Server scripts	The sort of the dimension sort.

Duration Object Members

The following members are available for a workbook.Duration object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Duration.amount	number	Server scripts	The amount of the duration.
	Duration.units	Object	Server scripts	The units of the duration.

Expression Object Members

The following members are available for a workbook.Expression object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Expression.functionId	string	Server scripts	The ID of the function used in the expression.
	Expression.parameters	Object	Server scripts	The parameters of the expression.

FieldContext Object Members

The following members are available for a workbook.FieldContext object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	FieldContext.name	string	Server scripts	The name of the field context (for example, DISPLAY or CONSOLIDATED)
	FieldContext.parameters	Object	Server scripts	The parameters of the field context.

FontSize Object Members

The following members are available for a workbook.FontSize object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	FontSize.size	number	Server scripts	The numeric size of the font size.
	FontSize.unit	string	Server scripts	The unit of the font size.

LimitingFilter Object Members

The following members are available for a workbook.LimitingFilter object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	LimitingFilter.filteredNodesSelector	workbook.PathSelector | workbook.DimensionSelector	Server scripts	The selected filter.
	LimitingFilter.limit	number	Server scripts	The limit number for the filter.
	LimitingFilter.row	boolean	Server scripts	The row axis indicator for the filter.
	LimitingFilter.sortBys	Array<workbook.DimensionSort | workbook.MeasureSort>	Server scripts	The ordering elements of the filter.

Measure Object Members

The following members are available for a workbook.Measure object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Measure.aggregation	workbook.Aggregation	Server scripts	The aggregation of the measure.
	Measure.expression	workbook.Expression	Server scripts	The expression for the measure. Only used if this is a single expression measure.
	Measure.expressions	workbook.Expression[]	Server scripts	The set of expressions for the measure. Only used if this is a multi expression measure.
	Measure.label	string	Server scripts	The label of the measure.

MeasureSelector Object Members

The following members are available for a workbook.MeasureSelector object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	MeasureSelector.measures	workbook.CalculatedMeasure[] | workbook.DataMeasure	Server scripts	The measures for the measure selector.

MeasureSort Object Members

The following members are available for a workbook.MeasureSort object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	MeasureSort.measure	workbook.Measure	Server scripts	The measure of the measure sort.
	MeasureSort.otherAxisSelector	workbook.DimensionSelector | workbook.PathSelector	Server scripts	The selector for the other axis (row or column that is not the main axis).
	MeasureSort.sort	workbook.Sort	Server scripts	The sort object for the measure sort.

MeasureValue Object Members

The following members are available for a workbook.MeasureValue object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	MeasureValue.measure	workbook.Measure	Server scripts	The measure to use for the measure value.
	MeasureValue.value	string | number | Boolean | workbook.Record | workbook.Currency | workbook.Range | workbook.Duration	Server scripts	The value to use for the measure value.

MeasureValueSelector Object Members

The following members are available for a workbook.MeasureValueSelector object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	MeasureValueSelector.columnSelector	workbook.DimensionSelector | workbook.PathSelector | workbook.DescendantorSelfNodesSelector	Server scripts	The column selector.
	MeasureValueSelector.measureSelector	workbook.MeasureSelector[]	Server scripts	The measure selectors.
	MeasureValueSelector.rowSelector	workbook.DimensionSelector | workbook.PathSelector | workbook.DescendantorSelfNodesSelector	Server scripts	The row selector.

PathSelector Object Members

The following members are available for a workbook.PathSelector object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	PathSelector.elements	workbook.DimensionSelector	Server scripts	The elements denoting 'xpath' of the selector.

PivotAxis Object Members

The following members are available for a workbook.PivotAxis object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	PivotAxis.root	workbook.DataDimension | workbook.Section	Server scripts	The data for the pivot axis.
	PivotAxis.sortDefinitions	workbook.SortDefinition[]	Server scripts	The sort definitions of the pivot axis.

Pivot Object Members

The following members are available for a workbook.Pivot object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Pivot.aggregationFilters	Array<workbook.ConditionalFilter |workbook.LimitingFilter>	Server scripts	The limiting and conditional filters of the pivot definition.
	Pivot.columnAxis	workbook.PivotAxis	Server scripts	The column axis of the pivot definition.
	Pivot.dataset	dataset.Dataset	Server scripts	The underlying dataset of the pivot definition.
	Pivot.filterExpressions	workbook.Expression	Server scripts	The filter expressions of the pivot definition.
	Pivot.id	string	Server scripts	The ID of the pivot definition.
	Pivot.name	string	Server scripts	The name of the pivot definition.
	Pivot.rowAxis	workbook.PivotAxis	Server scripts	The row axis of the pivot definition.

PivotIntersection Object Members

The following members are available for a workbook.PivotIntersection object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	PivotIntersection.column	workbook.DataDimensionValue | workbook.SectionValue	Server scripts	The column dimension value.
	PivotIntersection.measureValues	workbook.MeasureValue[]	Server scripts	The measure values in the pivot intersection.
	PivotIntersection.row	workbook.DataDimensionValue | workbook.SectionValue	Server scripts	The row dimension value.

PositionPercent Object Members

The following members are available for a workbook.PositionPercent object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	PositionPercent.percentX	number	Server scripts	The percentage of the x dimension.
	PositionPercent.percentY	number	Server scripts	The percentage of the y dimension.

PositionUnits Object Members

The following members are available for a workbook.PositionUnits object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	PositionUnits.unit	string	Server scripts	The units for the position.
	PositionUnits.x	number	Server scripts	The x value of the position.
	PositionUnits.y	number	Server scripts	The y value of the position.

PositionValues Object Members

The following members are available for a workbook.PositionValues object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	PositionValues.horizontal	string	Server scripts	The horizontal value of the position.
	PositionValues.vertical	string	Server scripts	The vertical value of the position.

Range Object Members

The following members are available for a workbook.Range object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Range.end	string	Server scripts	The end date or date-time of the range.
	Range.start	string	Server scripts	The start date or date-time of the range.

Record Object Members

The following members are available for a workbook.Record object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Record.name	string	Server scripts	The name of the record type for the record.
	Record.primaryKey	number	Server scripts	The primary key of the record.
	Record.properties	Object	Server scripts	The properties of the record.

RecordKey Object Members

The following members are available for a workbook.RecordKey object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	RecordKey.properties	Object	Server scripts	The properties of the record key.

ReportStyle Object Members

The following members are available for a workbook.ReportStyle object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	ReportStyle.rules	workbook.ReportStyleRule[]	Server scripts	The formatting rules for the report style.
	ReportStyle.selectors	workbook.MeasureValueSelector[]	Server scripts	The selectors for the report style.

ReportStyleRule Object Members

The following members are available for a workbook.ReportStyleRule object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	ReportStyleRule.expression	workbook.Expression	Server scripts	A Boolean expression indicating whether the style should be applied.
	ReportStyleRule.style	workbook.Style	Server scripts	The style to be applied.

Section Object Members

The following members are available for a workbook.Section object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Section.children	Array<workbook.Measure | workbook.DataDimension | workbook.DataDimensionItem>	Server scripts	The children of the section.
	Section.totalLine	string	Server scripts	The formatting option for the total line. Set this value using workbook.TotalLine.

SectionValue Object Members

The following members are available for a workbook.SectionValue object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	SectionValue.section	workbook.Section	Server scripts	The section of the section value.

Sort Object Members

The following members are available for a workbook.Sort object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Sort.ascending	boolean	Server scripts	When set to true, indicates the sort is in ascending order.
	Sort.caseSensitive	boolean	Server scripts	When set to true, indicates the sort is case sensitive.
	Sort.locale	query.SortLocale (read-only)	Server scripts	The locale of the sort.
	Sort.nullsLast	boolean	Server scripts	When set to true, indicates that nulls are placed last in the sort.

SortDefinition Object Members

The following members are available for a workbook.SortDefinition object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	SortDefinition.selector	workbook.DimensionSelector | workbook.PathSelector	Server scripts	The selector for the sort definition.
	SortDefinition.sortBys	Array<workbook.DimensionSort | workbook.MeasureSort>	Server scripts	The sort order for the sort definition.

SortByDataDimensionItem Object Members

The following members are available for a workbook.SortByDataDimensionItem object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	SortByDataDimensionItem.item	workbook.DataDimensionItem	Server scripts	The data dimension item to use for the sort.
	SortByDataDimensionItem.sort	workbook.Sort	Server scripts	The sort to use.

SortByMeasure Object Members

The following members are available for a workbook.SortByMeasure object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	SortByMeasure.measure	workbook.CalculatedMeasure | workbook.DataMeasure	Server scripts	The measure for the sort.
	SortByMeasure.otherAxisSelector	workbook.DescendantorSelfNodesSelector | workbook.PathSelector | workbook.DimensionSelector	Server scripts	The selector for the axis that is not defined in the associated sort definition.
	SortByMeasure.sort	workbook.Sort	Server scripts	The sort to use.

Style Object Members

The following members are available for a workbook.Style object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Style.backgroundColor	string | workbook.Color	Server scripts	The background color of the style.
	Style.backgroundImage	string	Server scripts	The background image of the style.
	Style.backgroundPosition	workbook.PositionPercent | workbook.PositionUnits | workbook.PositionValues	Server scripts	The background position of the style.
	Style.color	string | workbook.Color	Server scripts	The color of the style.
	Style.fontSize	string | workbook.FontSize	Server scripts	The font size of the style.
	Style.fontStyle	string	Server scripts	The font style of the style.
	Style.fontWeight	string	Server scripts	The font weight of the style.
	Style.textAlign	string	Server scripts	The text alignment of the style.
	Style.textDecorationColor	string | workbook.Color	Server scripts	The text decoration color of the style.
	Style.textDecorationLine	string	Server scripts	The text decoration line of the style.
	Style.textDecorationStyle	string	Server scripts	The text decoration style of the style.

Table Object Members

The following members are available for a workbook.Table object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	Table.columns	workbook.TableColumn	Server scripts	The columns in the table view.
	Table.dataset	dataset.Dataset	Server scripts	The dataset for the table view.
	Table.id	string	Server scripts	The ID of the table view.
	Table.name	string | workbook.Expression	Server scripts	The label of the table view.

TableColumn Object Members

The following members are available for a workbook.TableColumn object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	TableColumn.alias	string	Server scripts	The alias for the table column.
	TableColumn.datasetColumnAlias	string	Server scripts	The alias of the dataset column from which the table column was created.
	TableColumn.datasetColumnId	number	Server scripts	The ID of the dataset column from which the table column was created.
	TableColumn.fieldContext	workbook.FieldContext	Server scripts	The field context for the field used in the table column.
	TableColumn.filters	workbook.TableColumnFilter	Server scripts	The filters for the table column.
	TableColumn.label	string	Server scripts	The label for the table column.
	TableColumn.sort	workbook.Sort	Server scripts	The sort for the table column.
	TableColumn.width	number	Server scripts	The desired width of the table column when displayed in the UI.

TableColumnFilter Object Members

The following members are available for a workbook.TableColumnFilter object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Property	TableColumnFilter.operator	string	Server scripts	The operator for the table column filter.
	TableColumnFilter.values	Array<null | Object | Boolean | number | string | Date>	Server scripts	The values for the table column filter.

Workbook Object Members

The following members are available for a workbook.Workbook object.

Member Type	Name	Return Type / Value Type	Supported Script Types	Description
Method	Workbook.runPivot(options)	workbook.PivotIntersection[]	Server scripts	Runs a pivot in the workbook and returns the results as a set of row-column intersections.
Property	Workbook.description	string	Server scripts	The description of the workbook.
	Workbook.id	string	Server scripts	The ID of the workbook.
	Workbook.name	string	Server scripts	The name of the workbook.
	Workbook.pivots	workbook.Pivot[]	Server scripts	The pivots in the workbook.
	Workbook.tables	workbook.Table[]	Server scripts	The tables in the workbook.

Related Topics

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices