FDefinedNameBuilder

packages	`@univerjs/sheets`

APIs

`build`

Builds the defined name parameter.

Signature

build(): ISetDefinedNameMutationParam

Returns

(ISetDefinedNameMutationParam) — The defined name mutation parameter.

Examples

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

`load`

Loads the defined name mutation parameter.

Signature

load(param: ISetDefinedNameMutationParam): FDefinedNameBuilder

Parameters

param (ISetDefinedNameMutationParam) — - defined name mutation parameter

Returns

(FDefinedNameBuilder) — The instance of FDefinedNameBuilder for method chaining.

Examples

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

`setComment`

Sets the comment of the defined name builder.

Signature

setComment(comment: string): FDefinedNameBuilder

Parameters

comment (string) — The comment of the defined name.

Returns

(FDefinedNameBuilder) — The instance of FDefinedNameBuilder for method chaining.

Examples

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

`setFormula`

Sets the formula of the defined name builder.

Signature

setFormula(formula: string): FDefinedNameBuilder

Parameters

formula (string) — The formula of the defined name.

Returns

(FDefinedNameBuilder) — The instance of FDefinedNameBuilder for method chaining.

Examples

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

`setHidden`

Sets the hidden status of the defined name builder.

Signature

setHidden(hidden: boolean): FDefinedNameBuilder

Parameters

hidden (boolean) — The hidden status of the defined name.

Returns

(FDefinedNameBuilder) — The instance of FDefinedNameBuilder for method chaining.

Examples

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

`setName`

Sets the name of the defined name builder.

Signature

setName(name: string): FDefinedNameBuilder

Parameters

name (string) — The name of the defined name.

Returns

(FDefinedNameBuilder) — The instance of FDefinedNameBuilder for method chaining.

Examples

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

`setRef`

Sets the reference of the defined name builder.

Signature

setRef(a1Notation: string): FDefinedNameBuilder

Parameters

a1Notation (string) — The reference of the defined name.

Returns

(FDefinedNameBuilder) — The instance of FDefinedNameBuilder for method chaining.

Examples

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

`setRefByRange`

Sets the reference of the defined name builder by range .

Signature

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

Parameters

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

Returns

(FDefinedNameBuilder) — The instance of FDefinedNameBuilder for method chaining.

Examples

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

`setScopeToWorkbook`

Sets the scope of the defined name to the workbook.

Signature

setScopeToWorkbook(): FDefinedNameBuilder

Returns

(FDefinedNameBuilder) — The instance of FDefinedNameBuilder for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()

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

`setScopeToWorksheet`

Sets the scope of the defined name to the worksheet.

Signature

setScopeToWorksheet(worksheet: FWorksheet): FDefinedNameBuilder

Parameters

worksheet (FWorksheet) — The worksheet to set the scope to.

Returns

(FDefinedNameBuilder) — The instance of FDefinedNameBuilder for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const sheets = fWorkbook.getSheets()

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

Table of Contents