Class ClipboardService

constructor

• new ClipboardService(tableScope, options, listen): ClipboardService

• Parameters

  • tableScope: TableScope

    the table

  • options: ClipboardOptionsIf

    complete options

  • listen: boolean

    true: keys and clipboard events (the option is on); false: only the API

  Returns ClipboardService

Readonly options

arm

• arm(kind): boolean

• Ctrl/⌘+C, X or V (from the shortcut mapping): focuses the hidden text field so that the browser fires its clipboard event there. The key must not be consumed (preventDefault) – the caller returns false.

  Parameters

  • kind: ClipboardKind

    the key

  Returns boolean

  true if the event will be handled; false: not here (the editor is open, header focus, an own CopyServiceIf for copying)

cancelCut

• cancelCut(): void

• Removes the mark of cut cells (Escape, another change, TableApi.cancelCut); the clipboard keeps the text.

  Returns void

destroy

• destroy(): void

• Removes the hidden text field and the frame (table destroyed).

  Returns void

getSelectionAsText

• getSelectionAsText(): string

• The selected cells as tab-separated text, as Ctrl/⌘+C copies them (see TableApi.getSelectionAsText).

  Returns string

  the text; "" without cells or with more than CopyService.maxCopyCells

isCutMarked

• isCutMarked(): boolean

• True while cut cells are marked (dashed frame).

  Returns boolean

paste

• paste(text, html?, target?): CellChangeIf<any>[]

• Pastes text (see TableApi.pasteText): parsed like the clipboard, from target or the selection.

  Parameters

  • text: string

    tab-separated text

  • Optional html: string

    text/html (used only without text)

  • Optional target: [number, number]

    display row and model column of the first cell (no tiling)

  Returns CellChangeIf<any>[]

  the written (batch edit: newly pending) cells

runWithoutKey

• runWithoutKey(kind): Promise<void>

• Copy, cut or paste without a key (an ActionId from TableApi.triggerAction, e.g. a context menu): the asynchronous clipboard API – the browser may ask for permission.

  Parameters

  • kind: ClipboardKind

    what to do

  Returns Promise<void>

  resolves when done (a refused permission is ignored)

update

• update(): void

• Places the dashed frame of cut cells (after every render pass); removes it if the cut rows moved.

  Returns void

writeSelection

• writeSelection(cut): Promise<void>

• Copies (or cuts) the selected cells with the asynchronous clipboard API (text/plain and text/html with ClipboardItem, otherwise writeText) – for buttons and menus (see TableApi.copySelection).

  Parameters

  • cut: boolean

    true: mark the cells, they move on the next paste

  Returns Promise<void>

  resolves when the clipboard was written