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

JavaScript diagramming library that uses SVG and HTML for rendering

import { Basecoat, disposable } from '../../common'
import type { Graph, GraphPlugin } from '../../graph'
import type { Cell } from '../../model'
import { ClipboardImpl } from './clipboard'
import type {
  ClipboardEventArgs,
  ClipboardImplCopyOptions,
  ClipboardImplPasteOptions,
  ClipboardOptions,
} from './type'
import './api'

export class Clipboard
  extends Basecoat<ClipboardEventArgs>
  implements GraphPlugin
{
  public name = 'clipboard'
  private clipboardImpl: ClipboardImpl
  private graph: Graph
  public options: ClipboardOptions

  get disabled() {
    return this.options.enabled !== true
  }

  get cells() {
    return this.clipboardImpl.cells
  }

  constructor(options: ClipboardOptions = {}) {
    super()
    this.options = { enabled: true, ...options }
  }

  init(graph: Graph) {
    this.graph = graph
    this.clipboardImpl = new ClipboardImpl()
    this.clipboardImpl.deserialize(this.options)
  }

  // #region api

  isEnabled() {
    return !this.disabled
  }

  enable() {
    if (this.disabled) {
      this.options.enabled = true
    }
  }

  disable() {
    if (!this.disabled) {
      this.options.enabled = false
    }
  }

  toggleEnabled(enabled?: boolean) {
    // the enabled state is not specified.
    if (enabled === undefined) {
      enabled = !this.isEnabled()
    }
    enabled ? this.enable() : this.disable()
    return this
  }

  isEmpty(options: ClipboardOptions = {}) {
    return this.clipboardImpl.isEmpty(options)
  }

  getCellsInClipboard() {
    return this.cells
  }

  clean(force?: boolean) {
    if (!this.disabled || force) {
      this.clipboardImpl.clean()
      this.notify('clipboard:changed', { cells: [] })
    }
    return this
  }

  copy(cells: Cell[], options: ClipboardImplCopyOptions = {}) {
    if (!this.disabled) {
      this.clipboardImpl.copy(cells, this.graph, {
        ...this.commonOptions,
        ...options,
      })
      this.notify('clipboard:changed', { cells })
    }
    return this
  }

  cut(cells: Cell[], options: ClipboardImplCopyOptions = {}) {
    if (!this.disabled) {
      this.clipboardImpl.cut(cells, this.graph, {
        ...this.commonOptions,
        ...options,
      })
      this.notify('clipboard:changed', { cells })
    }
    return this
  }

  paste(options: ClipboardImplPasteOptions = {}, graph: Graph = this.graph) {
    if (!this.disabled) {
      return this.clipboardImpl.paste(graph, {
        ...this.commonOptions,
        ...options,
      })
    }
    return []
  }

  // #endregion

  protected get commonOptions() {
    const { enabled, ...others } = this.options
    return others
  }

  protected notify<K extends keyof ClipboardEventArgs>(
    name: K,
    args: ClipboardEventArgs[K],
  ) {
    this.trigger(name, args)
    this.graph.trigger(name, args)
  }

  @disposable()
  dispose() {
    this.clean(true)
    this.off()
  }
}