Class ClipboardOptions

The defaults of ClipboardOptionsIf (copy, cut and paste, TableOptionsIf.clipboard).

Example

const options = ClipboardOptions.create({ copyHeaders: true });
options?.html;   // true

Since

1.1.99

Hierarchy

  • ClipboardOptions

Implements

Constructors

constructor

Properties

copyHeaders copyValue createRow? html maxPasteCells pasteAddsRows processCopy? processPaste?

Methods

create

Constructors

constructor

Properties

copyHeaders

copyHeaders: boolean = false

Copy the header labels as first row. Default false.

copyValue

copyValue: "raw" | "text" = "text"

"text": the text as shown (default); "raw": the value (a number without group separators, ISO dates).

Optional createRow

createRow?: ((index) => unknown) = undefined

Type declaration

    • (index): unknown

    • Parameters

      • index: number

      Returns unknown

html

html: boolean = true

Also put an HTML <table> into the clipboard (text/html, numbers keep their value in Excel). Default true.

maxPasteCells

maxPasteCells: number = 1_000_000

Upper limit of pasted cells (after tiling); more are refused and announced. Default 1_000_000.

pasteAddsRows

pasteAddsRows: boolean = false

Pasting over the last row adds rows (createRow is needed for arrays of objects). Default false.

Optional processCopy

processCopy?: ((ctx) => void | string[][]) = undefined

Type declaration

    • (ctx): void | string[][]

    • Parameters

      Returns void | string[][]

Optional processPaste

processPaste?: ((ctx) => false | void | unknown[][]) = undefined

Type declaration

    • (ctx): false | void | unknown[][]

    • Parameters

      Returns false | void | unknown[][]

Methods

Static create

Settings

Member Visibility

Theme

On This Page