workbook.createAspect(options)

Method Description

Creates an aspect for a chart series. An aspect includes a measure and an aspect type.

Returns

workbook.Aspect

Supported Script Types

Server scripts

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

Governance

None

Module

N/workbook Module

Sibling Module Members

N/workbook Module Members

Since

2020.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

options.measure

workbook.CalculatedMeasure | workbook.DataMeasure

required

The measure of the chart series.

options.type

workbook.AspectType

optional

The aspect type of the chart series.

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. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.

            // Add additional code
...
// Create a basic Aspect
var myAspect = workbook.createAspect({
    measure: myMeasure,
});

// Create a complete Aspect
var myAspect = workbook.createAspect({
    measure: myMeasure,
    type: workbook.AspectType.COLOR
});
...
// Add additional code 

          

Related Topics

General Notices