@antv/x6/src/plugin/clipboard/type.ts

JavaScript diagramming library that uses SVG and HTML for rendering

import type {
  Cell,
  Edge,
  EdgeProperties,
  Node,
  NodeProperties,
} from '../../model'

export interface ClipboardImplOptions {
  useLocalStorage?: boolean
}

export interface ClipboardImplCopyOptions extends ClipboardImplOptions {
  deep?: boolean
}

export interface ClipboardImplPasteOptions extends ClipboardImplOptions {
  /**
   * Set of properties to be set on each copied node on every `paste()` call.
   * It is defined as an object. e.g. `{ zIndex: 1 }`.
   */
  nodeProps?: NodeProperties
  /**
   * Set of properties to be set on each copied edge on every `paste()` call.
   * It is defined as an object. e.g. `{ zIndex: 1 }`.
   */
  edgeProps?: EdgeProperties

  /**
   * An increment that is added to the pasted cells position on every
   * `paste()` call. It can be either a number or an object with `dx`
   * and `dy` attributes. It defaults to `{ dx: 20, dy: 20 }`.
   */
  offset?: number | { dx: number; dy: number }
}

export interface ClipboardEventArgs {
  'clipboard:changed': {
    cells: Cell[]
  }
}

export interface ClipboardOptions extends ClipboardImplOptions {
  enabled?: boolean
}