# CrudOperations Class
# Constructors
# constructor
+ new CrudOperations(config: Config, operations: Operations, undoRedo: UndoRedo, clipboardOperations: ClipboardOperations, dependencyGraph: DependencyGraph, columnSearch: ColumnSearchStrategy, parser: ParserWithCaching, cellContentParser: CellContentParser, lazilyTransformingAstService: LazilyTransformingAstService, namedExpressions: NamedExpressions): CrudOperations
Defined in src/CrudOperations.ts:70 (opens new window)
Parameters:
| Name | Type |
|---|---|
config | Config |
operations | Operations |
undoRedo | UndoRedo |
clipboardOperations | ClipboardOperations |
dependencyGraph | DependencyGraph |
columnSearch | ColumnSearchStrategy |
parser | ParserWithCaching |
cellContentParser | CellContentParser |
lazilyTransformingAstService | LazilyTransformingAstService |
namedExpressions | NamedExpressions |
Returns: CrudOperations
# Properties
# operations Readonly
• operations: Operations
Defined in src/CrudOperations.ts:74 (opens new window)
# undoRedo Readonly
• undoRedo: UndoRedo
Defined in src/CrudOperations.ts:75 (opens new window)
# Methods
# addColumns
▸ addColumns(sheet: number, ...indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:110 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
# addNamedExpression
▸ addNamedExpression(expressionName: string, expression: RawCellContent, sheetId?: Maybe‹number›, options?: NamedExpressionOptions): void
Defined in src/CrudOperations.ts:376 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
expression | RawCellContent |
sheetId? | Maybe‹number› |
options? | NamedExpressionOptions |
Returns: void
# addRows
▸ addRows(sheet: number, ...indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:92 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
# addSheet
▸ addSheet(name?: undefined | string): string
Defined in src/CrudOperations.ts:204 (opens new window)
Parameters:
| Name | Type |
|---|---|
name? | undefined | string |
Returns: string
# beginUndoRedoBatchMode
▸ beginUndoRedoBatchMode(): void
Defined in src/CrudOperations.ts:188 (opens new window)
Returns: void
# changeNamedExpressionExpression
▸ changeNamedExpressionExpression(expressionName: string, sheetId: number | undefined, newExpression: RawCellContent, options?: NamedExpressionOptions): void
Defined in src/CrudOperations.ts:384 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId | number | undefined |
newExpression | RawCellContent |
options? | NamedExpressionOptions |
Returns: void
# clearClipboard
▸ clearClipboard(): void
Defined in src/CrudOperations.ts:200 (opens new window)
Returns: void
# clearSheet
▸ clearSheet(sheetId: number): void
Defined in src/CrudOperations.ts:234 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
Returns: void
# commitUndoRedoBatchMode
▸ commitUndoRedoBatchMode(): void
Defined in src/CrudOperations.ts:192 (opens new window)
Returns: void
# copy
▸ copy(sourceLeftCorner: SimpleCellAddress, width: number, height: number): void
Defined in src/CrudOperations.ts:167 (opens new window)
Parameters:
| Name | Type |
|---|---|
sourceLeftCorner | SimpleCellAddress |
width | number |
height | number |
Returns: void
# cut
▸ cut(sourceLeftCorner: SimpleCellAddress, width: number, height: number): void
Defined in src/CrudOperations.ts:154 (opens new window)
Parameters:
| Name | Type |
|---|---|
sourceLeftCorner | SimpleCellAddress |
width | number |
height | number |
Returns: void
# ensureItIsPossibleToAddColumns
▸ ensureItIsPossibleToAddColumns(sheet: number, ...indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:456 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
# ensureItIsPossibleToAddNamedExpression
▸ ensureItIsPossibleToAddNamedExpression(expressionName: string, expression: RawCellContent, sheetId?: Maybe‹number›): void
Defined in src/CrudOperations.ts:402 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
expression | RawCellContent |
sheetId? | Maybe‹number› |
Returns: void
# ensureItIsPossibleToAddRows
▸ ensureItIsPossibleToAddRows(sheet: number, ...indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:423 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
# ensureItIsPossibleToAddSheet
▸ ensureItIsPossibleToAddSheet(name: string): void
Defined in src/CrudOperations.ts:544 (opens new window)
Parameters:
| Name | Type |
|---|---|
name | string |
Returns: void
# ensureItIsPossibleToChangeCellContents
▸ ensureItIsPossibleToChangeCellContents(inputAddress: SimpleCellAddress, content: RawCellContent[][]): void
Defined in src/CrudOperations.ts:570 (opens new window)
Parameters:
| Name | Type |
|---|---|
inputAddress | SimpleCellAddress |
content | RawCellContent[][] |
Returns: void
# ensureItIsPossibleToChangeContent
▸ ensureItIsPossibleToChangeContent(address: SimpleCellAddress): void
Defined in src/CrudOperations.ts:561 (opens new window)
Parameters:
| Name | Type |
|---|---|
address | SimpleCellAddress |
Returns: void
# ensureItIsPossibleToChangeNamedExpression
▸ ensureItIsPossibleToChangeNamedExpression(expressionName: string, expression: RawCellContent, sheetId?: Maybe‹number›): void
Defined in src/CrudOperations.ts:408 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
expression | RawCellContent |
sheetId? | Maybe‹number› |
Returns: void
# ensureItIsPossibleToChangeSheetContents
▸ ensureItIsPossibleToChangeSheetContents(sheetId: number, content: RawCellContent[][]): void
Defined in src/CrudOperations.ts:579 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
content | RawCellContent[][] |
Returns: void
# ensureItIsPossibleToCopy
▸ ensureItIsPossibleToCopy(sourceLeftCorner: SimpleCellAddress, width: number, height: number): void
Defined in src/CrudOperations.ts:158 (opens new window)
Parameters:
| Name | Type |
|---|---|
sourceLeftCorner | SimpleCellAddress |
width | number |
height | number |
Returns: void
# ensureItIsPossibleToMoveColumns
▸ ensureItIsPossibleToMoveColumns(sheet: number, startColumn: number, numberOfColumns: number, targetColumn: number): void
Defined in src/CrudOperations.ts:517 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
startColumn | number |
numberOfColumns | number |
targetColumn | number |
Returns: void
# ensureItIsPossibleToMoveRows
▸ ensureItIsPossibleToMoveRows(sheet: number, startRow: number, numberOfRows: number, targetRow: number): void
Defined in src/CrudOperations.ts:490 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
startRow | number |
numberOfRows | number |
targetRow | number |
Returns: void
# ensureItIsPossibleToRemoveColumns
▸ ensureItIsPossibleToRemoveColumns(sheet: number, ...indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:474 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
# ensureItIsPossibleToRemoveRows
▸ ensureItIsPossibleToRemoveRows(sheet: number, ...indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:441 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
# ensureItIsPossibleToRenameSheet
▸ ensureItIsPossibleToRenameSheet(sheetId: number, name: string): void
Defined in src/CrudOperations.ts:550 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
name | string |
Returns: void
# ensureRangeInSizeLimits
▸ ensureRangeInSizeLimits(range: AbsoluteCellRange): void
Defined in src/CrudOperations.ts:585 (opens new window)
Parameters:
| Name | Type |
|---|---|
range | AbsoluteCellRange |
Returns: void
# ensureScopeIdIsValid
▸ ensureScopeIdIsValid(scopeId?: Maybe‹number›): void
Defined in src/CrudOperations.ts:603 (opens new window)
Parameters:
| Name | Type |
|---|---|
scopeId? | Maybe‹number› |
Returns: void
# getAndClearContentChanges
▸ getAndClearContentChanges(): ContentChanges
Defined in src/CrudOperations.ts:599 (opens new window)
Returns: ContentChanges
# isClipboardEmpty
▸ isClipboardEmpty(): boolean
Defined in src/CrudOperations.ts:196 (opens new window)
Returns: boolean
# isItPossibleToRemoveNamedExpression
▸ isItPossibleToRemoveNamedExpression(expressionName: string, sheetId?: Maybe‹number›): void
Defined in src/CrudOperations.ts:416 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId? | Maybe‹number› |
Returns: void
# isThereSomethingToRedo
▸ isThereSomethingToRedo(): boolean
Defined in src/CrudOperations.ts:595 (opens new window)
Returns: boolean
# isThereSomethingToUndo
▸ isThereSomethingToUndo(): boolean
Defined in src/CrudOperations.ts:591 (opens new window)
Returns: boolean
# mappingFromOrder
▸ mappingFromOrder(sheetId: number, newOrder: number[], rowOrColumn: "row" | "column"): [number, number][]
Defined in src/CrudOperations.ts:343 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
newOrder | number[] |
rowOrColumn | "row" | "column" |
Returns: [number, number][]
# moveCells
▸ moveCells(sourceLeftCorner: SimpleCellAddress, width: number, height: number, destinationLeftCorner: SimpleCellAddress): void
Defined in src/CrudOperations.ts:128 (opens new window)
Parameters:
| Name | Type |
|---|---|
sourceLeftCorner | SimpleCellAddress |
width | number |
height | number |
destinationLeftCorner | SimpleCellAddress |
Returns: void
# moveColumns
▸ moveColumns(sheet: number, startColumn: number, numberOfColumns: number, targetColumn: number): void
Defined in src/CrudOperations.ts:147 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
startColumn | number |
numberOfColumns | number |
targetColumn | number |
Returns: void
# moveRows
▸ moveRows(sheet: number, startRow: number, numberOfRows: number, targetRow: number): void
Defined in src/CrudOperations.ts:139 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
startRow | number |
numberOfRows | number |
targetRow | number |
Returns: void
# paste
▸ paste(targetLeftCorner: SimpleCellAddress): void
Defined in src/CrudOperations.ts:172 (opens new window)
Parameters:
| Name | Type |
|---|---|
targetLeftCorner | SimpleCellAddress |
Returns: void
# redo
▸ redo(): void
Defined in src/CrudOperations.ts:368 (opens new window)
Returns: void
# removeColumns
▸ removeColumns(sheet: number, ...indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:119 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
# removeNamedExpression
▸ removeNamedExpression(expressionName: string, sheetId?: Maybe‹number›): InternalNamedExpression
Defined in src/CrudOperations.ts:392 (opens new window)
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId? | Maybe‹number› |
Returns: InternalNamedExpression
# removeRows
▸ removeRows(sheet: number, ...indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:101 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
# removeSheet
▸ removeSheet(sheetId: number): void
Defined in src/CrudOperations.ts:214 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
Returns: void
# renameSheet
▸ renameSheet(sheetId: number, newName: string): Maybe‹string›
Defined in src/CrudOperations.ts:224 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
newName | string |
Returns: Maybe‹string›
# setCellContents
▸ setCellContents(topLeftCornerAddress: SimpleCellAddress, cellContents: RawCellContent[][] | RawCellContent): void
Defined in src/CrudOperations.ts:243 (opens new window)
Parameters:
| Name | Type |
|---|---|
topLeftCornerAddress | SimpleCellAddress |
cellContents | RawCellContent[][] | RawCellContent |
Returns: void
# setColumnOrder
▸ setColumnOrder(sheetId: number, columnMapping: [number, number][]): void
Defined in src/CrudOperations.ts:316 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
columnMapping | [number, number][] |
Returns: void
# setRowOrder
▸ setRowOrder(sheetId: number, rowMapping: [number, number][]): void
Defined in src/CrudOperations.ts:289 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
rowMapping | [number, number][] |
Returns: void
# setSheetContent
▸ setSheetContent(sheetId: number, values: RawCellContent[][]): void
Defined in src/CrudOperations.ts:277 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
values | RawCellContent[][] |
Returns: void
# testColumnOrderForArrays
▸ testColumnOrderForArrays(sheetId: number, columnMapping: [number, number][]): void
Defined in src/CrudOperations.ts:305 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
columnMapping | [number, number][] |
Returns: void
# testRowOrderForArrays
▸ testRowOrderForArrays(sheetId: number, rowMapping: [number, number][]): void
Defined in src/CrudOperations.ts:332 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
rowMapping | [number, number][] |
Returns: void
# undo
▸ undo(): void
Defined in src/CrudOperations.ts:360 (opens new window)
Returns: void
# validateSwapColumnIndexes
▸ validateSwapColumnIndexes(sheetId: number, columnMapping: [number, number][]): void
Defined in src/CrudOperations.ts:325 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
columnMapping | [number, number][] |
Returns: void
# validateSwapRowIndexes
▸ validateSwapRowIndexes(sheetId: number, rowMapping: [number, number][]): void
Defined in src/CrudOperations.ts:298 (opens new window)
Parameters:
| Name | Type |
|---|---|
sheetId | number |
rowMapping | [number, number][] |
Returns: void