FDefinedNameBuilder

Access

Access through:

Setup

Register @univerjs/sheets or a preset that includes it. In plugin mode, import @univerjs/sheets/facade. Additional methods below require their listed plugin packages. See Facade setup.

`@univerjs/sheets`

`FDefinedNameBuilder.build`

Builds the defined name parameter.

TypeScript

build(): ISetDefinedNameMutationParam

Returns

The defined name mutation parameter.

Examples

TypeScript

const fWorkbook = univerAPI.getActiveWorkbook()const definedNameParam = fWorkbook  .newDefinedNameBuilder()  .setName('MyDefinedName')  .setRef('Sheet1!$A$1')  .setComment('A reference to A1 cell in Sheet1')  .build()fWorkbook.insertDefinedNameBuilder(definedNameParam)

Types: ISetDefinedNameMutationParam

Package: @univerjs/sheets · Type definitions

`FDefinedNameBuilder.load`

Loads the defined name mutation parameter.

TypeScript

load(param: ISetDefinedNameMutationParam): FDefinedNameBuilder

Parameters

param — Required. defined name mutation parameter

Returns

The instance of FDefinedNameBuilder for method chaining.

Examples

TypeScript

const fWorkbook = univerAPI.getActiveWorkbook()const definedNameParam = fWorkbook  .newDefinedNameBuilder()  .load({    id: '4TMPceoqg8',    name: 'MyDefinedName',    formulaOrRefString: 'Sheet1!$A$1',  })  .build()fWorkbook.insertDefinedNameBuilder(definedNameParam)

Types: FDefinedNameBuilder · ISetDefinedNameMutationParam

Package: @univerjs/sheets · Type definitions

`FDefinedNameBuilder.setComment`

Sets the comment of the defined name builder.

TypeScript

setComment(comment: string): FDefinedNameBuilder

Parameters

comment — Required. The comment of the defined name.

Returns

The instance of FDefinedNameBuilder for method chaining.

Examples

TypeScript

const fWorkbook = univerAPI.getActiveWorkbook()const definedNameParam = fWorkbook  .newDefinedNameBuilder()  .setName('MyDefinedName')  .setRef('Sheet1!$A$1')  .setComment('A reference to A1 cell in Sheet1')  .build()fWorkbook.insertDefinedNameBuilder(definedNameParam)

Types: FDefinedNameBuilder

Package: @univerjs/sheets · Type definitions

`FDefinedNameBuilder.setFormula`

Sets the formula of the defined name builder.

TypeScript

setFormula(formula: string): FDefinedNameBuilder

Parameters

formula — Required. The formula of the defined name.

Returns

The instance of FDefinedNameBuilder for method chaining.

Examples

TypeScript

const fWorkbook = univerAPI.getActiveWorkbook()const definedNameParam = fWorkbook  .newDefinedNameBuilder()  .setName('MyDefinedName')  .setFormula('SUM(Sheet1!$A$1)')  .build()fWorkbook.insertDefinedNameBuilder(definedNameParam)

Types: FDefinedNameBuilder

Package: @univerjs/sheets · Type definitions

`FDefinedNameBuilder.setHidden`

Sets the hidden status of the defined name builder.

TypeScript

setHidden(hidden: boolean): FDefinedNameBuilder

Parameters

hidden — Required. The hidden status of the defined name.

Returns

The instance of FDefinedNameBuilder for method chaining.

Examples

TypeScript

const fWorkbook = univerAPI.getActiveWorkbook()const definedNameParam = fWorkbook  .newDefinedNameBuilder()  .setName('MyDefinedName')  .setRef('Sheet1!$A$1')  .setHidden(true)  .build()fWorkbook.insertDefinedNameBuilder(definedNameParam)

Types: FDefinedNameBuilder

Package: @univerjs/sheets · Type definitions

`FDefinedNameBuilder.setName`

Sets the name of the defined name builder.

TypeScript

setName(name: string): FDefinedNameBuilder

Parameters

name — Required. The name of the defined name.

Returns

The instance of FDefinedNameBuilder for method chaining.

Examples

TypeScript

const fWorkbook = univerAPI.getActiveWorkbook()const definedNameParam = fWorkbook  .newDefinedNameBuilder()  .setName('MyDefinedName')  .setRef('Sheet1!$A$1')  .build()fWorkbook.insertDefinedNameBuilder(definedNameParam)

Types: FDefinedNameBuilder

Package: @univerjs/sheets · Type definitions

`FDefinedNameBuilder.setRef`

Sets the reference of the defined name builder.

TypeScript

setRef(a1Notation: string): FDefinedNameBuilder

Parameters

a1Notation — Required. The reference of the defined name.

Returns

The instance of FDefinedNameBuilder for method chaining.

Examples

TypeScript

const fWorkbook = univerAPI.getActiveWorkbook()const definedNameParam = fWorkbook  .newDefinedNameBuilder()  .setName('MyDefinedName')  .setRef('Sheet1!$A$1')  .build()fWorkbook.insertDefinedNameBuilder(definedNameParam)

Types: FDefinedNameBuilder

Package: @univerjs/sheets · Type definitions

`FDefinedNameBuilder.setRefByRange`

Sets the reference of the defined name builder by range .

TypeScript

setRefByRange(row: number, column: number, numRows: number, numColumns: number): FDefinedNameBuilder

Parameters

row — Required. The start row index of the range. index start at 0.
column — Required. The start column index of the range. index start at 0.
numRows — Required. The number of rows in the range.
numColumns — Required. The number of columns in the range.

Returns

The instance of FDefinedNameBuilder for method chaining.

Examples

TypeScript

const fWorkbook = univerAPI.getActiveWorkbook()const definedNameParam = fWorkbook  .newDefinedNameBuilder()  .setName('MyDefinedName')  .setRefByRange(1, 3, 2, 5) // D2:H3  .build()fWorkbook.insertDefinedNameBuilder(definedNameParam)

Types: FDefinedNameBuilder

Package: @univerjs/sheets · Type definitions

`FDefinedNameBuilder.setScopeToWorkbook`

Sets the scope of the defined name to the workbook.

TypeScript

setScopeToWorkbook(): FDefinedNameBuilder

Returns

The instance of FDefinedNameBuilder for method chaining.

Examples

TypeScript

const fWorkbook = univerAPI.getActiveWorkbook()// Create a defined name and make it available in the entire workbookconst definedNameParam = fWorkbook  .newDefinedNameBuilder()  .setName('MyDefinedName')  .setRef('Sheet1!$A$1')  .setScopeToWorkbook()  .build()fWorkbook.insertDefinedNameBuilder(definedNameParam)

Types: FDefinedNameBuilder

Package: @univerjs/sheets · Type definitions

`FDefinedNameBuilder.setScopeToWorksheet`

Sets the scope of the defined name to the worksheet.

TypeScript

setScopeToWorksheet(worksheet: FWorksheet): FDefinedNameBuilder

Parameters

worksheet — Required. The worksheet to set the scope to.

Returns

The instance of FDefinedNameBuilder for method chaining.

Examples

TypeScript

const fWorkbook = univerAPI.getActiveWorkbook()const sheets = fWorkbook.getSheets()// Create a defined name and make it available only in the second worksheetconst definedNameParam = fWorkbook  .newDefinedNameBuilder()  .setName('MyDefinedName')  .setRef('Sheet1!$A$1')  .setScopeToWorksheet(sheets[1])  .build()fWorkbook.insertDefinedNameBuilder(definedNameParam)

Types: FDefinedNameBuilder · FWorksheet

Package: @univerjs/sheets · Type definitions

How is this guide?