NamedExpressions
Properties
Section titled “Properties”SHEET_FOR_WORKBOOK_EXPRESSIONS
Section titled “SHEET_FOR_WORKBOOK_EXPRESSIONS”▪ SHEET_FOR_WORKBOOK_EXPRESSIONS: number = -1
Defined in src/NamedExpressions.ts:127
Methods
Section titled “Methods”addNamedExpression
Section titled “addNamedExpression”▸ addNamedExpression(expressionName: string, sheetId?: undefined | number, options?: NamedExpressionOptions): InternalNamedExpression
Defined in src/NamedExpressions.ts:189
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId? | undefined | number |
options? | NamedExpressionOptions |
Returns: InternalNamedExpression
getAllNamedExpressions
Section titled “getAllNamedExpressions”▸ getAllNamedExpressions(): object[]
Defined in src/NamedExpressions.ts:251
Returns: object[]
getAllNamedExpressionsForScope
Section titled “getAllNamedExpressionsForScope”▸ getAllNamedExpressionsForScope(scope?: undefined | number): InternalNamedExpression[]
Defined in src/NamedExpressions.ts:273
Parameters:
| Name | Type |
|---|---|
scope? | undefined | number |
Returns: InternalNamedExpression[]
getAllNamedExpressionsNames
Section titled “getAllNamedExpressionsNames”▸ getAllNamedExpressionsNames(): string[]
Defined in src/NamedExpressions.ts:247
Returns: string[]
getAllNamedExpressionsNamesInScope
Section titled “getAllNamedExpressionsNamesInScope”▸ getAllNamedExpressionsNamesInScope(sheetId?: undefined | number): string[]
Defined in src/NamedExpressions.ts:243
Parameters:
| Name | Type |
|---|---|
sheetId? | undefined | number |
Returns: string[]
isExpressionInScope
Section titled “isExpressionInScope”▸ isExpressionInScope(expressionName: string, sheetId: number): boolean
Defined in src/NamedExpressions.ts:162
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId | number |
Returns: boolean
isNameAvailable
Section titled “isNameAvailable”▸ isNameAvailable(expressionName: string, sheetId?: undefined | number): boolean
Defined in src/NamedExpressions.ts:133
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId? | undefined | number |
Returns: boolean
isNameValid
Section titled “isNameValid”▸ isNameValid(expressionName: string): boolean
Defined in src/NamedExpressions.ts:177
Checks the validity of a named-expression’s name.
The name:
- Must start with a Unicode letter or with an underscore (
_). - Can contain only Unicode letters, numbers, underscores, and periods (
.). - Can’t be the same as any possible reference in the A1 notation (
[A-Za-z]+[0-9]+). - Can’t be the same as any possible reference in the R1C1 notation (
[rR][0-9]*[cC][0-9]*).
The naming rules follow the OpenDocument standard.
Parameters:
| Name | Type |
|---|---|
expressionName | string |
Returns: boolean
namedExpressionForScope
Section titled “namedExpressionForScope”▸ namedExpressionForScope(expressionName: string, sheetId?: undefined | number): Maybe‹InternalNamedExpression›
Defined in src/NamedExpressions.ts:150
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId? | undefined | number |
Returns: Maybe‹InternalNamedExpression›
namedExpressionInAddress
Section titled “namedExpressionInAddress”▸ namedExpressionInAddress(row: number): Maybe‹InternalNamedExpression›
Defined in src/NamedExpressions.ts:141
Parameters:
| Name | Type |
|---|---|
row | number |
Returns: Maybe‹InternalNamedExpression›
namedExpressionOrPlaceholder
Section titled “namedExpressionOrPlaceholder”▸ namedExpressionOrPlaceholder(expressionName: string, sheetId: number): InternalNamedExpression
Defined in src/NamedExpressions.ts:212
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId | number |
Returns: InternalNamedExpression
nearestNamedExpression
Section titled “nearestNamedExpression”▸ nearestNamedExpression(expressionName: string, sheetId: number): Maybe‹InternalNamedExpression›
Defined in src/NamedExpressions.ts:158
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId | number |
Returns: Maybe‹InternalNamedExpression›
remove
Section titled “remove”▸ remove(expressionName: string, sheetId?: undefined | number): void
Defined in src/NamedExpressions.ts:225
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId? | undefined | number |
Returns: void
restoreNamedExpression
Section titled “restoreNamedExpression”▸ restoreNamedExpression(namedExpression: InternalNamedExpression, sheetId?: undefined | number): InternalNamedExpression
Defined in src/NamedExpressions.ts:204
Parameters:
| Name | Type |
|---|---|
namedExpression | InternalNamedExpression |
sheetId? | undefined | number |
Returns: InternalNamedExpression
workbookNamedExpressionOrPlaceholder
Section titled “workbookNamedExpressionOrPlaceholder”▸ workbookNamedExpressionOrPlaceholder(expressionName: string): InternalNamedExpression
Defined in src/NamedExpressions.ts:216
Parameters:
| Name | Type |
|---|---|
expressionName | string |
Returns: InternalNamedExpression