@univerjs/sheets-ui v0.5.0-beta.1 • Docs

Interface: ISheetClipboardHook

ClipboardHook could:

Before copy/cut/paste, decide whether to execute the command and prepare caches if necessary.
When copying, decide what content could be written into clipboard.
When pasting, get access to the clipboard content and append mutations to the paste command.

Properties

Property	Type	Defined in
`id`	`string`	submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:84
`isDefaultHook?`	`boolean`	submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:85
`priority?`	`number`	submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:87
`specialPasteInfo?`	`ISpecialPasteInfo`	submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:86

Methods

getFilteredOutRows()?

optional getFilteredOutRows(range): number[]

The callback would be called before the clipboard service decides what region need to be copied from or pasted to. It would jump over these filtered rows when copying or pasting.

Parameters

Parameter	Type
`range`	`IRange`

Returns

number[]

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:181

onAfterCopy()?

optional onAfterCopy(): void

Would be called after copy content has been written into clipboard. Features could do some cleaning up jobs here.

Returns

void

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:123

onAfterPaste()?

optional onAfterPaste(success): void

Parameters

Parameter	Type
`success`	`boolean`

Returns

void

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:175

onBeforeCopy()?

optional onBeforeCopy(
   unitId, 
   subUnitId, 
   range): void

The callback would be called after the clipboard service has decided what region need to be copied. Features could use this hook to build copying cache or any other pre-copy jobs.

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`range`	`IRange`

Returns

void

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:93

onBeforePaste()?

optional onBeforePaste(pasteTo): boolean

The callback would be called after the clipboard service has decided what region need to be pasted. Features could use this hook to build copying cache or any other pre-copy jobs.

Parameters

Parameter	Type
`pasteTo`	`ISheetDiscreteRangeLocation`

Returns

boolean

if it block copying it should return false

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:136

onCopyCellContent()?

optional onCopyCellContent(row, col): string

Parameters

Parameter	Type
`row`	`number`
`col`	`number`

Returns

string

content

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:100

onCopyCellStyle()?

optional onCopyCellStyle(
   row, 
   col, 
   rowSpan?, 
   colSpan?): null | IClipboardPropertyItem

Properties that would be appended to the td element.

Parameters

Parameter	Type	Description
`row`	`number`	row of the the copied cell
`col`	`number`	col of the the copied cell
`rowSpan`?	`number`	-
`colSpan`?	`number`	-

Returns

null | IClipboardPropertyItem

Deprecated

should be merged with onCopyCellContent to onCopyCell

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:108

onCopyColumn()?

optional onCopyColumn(col): null | IClipboardPropertyItem

Properties that would be appended to the col element.

Parameters

Parameter	Type	Description
`col`	`number`	each col of the copied range

Returns

null | IClipboardPropertyItem

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:118

onCopyRow()?

optional onCopyRow(row): null | IClipboardPropertyItem

Properties that would be appended to the tr element.

Parameters

Parameter	Type	Description
`row`	`number`	each row of the the copied range

Returns

null | IClipboardPropertyItem

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:113

onPasteCells()?

optional onPasteCells(
   pasteFrom, 
   pasteTo, 
   data, 
   payload): {
  redos: IMutationInfo<object>[];
  undos: IMutationInfo<object>[];
}

Parameters

Parameter	Type
`pasteFrom`	`null` \| `ISheetDiscreteRangeLocation`
`pasteTo`	`ISheetDiscreteRangeLocation`
`data`	`ObjectMatrix`<`ICellDataWithSpanInfo`>
`payload`	`ICopyPastePayload`

Returns

{
  redos: IMutationInfo<object>[];
  undos: IMutationInfo<object>[];
}

Name	Type	Defined in
`redos`	`IMutationInfo`<`object`>[]	submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:149
`undos`	`IMutationInfo`<`object`>[]	submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:148

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:142

onPasteColumns()?

optional onPasteColumns(
   pasteTo, 
   colProperties, 
   payload): {
  redos: IMutationInfo<object>[];
  undos: IMutationInfo<object>[];
}

Parameters

Parameter	Type
`pasteTo`	`ISheetDiscreteRangeLocation`
`colProperties`	`IClipboardPropertyItem`[]
`payload`	`ICopyPastePayload`

Returns

{
  redos: IMutationInfo<object>[];
  undos: IMutationInfo<object>[];
}

Name	Type	Defined in
`redos`	`IMutationInfo`<`object`>[]	submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:165
`undos`	`IMutationInfo`<`object`>[]	submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:164

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:159

onPastePlainText()?

optional onPastePlainText(
   pasteTo, 
   text, 
   payload): {
  redos: IMutationInfo<object>[];
  undos: IMutationInfo<object>[];
}

Parameters

Parameter	Type
`pasteTo`	`ISheetDiscreteRangeLocation`
`text`	`string`
`payload`	`ICopyPastePayload`

Returns

{
  redos: IMutationInfo<object>[];
  undos: IMutationInfo<object>[];
}

Name	Type	Defined in
`redos`	`IMutationInfo`<`object`>[]	submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:173
`undos`	`IMutationInfo`<`object`>[]	submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:172

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:167

onPasteRows()?

optional onPasteRows(
   pasteTo, 
   rowProperties, 
   payload): {
  redos: IMutationInfo<object>[];
  undos: IMutationInfo<object>[];
}

Parameters

Parameter	Type
`pasteTo`	`ISheetDiscreteRangeLocation`
`rowProperties`	`IClipboardPropertyItem`[]
`payload`	`ICopyPastePayload`

Returns

{
  redos: IMutationInfo<object>[];
  undos: IMutationInfo<object>[];
}

Name	Type	Defined in
`redos`	`IMutationInfo`<`object`>[]	submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:157
`undos`	`IMutationInfo`<`object`>[]	submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:156

Defined in

submodules/univer/packages/sheets-ui/src/services/clipboard/type.ts:151

Isheetautofillhook Isheetclipboardservice