Plugin Functionality

VTable-Sheet currently uses several VTable plugins, including:

• filter-plugin Filter plugin
• auto-fill-plugin Auto-fill plugin
• history-plugin History (undo/redo) plugin
• table-series-number-plugin Table number plugin
• highlight-header-when-select-cell-plugin Header highlight plugin
• context-menu-plugin Right-click menu plugin
• table-export-plugin Table export plugin
• excel-import-plugin Table import plugin

The principle is that each sheet is a VTable instance, so you can use plugins just like with VTable.

Because of this, plugins can only work on individual sheets, not on the entire VTableSheet. For capabilities like import and export, importing an Excel file can only import into the current sheet, rather than importing all sheets from the file into VTableSheet, and exporting can only export the current sheet.

In the future, VTableSheet will provide plugin extension capabilities, without being limited to individual sheets. We also hope that you can contribute plugins to enrich VTableSheet's functionality.

Configuring Plugins

In addition to the built-in plugins mentioned above, VTableSheet also supports users configuring plugins through VTablePluginModules to extend VTableSheet's table plugin functionality.

Before referencing plugins, make sure that @visactor/vtable-plugins and VTableSheet are using the same version, otherwise the plugins may not work properly. Also, be familiar with the plugin usage tutorial, which you can refer to at VTable Plugin Usage Tutorial. If you want to extend VTable plugins, you can refer to VTable Plugin Contribution.

Configuration example: Configure the carousel animation plugin during VTableSheet initialization to implement table carousel scrolling:

Modifying Built-in Plugin Configuration

For built-in plugins in VTableSheet, you can modify the plugin configuration through VTablePluginModules. Built-in plugins have default configuration options, and user configurations will override the built-in defaults. The specific plugin initialization code logic can be found at: https://github.com/VisActor/VTable/blob/develop/packages/vtable-sheet/src/core/table-plugins.ts

Here's an example of modifying the table number plugin color:

Disable Built-in Plugins

If you want to disable built-in plugins, you can configure the plugins through VTablePluginModules to disable built-in plugins.

For example, to disable the context menu plugin:

VTablePluginModules: [
  {
    module: VTablePlugins.ContextMenuPlugin,
    disabled: true
  }
]

Combined Use of Plugins and Menus

For combined use of plugins and menus, refer to Menu Configuration for specific menu configuration.

Here we mainly introduce how to add import and export functionality to the menu. When configuring VTablePluginModules, you need to explicitly configure the required ExcelImportPlugin and TableExportPlugin plugins.

In the example below, mainMenu is configured, and a main menu button will appear in the upper left corner of the UI. Clicking the main menu button will display import and export functionality:

The MenuKey in the example is the menu key value defined internally by VTableSheet.

export enum MenuKey {
  /** Requires plugin support, please configure ExcelImportPlugin in plugins */
  IMPORT = 'import',
  /** Requires plugin support, please configure TableExportPlugin in plugins */
  EXPORT_CURRENT_SHEET_CSV = 'export-current-sheet-csv',
  /** Requires plugin support, please configure TableExportPlugin in plugins */
  EXPORT_CURRENT_SHEET_XLSX = 'export-current-sheet-xlsx'
}

The import and export functionality above can also be called through APIs. After successful initialization, the VTableSheet instance provides the following APIs to call import and export functionality:

• exportSheetToFile
• importFileToSheet

Through the plugin system, you can greatly extend the functionality of VTable-Sheet to meet various complex business requirements. If you want to customize plugins, please refer to Plugin Contribution