Interface CopyCellsSource

Useful for when we are not copying from the current sheet. This abstraction exists to allow for custom sources such as a clipboard.

Remarks

There is a default implementation SheetCopySource that can be used to copy between sheets.

interface CopyCellsSource {
    isCopyCellsSource: true;
    getCopyableItems?(): CopyableItemSource[];
    isCut?(): boolean;
    name?(): string;
    onCancel?(): void;
    onCopy?(): boolean;
    onPaste?(): boolean;
    rangeFrom(): CellRangeCoords;
    scanCells(visitor, options?): void;
    scanColHeaders?(visitor, options?): void;
    scanRowHeaders?(visitor, options?): void;
}

Hierarchy (view full)

CopyCellsSource
- SheetClipboardItem

Implemented by

ReferencedSheetSource

Index

Properties

isCopyCellsSource

Methods

getCopyableItems? isCut? name? onCancel? onCopy? onPaste? rangeFrom scanCells scanColHeaders? scanRowHeaders?

Properties

`Readonly` isCopyCellsSource

isCopyCellsSource: true

For runtime introspection.

Methods

`Optional` getCopyableItems

getCopyableItems(): CopyableItemSource[]
Return copyable items that are not cells.

Returns CopyableItemSource[]
Remarks

`Optional` isCut

isCut(): boolean
Flag to indicate if the operation is expected to be a cut.

Returns boolean
Default Value
```
false
```

`Optional` name

name(): string
The name of a the copy source. Useful for user interactions.

Returns string
Remarks
SheetCopySource uses the sheet name to detect intersections.

`Optional` onCancel

onCancel(): void
Notify when the paste operation is cancelled.

Returns void

`Optional` onCopy

onCopy(): boolean
This is called when the copy has read the source If copy should not be allowed (for example a read only sheet) then return false

Returns boolean

`Optional` onPaste

onPaste(): boolean
Notify when the paste operation is complete.

Returns boolean

rangeFrom

rangeFrom(): CellRangeCoords
The source range

Returns CellRangeCoords

scanCells

scanCells(visitor, options?): void
Scan the values of the source range
Parameters
- visitor: CellVisitor
- Optional options: CellVisitorOptions
Returns void

`Optional` scanColHeaders

scanColHeaders(visitor, options?): void
Scan any columns.
Parameters
- visitor: CellHeaderVisitor
- Optional options: CellHeaderVisitorOptions
Returns void

`Optional` scanRowHeaders

scanRowHeaders(visitor, options?): void
Scan any rows.
Parameters
- visitor: CellHeaderVisitor
- Optional options: CellHeaderVisitorOptions
Returns void