1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x API Reference
  4. SuiteScript 2.x Modules
  5. N/workbook Module
  6. workbook.createFontSize(options)

workbook.createFontSize(options)

Method Description

Creates a font size defined using units.

Returns

workbook.FontSize

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

2021.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter

Type

Required / Optional

Description

options.size

number

required

The numeric value of the font size.

options.unit

workbook.Unit

required

The units of the font size.

Errors

Error Code

Thrown If

INVALID_UNIT

The value of the options.unit parameter is not included in the workbook.Unit enum.

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
...
var myFontSize = workbook.createFontSize({
    size: 12,
    unit: workbook.UNIT.PX
});
...
// Add additional code

Related Topics

General Notices