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 hyperformula/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

operations

Readonly

• operations: Operations

Defined in hyperformula/src/CrudOperations.ts:74

undoRedo

Readonly

• undoRedo: UndoRedo

Defined in hyperformula/src/CrudOperations.ts:75

Methods

addColumns

▸ addColumns(sheet: number, …indexes: ColumnRowIndex[]): void

Defined in hyperformula/src/CrudOperations.ts:110

Parameters:

Name	Type
`sheet`	number
`...indexes`	ColumnRowIndex[]

Returns: void

addNamedExpression

▸ addNamedExpression(expressionName: string, expression: RawCellContent, sheetId?: undefined | number, options?: NamedExpressionOptions): void

Defined in hyperformula/src/CrudOperations.ts:382

Parameters:

Name	Type
`expressionName`	string
`expression`	RawCellContent
`sheetId?`	undefined \| number
`options?`	NamedExpressionOptions

Returns: void

addRows

▸ addRows(sheet: number, …indexes: ColumnRowIndex[]): void

Defined in hyperformula/src/CrudOperations.ts:92

Parameters:

Name	Type
`sheet`	number
`...indexes`	ColumnRowIndex[]

Returns: void

addSheet

▸ addSheet(name?: undefined | string): string

Defined in hyperformula/src/CrudOperations.ts:204

Parameters:

Name	Type
`name?`	undefined \| string

Returns: string

beginUndoRedoBatchMode

▸ beginUndoRedoBatchMode(): void

Defined in hyperformula/src/CrudOperations.ts:188

Returns: void

changeNamedExpressionExpression

▸ changeNamedExpressionExpression(expressionName: string, sheetId: number | undefined, newExpression: RawCellContent, options?: NamedExpressionOptions): void

Defined in hyperformula/src/CrudOperations.ts:390

Parameters:

Name	Type
`expressionName`	string
`sheetId`	number \| undefined
`newExpression`	RawCellContent
`options?`	NamedExpressionOptions

Returns: void

clearClipboard

▸ clearClipboard(): void

Defined in hyperformula/src/CrudOperations.ts:200

Returns: void

clearSheet

▸ clearSheet(sheetId: number): void

Defined in hyperformula/src/CrudOperations.ts:240

Parameters:

Name	Type
`sheetId`	number

Returns: void

commitUndoRedoBatchMode

▸ commitUndoRedoBatchMode(): void

Defined in hyperformula/src/CrudOperations.ts:192

Returns: void

copy

▸ copy(sourceLeftCorner: SimpleCellAddress, width: number, height: number): void

Defined in hyperformula/src/CrudOperations.ts:167

Parameters:

Name	Type
`sourceLeftCorner`	SimpleCellAddress
`width`	number
`height`	number

Returns: void

cut

▸ cut(sourceLeftCorner: SimpleCellAddress, width: number, height: number): void

Defined in hyperformula/src/CrudOperations.ts:154

Parameters:

Name	Type
`sourceLeftCorner`	SimpleCellAddress
`width`	number
`height`	number

Returns: void

ensureItIsPossibleToAddColumns

▸ ensureItIsPossibleToAddColumns(sheet: number, …indexes: ColumnRowIndex[]): void

Defined in hyperformula/src/CrudOperations.ts:462

Parameters:

Name	Type
`sheet`	number
`...indexes`	ColumnRowIndex[]

Returns: void

ensureItIsPossibleToAddNamedExpression

▸ ensureItIsPossibleToAddNamedExpression(expressionName: string, expression: RawCellContent, sheetId?: undefined | number): void

Defined in hyperformula/src/CrudOperations.ts:408

Parameters:

Name	Type
`expressionName`	string
`expression`	RawCellContent
`sheetId?`	undefined \| number

Returns: void

ensureItIsPossibleToAddRows

▸ ensureItIsPossibleToAddRows(sheet: number, …indexes: ColumnRowIndex[]): void

Defined in hyperformula/src/CrudOperations.ts:429

Parameters:

Name	Type
`sheet`	number
`...indexes`	ColumnRowIndex[]

Returns: void

ensureItIsPossibleToAddSheet

▸ ensureItIsPossibleToAddSheet(name: string): void

Defined in hyperformula/src/CrudOperations.ts:550

Parameters:

Name	Type
`name`	string

Returns: void

ensureItIsPossibleToChangeCellContents

▸ ensureItIsPossibleToChangeCellContents(inputAddress: SimpleCellAddress, content: RawCellContent[][]): void

Defined in hyperformula/src/CrudOperations.ts:576

Parameters:

Name	Type
`inputAddress`	SimpleCellAddress
`content`	RawCellContent[][]

Returns: void

ensureItIsPossibleToChangeContent

▸ ensureItIsPossibleToChangeContent(address: SimpleCellAddress): void

Defined in hyperformula/src/CrudOperations.ts:567

Parameters:

Name	Type
`address`	SimpleCellAddress

Returns: void

ensureItIsPossibleToChangeNamedExpression

▸ ensureItIsPossibleToChangeNamedExpression(expressionName: string, expression: RawCellContent, sheetId?: undefined | number): void

Defined in hyperformula/src/CrudOperations.ts:414

Parameters:

Name	Type
`expressionName`	string
`expression`	RawCellContent
`sheetId?`	undefined \| number

Returns: void

ensureItIsPossibleToChangeSheetContents

▸ ensureItIsPossibleToChangeSheetContents(sheetId: number, content: RawCellContent[][]): void

Defined in hyperformula/src/CrudOperations.ts:585

Parameters:

Name	Type
`sheetId`	number
`content`	RawCellContent[][]

Returns: void

ensureItIsPossibleToCopy

▸ ensureItIsPossibleToCopy(sourceLeftCorner: SimpleCellAddress, width: number, height: number): void

Defined in hyperformula/src/CrudOperations.ts:158

Parameters:

Name	Type
`sourceLeftCorner`	SimpleCellAddress
`width`	number
`height`	number

Returns: void

ensureItIsPossibleToMoveColumns

▸ ensureItIsPossibleToMoveColumns(sheet: number, startColumn: number, numberOfColumns: number, targetColumn: number): void

Defined in hyperformula/src/CrudOperations.ts:523

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 hyperformula/src/CrudOperations.ts:496

Parameters:

Name	Type
`sheet`	number
`startRow`	number
`numberOfRows`	number
`targetRow`	number

Returns: void

ensureItIsPossibleToRemoveColumns

▸ ensureItIsPossibleToRemoveColumns(sheet: number, …indexes: ColumnRowIndex[]): void

Defined in hyperformula/src/CrudOperations.ts:480

Parameters:

Name	Type
`sheet`	number
`...indexes`	ColumnRowIndex[]

Returns: void

ensureItIsPossibleToRemoveRows

▸ ensureItIsPossibleToRemoveRows(sheet: number, …indexes: ColumnRowIndex[]): void

Defined in hyperformula/src/CrudOperations.ts:447

Parameters:

Name	Type
`sheet`	number
`...indexes`	ColumnRowIndex[]

Returns: void

ensureItIsPossibleToRenameSheet

▸ ensureItIsPossibleToRenameSheet(sheetId: number, name: string): void

Defined in hyperformula/src/CrudOperations.ts:556

Parameters:

Name	Type
`sheetId`	number
`name`	string

Returns: void

ensureRangeInSizeLimits

▸ ensureRangeInSizeLimits(range: AbsoluteCellRange): void

Defined in hyperformula/src/CrudOperations.ts:591

Parameters:

Name	Type
`range`	AbsoluteCellRange

Returns: void

ensureScopeIdIsValid

▸ ensureScopeIdIsValid(scopeId?: undefined | number): void

Defined in hyperformula/src/CrudOperations.ts:609

Parameters:

Name	Type
`scopeId?`	undefined \| number

Returns: void

getAndClearContentChanges

▸ getAndClearContentChanges(): ContentChanges

Defined in hyperformula/src/CrudOperations.ts:605

Returns: ContentChanges

isClipboardEmpty

▸ isClipboardEmpty(): boolean

Defined in hyperformula/src/CrudOperations.ts:196

Returns: boolean

isItPossibleToRemoveNamedExpression

▸ isItPossibleToRemoveNamedExpression(expressionName: string, sheetId?: undefined | number): void

Defined in hyperformula/src/CrudOperations.ts:422

Parameters:

Name	Type
`expressionName`	string
`sheetId?`	undefined \| number

Returns: void

isThereSomethingToRedo

▸ isThereSomethingToRedo(): boolean

Defined in hyperformula/src/CrudOperations.ts:601

Returns: boolean

isThereSomethingToUndo

▸ isThereSomethingToUndo(): boolean

Defined in hyperformula/src/CrudOperations.ts:597

Returns: boolean

mappingFromOrder

▸ mappingFromOrder(sheetId: number, newOrder: number[], rowOrColumn: “row” | “column”): [number, number][]

Defined in hyperformula/src/CrudOperations.ts:349

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 hyperformula/src/CrudOperations.ts:128

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 hyperformula/src/CrudOperations.ts:147

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 hyperformula/src/CrudOperations.ts:139

Parameters:

Name	Type
`sheet`	number
`startRow`	number
`numberOfRows`	number
`targetRow`	number

Returns: void

paste

▸ paste(targetLeftCorner: SimpleCellAddress): void

Defined in hyperformula/src/CrudOperations.ts:172

Parameters:

Name	Type
`targetLeftCorner`	SimpleCellAddress

Returns: void

redo

▸ redo(): void

Defined in hyperformula/src/CrudOperations.ts:374

Returns: void

removeColumns

▸ removeColumns(sheet: number, …indexes: ColumnRowIndex[]): void

Defined in hyperformula/src/CrudOperations.ts:119

Parameters:

Name	Type
`sheet`	number
`...indexes`	ColumnRowIndex[]

Returns: void

removeNamedExpression

▸ removeNamedExpression(expressionName: string, sheetId?: undefined | number): InternalNamedExpression

Defined in hyperformula/src/CrudOperations.ts:398

Parameters:

Name	Type
`expressionName`	string
`sheetId?`	undefined \| number

Returns: InternalNamedExpression

removeRows

▸ removeRows(sheet: number, …indexes: ColumnRowIndex[]): void

Defined in hyperformula/src/CrudOperations.ts:101

Parameters:

Name	Type
`sheet`	number
`...indexes`	ColumnRowIndex[]

Returns: void

removeSheet

▸ removeSheet(sheetId: number): void

Defined in hyperformula/src/CrudOperations.ts:214

Parameters:

Name	Type
`sheetId`	number

Returns: void

renameSheet

▸ renameSheet(sheetId: number, newName: string): Maybe‹string›

Defined in hyperformula/src/CrudOperations.ts:224

Parameters:

Name	Type
`sheetId`	number
`newName`	string

Returns: Maybe‹string›

setCellContents

▸ setCellContents(topLeftCornerAddress: SimpleCellAddress, cellContents: RawCellContent[][] | RawCellContent): void

Defined in hyperformula/src/CrudOperations.ts:249

Parameters:

Name	Type
`topLeftCornerAddress`	SimpleCellAddress
`cellContents`	RawCellContent[][] \| RawCellContent

Returns: void

setColumnOrder

▸ setColumnOrder(sheetId: number, columnMapping: [number, number][]): void

Defined in hyperformula/src/CrudOperations.ts:322

Parameters:

Name	Type
`sheetId`	number
`columnMapping`	[number, number][]

Returns: void

setRowOrder

▸ setRowOrder(sheetId: number, rowMapping: [number, number][]): void

Defined in hyperformula/src/CrudOperations.ts:295

Parameters:

Name	Type
`sheetId`	number
`rowMapping`	[number, number][]

Returns: void

setSheetContent

▸ setSheetContent(sheetId: number, values: RawCellContent[][]): void

Defined in hyperformula/src/CrudOperations.ts:283

Parameters:

Name	Type
`sheetId`	number
`values`	RawCellContent[][]

Returns: void

testColumnOrderForArrays

▸ testColumnOrderForArrays(sheetId: number, columnMapping: [number, number][]): void

Defined in hyperformula/src/CrudOperations.ts:311

Parameters:

Name	Type
`sheetId`	number
`columnMapping`	[number, number][]

Returns: void

testRowOrderForArrays

▸ testRowOrderForArrays(sheetId: number, rowMapping: [number, number][]): void

Defined in hyperformula/src/CrudOperations.ts:338

Parameters:

Name	Type
`sheetId`	number
`rowMapping`	[number, number][]

Returns: void

undo

▸ undo(): void

Defined in hyperformula/src/CrudOperations.ts:366

Returns: void

validateSwapColumnIndexes

▸ validateSwapColumnIndexes(sheetId: number, columnMapping: [number, number][]): void

Defined in hyperformula/src/CrudOperations.ts:331

Parameters:

Name	Type
`sheetId`	number
`columnMapping`	[number, number][]

Returns: void

validateSwapRowIndexes

▸ validateSwapRowIndexes(sheetId: number, rowMapping: [number, number][]): void

Defined in hyperformula/src/CrudOperations.ts:304

Parameters:

Name	Type
`sheetId`	number
`rowMapping`	[number, number][]

Returns: void