# NamedExpressions Class
# Properties
# SHEET_FOR_WORKBOOK_EXPRESSIONS Static
▪ SHEET_FOR_WORKBOOK_EXPRESSIONS: number = -1
Defined in src/NamedExpressions.ts:127 (opens new window)
# Methods
# addNamedExpression
▸ addNamedExpression(expressionName: string, sheetId?: Maybe‹number›, options?: NamedExpressionOptions): InternalNamedExpression
Defined in src/NamedExpressions.ts:189 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId? | Maybe‹number› |
options? | NamedExpressionOptions |
Returns: InternalNamedExpression
# getAllNamedExpressions
▸ getAllNamedExpressions(): object[]
Defined in src/NamedExpressions.ts:251 (opens new window)
Returns: object[]
# getAllNamedExpressionsForScope
▸ getAllNamedExpressionsForScope(scope?: Maybe‹number›): InternalNamedExpression[]
Defined in src/NamedExpressions.ts:273 (opens new window)
Parameters:
| Name | Type |
|---|---|
scope? | Maybe‹number› |
Returns: InternalNamedExpression[]
# getAllNamedExpressionsNames
▸ getAllNamedExpressionsNames(): string[]
Defined in src/NamedExpressions.ts:247 (opens new window)
Returns: string[]
# getAllNamedExpressionsNamesInScope
▸ getAllNamedExpressionsNamesInScope(sheetId?: Maybe‹number›): string[]
Defined in src/NamedExpressions.ts:243 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId? | Maybe‹number› |
Returns: string[]
# isExpressionInScope
▸ isExpressionInScope(expressionName: string, sheetId: number): boolean
Defined in src/NamedExpressions.ts:162 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId | number |
Returns: boolean
# isNameAvailable
▸ isNameAvailable(expressionName: string, sheetId?: Maybe‹number›): boolean
Defined in src/NamedExpressions.ts:133 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId? | Maybe‹number› |
Returns: boolean
# isNameValid
▸ isNameValid(expressionName: string): boolean
Defined in src/NamedExpressions.ts:177 (opens new window)
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 (opens new window) standard.
Parameters:
| Name | Type |
|---|---|
expressionName | string |
Returns: boolean
# namedExpressionForScope
▸ namedExpressionForScope(expressionName: string, sheetId?: Maybe‹number›): Maybe‹InternalNamedExpression›
Defined in src/NamedExpressions.ts:150 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId? | Maybe‹number› |
Returns: Maybe‹InternalNamedExpression›
# namedExpressionInAddress
▸ namedExpressionInAddress(row: number): Maybe‹InternalNamedExpression›
Defined in src/NamedExpressions.ts:141 (opens new window)
Parameters:
| Name | Type |
|---|---|
row | number |
Returns: Maybe‹InternalNamedExpression›
# namedExpressionOrPlaceholder
▸ namedExpressionOrPlaceholder(expressionName: string, sheetId: number): InternalNamedExpression
Defined in src/NamedExpressions.ts:212 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId | number |
Returns: InternalNamedExpression
# nearestNamedExpression
▸ nearestNamedExpression(expressionName: string, sheetId: number): Maybe‹InternalNamedExpression›
Defined in src/NamedExpressions.ts:158 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId | number |
Returns: Maybe‹InternalNamedExpression›
# remove
▸ remove(expressionName: string, sheetId?: Maybe‹number›): void
Defined in src/NamedExpressions.ts:225 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId? | Maybe‹number› |
Returns: void
# restoreNamedExpression
▸ restoreNamedExpression(namedExpression: InternalNamedExpression, sheetId?: Maybe‹number›): InternalNamedExpression
Defined in src/NamedExpressions.ts:204 (opens new window)
Parameters:
| Name | Type |
|---|---|
namedExpression | InternalNamedExpression |
sheetId? | Maybe‹number› |
Returns: InternalNamedExpression
# workbookNamedExpressionOrPlaceholder
▸ workbookNamedExpressionOrPlaceholder(expressionName: string): InternalNamedExpression
Defined in src/NamedExpressions.ts:216 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
Returns: InternalNamedExpression