CrudOperations
Constructors
Section titled “Constructors”constructor
Section titled “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
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
Section titled “Properties”operations
Section titled “operations”• operations: Operations
Defined in src/CrudOperations.ts:74
undoRedo
Section titled “undoRedo”• undoRedo: UndoRedo
Defined in src/CrudOperations.ts:75
Methods
Section titled “Methods”addColumns
Section titled “addColumns”▸ addColumns(sheet: number, …indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:110
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
addNamedExpression
Section titled “addNamedExpression”▸ addNamedExpression(expressionName: string, expression: RawCellContent, sheetId?: undefined | number, options?: NamedExpressionOptions): void
Defined in src/CrudOperations.ts:382
Parameters:
| Name | Type |
|---|---|
expressionName | string |
expression | RawCellContent |
sheetId? | undefined | number |
options? | NamedExpressionOptions |
Returns: void
addRows
Section titled “addRows”▸ addRows(sheet: number, …indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:92
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
addSheet
Section titled “addSheet”▸ addSheet(name?: undefined | string): string
Defined in src/CrudOperations.ts:204
Parameters:
| Name | Type |
|---|---|
name? | undefined | string |
Returns: string
beginUndoRedoBatchMode
Section titled “beginUndoRedoBatchMode”▸ beginUndoRedoBatchMode(): void
Defined in src/CrudOperations.ts:188
Returns: void
changeNamedExpressionExpression
Section titled “changeNamedExpressionExpression”▸ changeNamedExpressionExpression(expressionName: string, sheetId: number | undefined, newExpression: RawCellContent, options?: NamedExpressionOptions): void
Defined in src/CrudOperations.ts:390
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId | number | undefined |
newExpression | RawCellContent |
options? | NamedExpressionOptions |
Returns: void
clearClipboard
Section titled “clearClipboard”▸ clearClipboard(): void
Defined in src/CrudOperations.ts:200
Returns: void
clearSheet
Section titled “clearSheet”▸ clearSheet(sheetId: number): void
Defined in src/CrudOperations.ts:240
Parameters:
| Name | Type |
|---|---|
sheetId | number |
Returns: void
commitUndoRedoBatchMode
Section titled “commitUndoRedoBatchMode”▸ commitUndoRedoBatchMode(): void
Defined in src/CrudOperations.ts:192
Returns: void
▸ copy(sourceLeftCorner: SimpleCellAddress, width: number, height: number): void
Defined in src/CrudOperations.ts:167
Parameters:
| Name | Type |
|---|---|
sourceLeftCorner | SimpleCellAddress |
width | number |
height | number |
Returns: void
▸ cut(sourceLeftCorner: SimpleCellAddress, width: number, height: number): void
Defined in src/CrudOperations.ts:154
Parameters:
| Name | Type |
|---|---|
sourceLeftCorner | SimpleCellAddress |
width | number |
height | number |
Returns: void
ensureItIsPossibleToAddColumns
Section titled “ensureItIsPossibleToAddColumns”▸ ensureItIsPossibleToAddColumns(sheet: number, …indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:462
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
ensureItIsPossibleToAddNamedExpression
Section titled “ensureItIsPossibleToAddNamedExpression”▸ ensureItIsPossibleToAddNamedExpression(expressionName: string, expression: RawCellContent, sheetId?: undefined | number): void
Defined in src/CrudOperations.ts:408
Parameters:
| Name | Type |
|---|---|
expressionName | string |
expression | RawCellContent |
sheetId? | undefined | number |
Returns: void
ensureItIsPossibleToAddRows
Section titled “ensureItIsPossibleToAddRows”▸ ensureItIsPossibleToAddRows(sheet: number, …indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:429
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
ensureItIsPossibleToAddSheet
Section titled “ensureItIsPossibleToAddSheet”▸ ensureItIsPossibleToAddSheet(name: string): void
Defined in src/CrudOperations.ts:550
Parameters:
| Name | Type |
|---|---|
name | string |
Returns: void
ensureItIsPossibleToChangeCellContents
Section titled “ensureItIsPossibleToChangeCellContents”▸ ensureItIsPossibleToChangeCellContents(inputAddress: SimpleCellAddress, content: RawCellContent[][]): void
Defined in src/CrudOperations.ts:576
Parameters:
| Name | Type |
|---|---|
inputAddress | SimpleCellAddress |
content | RawCellContent[][] |
Returns: void
ensureItIsPossibleToChangeContent
Section titled “ensureItIsPossibleToChangeContent”▸ ensureItIsPossibleToChangeContent(address: SimpleCellAddress): void
Defined in src/CrudOperations.ts:567
Parameters:
| Name | Type |
|---|---|
address | SimpleCellAddress |
Returns: void
ensureItIsPossibleToChangeNamedExpression
Section titled “ensureItIsPossibleToChangeNamedExpression”▸ ensureItIsPossibleToChangeNamedExpression(expressionName: string, expression: RawCellContent, sheetId?: undefined | number): void
Defined in src/CrudOperations.ts:414
Parameters:
| Name | Type |
|---|---|
expressionName | string |
expression | RawCellContent |
sheetId? | undefined | number |
Returns: void
ensureItIsPossibleToChangeSheetContents
Section titled “ensureItIsPossibleToChangeSheetContents”▸ ensureItIsPossibleToChangeSheetContents(sheetId: number, content: RawCellContent[][]): void
Defined in src/CrudOperations.ts:585
Parameters:
| Name | Type |
|---|---|
sheetId | number |
content | RawCellContent[][] |
Returns: void
ensureItIsPossibleToCopy
Section titled “ensureItIsPossibleToCopy”▸ ensureItIsPossibleToCopy(sourceLeftCorner: SimpleCellAddress, width: number, height: number): void
Defined in src/CrudOperations.ts:158
Parameters:
| Name | Type |
|---|---|
sourceLeftCorner | SimpleCellAddress |
width | number |
height | number |
Returns: void
ensureItIsPossibleToMoveColumns
Section titled “ensureItIsPossibleToMoveColumns”▸ ensureItIsPossibleToMoveColumns(sheet: number, startColumn: number, numberOfColumns: number, targetColumn: number): void
Defined in src/CrudOperations.ts:523
Parameters:
| Name | Type |
|---|---|
sheet | number |
startColumn | number |
numberOfColumns | number |
targetColumn | number |
Returns: void
ensureItIsPossibleToMoveRows
Section titled “ensureItIsPossibleToMoveRows”▸ ensureItIsPossibleToMoveRows(sheet: number, startRow: number, numberOfRows: number, targetRow: number): void
Defined in src/CrudOperations.ts:496
Parameters:
| Name | Type |
|---|---|
sheet | number |
startRow | number |
numberOfRows | number |
targetRow | number |
Returns: void
ensureItIsPossibleToRemoveColumns
Section titled “ensureItIsPossibleToRemoveColumns”▸ ensureItIsPossibleToRemoveColumns(sheet: number, …indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:480
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
ensureItIsPossibleToRemoveRows
Section titled “ensureItIsPossibleToRemoveRows”▸ ensureItIsPossibleToRemoveRows(sheet: number, …indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:447
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
ensureItIsPossibleToRenameSheet
Section titled “ensureItIsPossibleToRenameSheet”▸ ensureItIsPossibleToRenameSheet(sheetId: number, name: string): void
Defined in src/CrudOperations.ts:556
Parameters:
| Name | Type |
|---|---|
sheetId | number |
name | string |
Returns: void
ensureRangeInSizeLimits
Section titled “ensureRangeInSizeLimits”▸ ensureRangeInSizeLimits(range: AbsoluteCellRange): void
Defined in src/CrudOperations.ts:591
Parameters:
| Name | Type |
|---|---|
range | AbsoluteCellRange |
Returns: void
ensureScopeIdIsValid
Section titled “ensureScopeIdIsValid”▸ ensureScopeIdIsValid(scopeId?: undefined | number): void
Defined in src/CrudOperations.ts:609
Parameters:
| Name | Type |
|---|---|
scopeId? | undefined | number |
Returns: void
getAndClearContentChanges
Section titled “getAndClearContentChanges”▸ getAndClearContentChanges(): ContentChanges
Defined in src/CrudOperations.ts:605
Returns: ContentChanges
isClipboardEmpty
Section titled “isClipboardEmpty”▸ isClipboardEmpty(): boolean
Defined in src/CrudOperations.ts:196
Returns: boolean
isItPossibleToRemoveNamedExpression
Section titled “isItPossibleToRemoveNamedExpression”▸ isItPossibleToRemoveNamedExpression(expressionName: string, sheetId?: undefined | number): void
Defined in src/CrudOperations.ts:422
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId? | undefined | number |
Returns: void
isThereSomethingToRedo
Section titled “isThereSomethingToRedo”▸ isThereSomethingToRedo(): boolean
Defined in src/CrudOperations.ts:601
Returns: boolean
isThereSomethingToUndo
Section titled “isThereSomethingToUndo”▸ isThereSomethingToUndo(): boolean
Defined in src/CrudOperations.ts:597
Returns: boolean
mappingFromOrder
Section titled “mappingFromOrder”▸ mappingFromOrder(sheetId: number, newOrder: number[], rowOrColumn: “row” | “column”): [number, number][]
Defined in src/CrudOperations.ts:349
Parameters:
| Name | Type |
|---|---|
sheetId | number |
newOrder | number[] |
rowOrColumn | ”row” | “column” |
Returns: [number, number][]
moveCells
Section titled “moveCells”▸ moveCells(sourceLeftCorner: SimpleCellAddress, width: number, height: number, destinationLeftCorner: SimpleCellAddress): void
Defined in src/CrudOperations.ts:128
Parameters:
| Name | Type |
|---|---|
sourceLeftCorner | SimpleCellAddress |
width | number |
height | number |
destinationLeftCorner | SimpleCellAddress |
Returns: void
moveColumns
Section titled “moveColumns”▸ moveColumns(sheet: number, startColumn: number, numberOfColumns: number, targetColumn: number): void
Defined in src/CrudOperations.ts:147
Parameters:
| Name | Type |
|---|---|
sheet | number |
startColumn | number |
numberOfColumns | number |
targetColumn | number |
Returns: void
moveRows
Section titled “moveRows”▸ moveRows(sheet: number, startRow: number, numberOfRows: number, targetRow: number): void
Defined in src/CrudOperations.ts:139
Parameters:
| Name | Type |
|---|---|
sheet | number |
startRow | number |
numberOfRows | number |
targetRow | number |
Returns: void
▸ paste(targetLeftCorner: SimpleCellAddress): void
Defined in src/CrudOperations.ts:172
Parameters:
| Name | Type |
|---|---|
targetLeftCorner | SimpleCellAddress |
Returns: void
▸ redo(): void
Defined in src/CrudOperations.ts:374
Returns: void
removeColumns
Section titled “removeColumns”▸ removeColumns(sheet: number, …indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:119
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
removeNamedExpression
Section titled “removeNamedExpression”▸ removeNamedExpression(expressionName: string, sheetId?: undefined | number): InternalNamedExpression
Defined in src/CrudOperations.ts:398
Parameters:
| Name | Type |
|---|---|
expressionName | string |
sheetId? | undefined | number |
Returns: InternalNamedExpression
removeRows
Section titled “removeRows”▸ removeRows(sheet: number, …indexes: ColumnRowIndex[]): void
Defined in src/CrudOperations.ts:101
Parameters:
| Name | Type |
|---|---|
sheet | number |
...indexes | ColumnRowIndex[] |
Returns: void
removeSheet
Section titled “removeSheet”▸ removeSheet(sheetId: number): void
Defined in src/CrudOperations.ts:214
Parameters:
| Name | Type |
|---|---|
sheetId | number |
Returns: void
renameSheet
Section titled “renameSheet”▸ renameSheet(sheetId: number, newName: string): Maybe‹string›
Defined in src/CrudOperations.ts:224
Parameters:
| Name | Type |
|---|---|
sheetId | number |
newName | string |
Returns: Maybe‹string›
setCellContents
Section titled “setCellContents”▸ setCellContents(topLeftCornerAddress: SimpleCellAddress, cellContents: RawCellContent[][] | RawCellContent): void
Defined in src/CrudOperations.ts:249
Parameters:
| Name | Type |
|---|---|
topLeftCornerAddress | SimpleCellAddress |
cellContents | RawCellContent[][] | RawCellContent |
Returns: void
setColumnOrder
Section titled “setColumnOrder”▸ setColumnOrder(sheetId: number, columnMapping: [number, number][]): void
Defined in src/CrudOperations.ts:322
Parameters:
| Name | Type |
|---|---|
sheetId | number |
columnMapping | [number, number][] |
Returns: void
setRowOrder
Section titled “setRowOrder”▸ setRowOrder(sheetId: number, rowMapping: [number, number][]): void
Defined in src/CrudOperations.ts:295
Parameters:
| Name | Type |
|---|---|
sheetId | number |
rowMapping | [number, number][] |
Returns: void
setSheetContent
Section titled “setSheetContent”▸ setSheetContent(sheetId: number, values: RawCellContent[][]): void
Defined in src/CrudOperations.ts:283
Parameters:
| Name | Type |
|---|---|
sheetId | number |
values | RawCellContent[][] |
Returns: void
testColumnOrderForArrays
Section titled “testColumnOrderForArrays”▸ testColumnOrderForArrays(sheetId: number, columnMapping: [number, number][]): void
Defined in src/CrudOperations.ts:311
Parameters:
| Name | Type |
|---|---|
sheetId | number |
columnMapping | [number, number][] |
Returns: void
testRowOrderForArrays
Section titled “testRowOrderForArrays”▸ testRowOrderForArrays(sheetId: number, rowMapping: [number, number][]): void
Defined in src/CrudOperations.ts:338
Parameters:
| Name | Type |
|---|---|
sheetId | number |
rowMapping | [number, number][] |
Returns: void
▸ undo(): void
Defined in src/CrudOperations.ts:366
Returns: void
validateSwapColumnIndexes
Section titled “validateSwapColumnIndexes”▸ validateSwapColumnIndexes(sheetId: number, columnMapping: [number, number][]): void
Defined in src/CrudOperations.ts:331
Parameters:
| Name | Type |
|---|---|
sheetId | number |
columnMapping | [number, number][] |
Returns: void
validateSwapRowIndexes
Section titled “validateSwapRowIndexes”▸ validateSwapRowIndexes(sheetId: number, rowMapping: [number, number][]): void
Defined in src/CrudOperations.ts:304
Parameters:
| Name | Type |
|---|---|
sheetId | number |
rowMapping | [number, number][] |
Returns: void