类: FDefinedNameBuilder
方法
build()
build(): ISetDefinedNameMutationParamBuilds the defined name parameter.
返回
ISetDefinedNameMutationParam
The defined name mutation parameter.
示例
const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
.setRef('Sheet1!$A$1')
.setName('MyDefinedName')
.setComment('This is a comment')
.build();
workbook.insertDefinedNameBuilder(definedNameBuilder);load()
load(param): FDefinedNameBuilderLoads the defined name mutation parameter.
参数
| 参数 | 类型 | 描述 |
|---|---|---|
param | ISetDefinedNameMutationParam | defined name mutation parameter |
返回
The instance of FDefinedNameBuilder for method chaining.
示例
const workbook = univerAPI.getActiveWorkbook();
const definedNameParam = {
id: '4TMPceoqg8',
unitId: workbook.getId(),
name: 'MyDefinedName',
formulaOrRefString: 'Sheet1!$A$1',
}
const definedNameBuilder = univerAPI.newDefinedName()
.load(definedNameParam)
.build();
workbook.insertDefinedNameBuilder(definedNameBuilder);setComment()
setComment(comment): FDefinedNameBuilderSets the comment of the defined name builder.
参数
| 参数 | 类型 | 描述 |
|---|---|---|
comment | string | The comment of the defined name. |
返回
The instance of FDefinedNameBuilder for method chaining.
示例
const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
.setComment('This is a comment')
.build();
workbook.insertDefinedNameBuilder(definedNameBuilder);setFormula()
setFormula(formula): FDefinedNameBuilderSets the formula of the defined name builder.
参数
| 参数 | 类型 | 描述 |
|---|---|---|
formula | string | The formula of the defined name. |
返回
The instance of FDefinedNameBuilder for method chaining.
示例
const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
.setFormula('SUM(Sheet1!$A$1)')
.setName('MyDefinedName')
.build();
workbook.insertDefinedNameBuilder(definedNameBuilder);setHidden()
setHidden(hidden): FDefinedNameBuilderSets the hidden status of the defined name builder.
参数
| 参数 | 类型 | 描述 |
|---|---|---|
hidden | boolean | The hidden status of the defined name. |
返回
The instance of FDefinedNameBuilder for method chaining.
示例
const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
.setHidden(true)
.build();
workbook.insertDefinedNameBuilder(definedNameBuilder);setName()
setName(name): FDefinedNameBuilderSets the name of the defined name builder.
参数
| 参数 | 类型 | 描述 |
|---|---|---|
name | string | The name of the defined name. |
返回
The instance of FDefinedNameBuilder for method chaining.
示例
const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
.setName('MyDefinedName')
.build();
workbook.insertDefinedNameBuilder(definedNameBuilder);setRef()
setRef(a1Notation): FDefinedNameBuilderSets the reference of the defined name builder.
参数
| 参数 | 类型 | 描述 |
|---|---|---|
a1Notation | string | The reference of the defined name. |
返回
The instance of FDefinedNameBuilder for method chaining.
示例
const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
.setRef('Sheet1!$A$1')
.build();
workbook.insertDefinedNameBuilder(definedNameBuilder);setRefByRange()
setRefByRange(
row,
column,
numRows,
numColumns): FDefinedNameBuilderSets the reference of the defined name builder by range .
参数
| 参数 | 类型 | 描述 |
|---|---|---|
row | number | The start row of the range. |
column | number | The start column of the range. |
numRows | number | The number of rows in the range. |
numColumns | number | The number of columns in the range. |
返回
The instance of FDefinedNameBuilder for method chaining.
示例
const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
.setRefByRange(1, 3, 2, 5)
.build();
workbook.insertDefinedNameBuilder(definedNameBuilder);