workbook.createCategory(options)

Method Description

Creates a chart category, which includes an axis, a data root, and a sort definition. A chart category is used in a workbook.Chart.

Returns

workbook.Category

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

workbook.ChartAxis

required

The chart category axis definition.

options.root

workbook.DataDimension |workbook.Section

required

The data that feeds the chart category.

options.sortDefinitions

workbook.SortDefinition[]

optional

The sorting for the chart category.

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 Category based on a Section
var myCategory = workbook.createCategory({
    axis: myChartAxis,
    root: mySection,
    sortDefinitions: [mySortDefinition]
});

// Create a Category based on a DataDimension
var myCategory = workbook.createCategory({
    axis: myChartAxis,
    root: myDataDimension,
    sortDefinitions: [mySortDefinition]
});
...
// Add additional code 

          

Related Topics

General Notices