Skip to main content

BrowserUIClipboard

A clipboard to use with a BrowserUI widget, offering methods to copy data and to paste it.

Extends​

Methods​

clear()​

clear(): void

Removes all entries from the clipboard.

Returns​

void

Inherited from​

Clipboard.clear

copy()​

copy(obj): void

Copy some set of objects into the clipboard.

Parameters​

obj​

The object, or objects, to copy in to the clipboard.

Base | VisuallyJsSelection | Base[] | Path

Returns​

void

Inherited from​

Clipboard.copy

copyCurrentSelection()​

copyCurrentSelection(): void

Copies the contents of the associated model instance's current selection into the clipboard.

Returns​

void

Inherited from​

Clipboard.copyCurrentSelection

paste()​

paste(options?): ClonedSet

Paste the clipboard's most recent entry, optionally removing it from the clipboard afterwards.

Parameters​

options?​

BrowserUIPasteOptions

Options for the paste.

Returns​

ClonedSet

Overrides​

Clipboard.paste

pasteCurrentSelection()​

pasteCurrentSelection(options?): ClonedSet

Copies and pastes the contents of the associated model instance's current selection into the clipboard. This method is equivalent to calling copyCurrentSelection() first and then calling paste(..).

Parameters​

options?​

PasteOptions

Options for the paste.

Returns​

ClonedSet

Inherited from​

Clipboard.pasteCurrentSelection