N/workbook Module

Object

workbook.CalculatedMeasure

Object

Server scripts

A calculated measure.

workbook.ChildNodesSelector

Object

Server scripts

A selector for child nodes.

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.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.

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.

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.

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.

Property

ConditionalFormat.rules

workbook.ConditionalFormatRule[]

Server scripts

The conditional formatting rules that are included in the conditional format.

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.

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).

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.

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.

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.

Property

DataDimensionValue.dataDimension

workbook.DataDimension

Server scripts

The data dimension.

DataDimensionValue.itemValues

workbook.DataDimensionItemValue[]

Server scripts

The item values for the data dimension.

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.

Property

DimensionSelector.dimension

workbook.DataDimension | workbook.Section

Server scripts

The dimension of the dimension selector.

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.

Property

Duration.amount

number

Server scripts

The amount of the duration.

Duration.units

Object

Server scripts

The units of the duration.

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.

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.

Property

FontSize.size

number

Server scripts

The numeric size of the font size.

FontSize.unit

string

Server scripts

The unit of the font size.

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.

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.

Property

MeasureSelector.measures

workbook.CalculatedMeasure[] | workbook.DataMeasure

Server scripts

The measures for the measure selector.

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.

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.

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.

Property

PathSelector.elements

workbook.DimensionSelector

Server scripts

The elements denoting 'xpath' of the selector.

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.

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.

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.

Property

PositionPercent.percentX

number

Server scripts

The percentage of the x dimension.

PositionPercent.percentY

number

Server scripts

The percentage of the y dimension.

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.

Property

PositionValues.horizontal

string

Server scripts

The horizontal value of the position.

PositionValues.vertical

string

Server scripts

The vertical value of the position.

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.

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.

Property

RecordKey.properties

Object

Server scripts

The properties of the record key.

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.

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.

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.

Property

SectionValue.section

workbook.Section

Server scripts

The section of the section value.

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.

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.

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.

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.

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.

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.

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.

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.

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.