Clipboard

Module Extensions

ClipboardConfig (Extended from @revolist/revogrid)

interface ClipboardConfig {
  /** Additional rich clipboard formats used by ClipboardPlugin. */
      formats?: readonly ClipboardFormatHandler[];
  /** Maximum decoded cells. Defaults to 1,000,000. */
      maxCells?: number;
  /** Maximum bytes inspected in one text representation. Defaults to 16 MiB. */
      maxBytes?: number
}

---

HTMLRevoGridElementEventMap (Extended from global)

interface HTMLRevoGridElementEventMap {
  clipboardformaterror: ClipboardFormatDiagnostic
}

Plugin API

ClipboardPlugin

Browser-rich, Excel-compatible clipboard orchestration for RevoGrid Pro.

Dependencies

• Optional DataGridFormattingPlugin: Uses DataGridFormattingPlugin when available to import and apply rich formatting.

class ClipboardPlugin {
  registerFormat(handler: ClipboardFormatHandler): () => void;

  registerMetadataContributor(contributor: ClipboardMetadataContributor): () => void;
}

---

matrixToClipboardDocument

export function matrixToClipboardDocument(
  matrix: readonly (readonly DataFormat[])[],
  source = 'revogrid',
): ClipboardDocument;

---

clipboardDocumentToMatrix

export function clipboardDocumentToMatrix(document: ClipboardDocument): DataFormat[][];

---

countClipboardCells

export function countClipboardCells(document: ClipboardDocument);

---

isClipboardDocument

export function isClipboardDocument(value: unknown): value is ClipboardDocument;

---

createExcelHtmlClipboardFormat

export function createExcelHtmlClipboardFormat(
  formatting?: ClipboardExcelFormattingAdapter,
): ClipboardFormatHandler;

---

createGenericHtmlClipboardFormat

export function createGenericHtmlClipboardFormat(
  formatting?: ClipboardExcelFormattingAdapter,
): ClipboardFormatHandler;

---

extractCfHtml

export function extractCfHtml(value: string): string;

---

parseHtmlClipboard

export function parseHtmlClipboard(
  raw: string,
  options: {
    source: string;
    maxBytes: number;
    maxCells: number;
    formatting?: ClipboardExcelFormattingAdapter;
  },
): ClipboardDocument | null;

---

serializeExcelHtml

export function serializeExcelHtml(
  document: ClipboardDocument,
  formatting?: ClipboardExcelFormattingAdapter,
): string;

---

ClipboardExcelFormattingAdapter

interface ClipboardExcelFormattingAdapter {
  importFormat(declarations: readonly string[]): ClipboardCell['format'];
  importValue(displayText: string, format?: ClipboardCell['format']): unknown;
  exportFormat(format: NonNullable<ClipboardCell['format']>): string | undefined;
  exportValue(
      value: unknown,
      format: NonNullable<ClipboardCell['format']>,
    ): { readonly value: unknown; readonly displayText: string }
}

---

excelHtmlClipboardFormat

Value-only default. ClipboardPlugin supplies the formatting runtime adapter.

excelHtmlClipboardFormat: ClipboardFormatHandler<any>;

---

genericHtmlClipboardFormat

Value-only default. ClipboardPlugin supplies the formatting runtime adapter.

genericHtmlClipboardFormat: ClipboardFormatHandler<any>;

---

parseDelimitedText

export function parseDelimitedText(value: string, delimiter: string): string[][];

---

serializeDelimitedText

export function serializeDelimitedText(
  matrix: readonly (readonly unknown[])[],
  delimiter: string,
): string;

---

plainTextClipboardFormat

plainTextClipboardFormat: {
  id: string;
  mimeTypes: string[];
  priority: number;
  read: ({ transfer, maxBytes, maxCells }: ClipboardFormatReadContext) => ClipboardDocument<any>;
  write: ({ document }: ClipboardFormatWriteContext<any>) => { type: string; data: string; }[];
};

---

ClipboardFormatRegistry

class ClipboardFormatRegistry {
  register(handler: ClipboardFormatHandler): () => void;

  read(transfer: ClipboardDataReader, limits: { maxCells: number; maxBytes: number });

  write(document: ClipboardDocument, transfer: ClipboardDataWriter): void;
}

---

resolveClipboardPluginConfig

export function resolveClipboardPluginConfig(
  useClipboard: boolean | ClipboardConfig | undefined,
): ResolvedClipboardPluginConfig;

---

REVOGRID_CLIPBOARD_MIME

REVOGRID_CLIPBOARD_MIME: string;

---

REVOGRID_CLIPBOARD_VERSION

REVOGRID_CLIPBOARD_VERSION: 2;

---

ClipboardCell

interface ClipboardCell {
  readonly value: T;
  readonly displayText?: string;
  readonly formula?: string;
  readonly format?: DataGridCellFormat;
  readonly metadata?: Readonly<Record<string, unknown>>
}

---

ClipboardRange

interface ClipboardRange {
  readonly row: number;
  readonly col: number;
  readonly width: number;
  readonly height: number;
  readonly cells: readonly ClipboardCell<T>[];
  readonly merges?: readonly MergeData[];
  readonly columnWidths?: readonly (number | undefined)[];
  readonly rowHeights?: readonly (number | undefined)[];
  readonly rowType?: DimensionRows;
  readonly colType?: DimensionCols;
  readonly metadata?: Readonly<Record<string, unknown>>
}

---

ClipboardDocument

interface ClipboardDocument {
  readonly version: typeof REVOGRID_CLIPBOARD_VERSION;
  readonly source: string;
  readonly ranges: readonly ClipboardRange<T>[];
  readonly metadata?: Readonly<Record<string, unknown>>
}

---

ClipboardDataReader

interface ClipboardDataReader {
  readonly types: readonly string[];
  getData(type: string): string
}

---

ClipboardDataWriter

interface ClipboardDataWriter {
  setData(type: string, value: string): void
}

---

ClipboardFormatReadContext

interface ClipboardFormatReadContext {
  readonly transfer: ClipboardDataReader;
  readonly maxCells: number;
  readonly maxBytes: number
}

---

ClipboardFormatWriteContext

interface ClipboardFormatWriteContext {
  readonly document: ClipboardDocument<T>
}

---

ClipboardRepresentation

interface ClipboardRepresentation {
  readonly type: string;
  readonly data: string
}

---

ClipboardFormatHandler

interface ClipboardFormatHandler {
  readonly id: string;
  readonly mimeTypes: readonly string[];
  readonly priority?: number;
  canRead?(context: ClipboardFormatReadContext): boolean;
  read(context: ClipboardFormatReadContext): ClipboardDocument<T> | null;
  write?(context: ClipboardFormatWriteContext<T>): readonly ClipboardRepresentation[]
}

---

ClipboardMetadataCaptureContext

interface ClipboardMetadataCaptureContext {
  readonly document: ClipboardDocument<T>;
  readonly providers: PluginProviders
}

---

ClipboardMetadataApplyContext

interface ClipboardMetadataApplyContext {
  readonly document: ClipboardDocument<T>;
  readonly providers: PluginProviders
}

---

ClipboardMetadataContributor

interface ClipboardMetadataContributor {
  readonly id: string;
  capture?(context: ClipboardMetadataCaptureContext<T>): unknown;
  apply?(metadata: unknown, context: ClipboardMetadataApplyContext<T>): void
}

---

ClipboardFormatDiagnostic

interface ClipboardFormatDiagnostic {
  readonly phase: 'read' | 'write' | 'metadata';
  readonly handlerId: string;
  readonly error: unknown
}

---

ClipboardPluginConfig

interface ClipboardPluginConfig {
  readonly formats?: readonly ClipboardFormatHandler[];
  readonly maxCells?: number;
  readonly maxBytes?: number
}

---

ResolvedClipboardPluginConfig

interface ResolvedClipboardPluginConfig {
  readonly formats: readonly ClipboardFormatHandler[];
  readonly maxCells: number;
  readonly maxBytes: number
}

---

normalizeExcelClipboardFormula

Convert browser-visible Excel R1C1 references into FormulaPlugin-compatible A1 references.

export function normalizeExcelClipboardFormula(
  value: string,
  rowIndex: number,
  columnIndex: number,
): string;

---

toExcelClipboardFormula

Convert FormulaPlugin-compatible A1 references into Excel HTML R1C1 references.

export function toExcelClipboardFormula(
  value: string,
  rowIndex: number,
  columnIndex: number,
): string;

---

cloneClipboardDocument

export function cloneClipboardDocument(document: ClipboardDocument): ClipboardDocument;

---

revogridJsonClipboardFormat

revogridJsonClipboardFormat: {
  id: string;
  mimeTypes: string[];
  priority: number;
  read: ({ transfer, maxBytes, maxCells }: ClipboardFormatReadContext) => ClipboardDocument<any> | null;
  write: ({ document }: ClipboardFormatWriteContext<any>) => { type: string; data: string; }[];
};