Interface SheetCopyPasteProps

interface SheetCopyPasteProps {
    copyBackgroundColor?: string;
    copyForegroundColor?: string;
    cutBackgroundColor?: string;
    cutForegroundColor?: string;
    element: (() => HTMLElement);
    notifier?: Notifier;
    onClipboardUpdate?: ((item) => void);
    onNativeCopy?: ((e, args) => CopyClipboardArgument);
    onNativePaste?: ((e, args) => any);
    onPaste?: ((item, args) => void | EditMode<any>);
    ranges: CellRangeCoords[];
    selectionRenderer?: ((props) => ReactNode);
    sheetModel: ISheetModel;
}

Hierarchy

Properties

copyBackgroundColor? copyForegroundColor? cutBackgroundColor? cutForegroundColor? element notifier? onClipboardUpdate? onNativeCopy? onNativePaste? onPaste? ranges selectionRenderer? sheetModel

Properties

Optional copyBackgroundColor

copyBackgroundColor?: string

Color for the background

Optional copyForegroundColor

copyForegroundColor?: string

Color for the foreground

Optional cutBackgroundColor

cutBackgroundColor?: string

Optional cutForegroundColor

cutForegroundColor?: string

element

element: (() => HTMLElement)

Sheet element

Type declaration

    • (): HTMLElement

    • Returns HTMLElement

Optional notifier

notifier?: Notifier

Optional onClipboardUpdate

onClipboardUpdate?: ((item) => void)

Type declaration

Optional onNativeCopy

onNativeCopy?: ((e, args) => CopyClipboardArgument)

Returns optional args

Type declaration

Optional onNativePaste

onNativePaste?: ((e, args) => any)

Returns optional args or boolean. If null is returned the no additional process will occur. To prevent native paste the call e.preventDefault().

Type declaration

Optional onPaste

onPaste?: ((item, args) => void | EditMode<any>)

Called after paste has been called. If an editMode is returned then this will be set as the current edit mode.

Type declaration

Remarks

by default the EditMode will be cleared

ranges

ranges: CellRangeCoords[]

Optional selectionRenderer

selectionRenderer?: ((props) => ReactNode)

Allow users to customize selected cells design

Type declaration

sheetModel

sheetModel: ISheetModel

Settings

Member Visibility

Theme

On This Page

copyBackgroundColorcopyForegroundColorcutBackgroundColorcutForegroundColorelementnotifieronClipboardUpdateonNativeCopyonNativePasteonPasterangesselectionRenderersheetModel