Interface SheetClipboardItem

Interface that allows for references to be copied

interface SheetClipboardItem {
    isCopyCellsSource: true;
    isCut?: (() => boolean);
    onCancel?: (() => void);
    onCopy?: (() => boolean);
    onPaste?: (() => boolean);
    toHtml?: (() => string);
    toText?: (() => string);
    type: string;
    getCopyableItems?(): CopyableItemSource[];
    isCellSource(): true;
    name?(): string;
    rangeFrom(): CellRangeCoords;
    scanCells(visitor, options?): void;
    scanColHeaders?(visitor, options?): void;
    scanRowHeaders?(visitor, options?): void;
}

Hierarchy (view full)

Implemented by

Properties

isCopyCellsSource isCut? onCancel? onCopy? onPaste? toHtml? toText? type

Methods

getCopyableItems? isCellSource name? rangeFrom scanCells scanColHeaders? scanRowHeaders?

Properties

Readonly isCopyCellsSource

isCopyCellsSource: true

For runtime introspection.

Optional isCut

isCut?: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

Optional onCancel

onCancel?: (() => void)

Called when data is no longer being used and any references can be discarded

Type declaration

    • (): void

    • Returns void

Optional onCopy

onCopy?: (() => boolean)

Called when data has been copied. This is the time to cut.

Type declaration

    • (): boolean

    • Returns boolean

Optional onPaste

onPaste?: (() => boolean)

Called when data has been written to another location

Type declaration

    • (): boolean

    • Returns boolean

Optional toHtml

toHtml?: (() => string)

Type declaration

    • (): string

    • Returns string

Optional toText

toText?: (() => string)

Type declaration

    • (): string

    • Returns string

Readonly type

type: string

Any descriptive string.

Methods

Optional getCopyableItems

isCellSource

  • isCellSource(): true

  • Returns true

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.

rangeFrom

scanCells

Optional scanColHeaders

Optional scanRowHeaders

Settings

Member Visibility

Theme

On This Page

isCopyCellsSourceisCutonCancelonCopyonPastetoHtmltoTexttypegetCopyableItemsisCellSourcenamerangeFromscanCellsscanColHeadersscanRowHeaders