syncfusion-javascript-spreadsheet-editor

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Syncfusion JavaScript Spreadsheet Editor

Syncfusion JavaScript 电子表格编辑器

Overview

概述

This skill helps developers generate TypeScript code for integrating the Syncfusion Spreadsheet Editor into their JavaScript applications. It provides ready-to-use code snippets, API guidance, and best practices for building Excel-like functionality in JavaScript (ES6) projects.

该Skill帮助开发人员生成将Syncfusion Spreadsheet Editor集成到JavaScript应用中的TypeScript代码。它提供了即用型代码片段、API指南以及在JavaScript（ES6）项目中构建类Excel功能的最佳实践。

Key Capabilities

核心功能

File Operations: Import/export Excel files (
```
xlsx
```
,
```
xls
```
,
```
xlsb
```
), CSV files, and PDF export
Data Management: Data binding, editing, sorting, filtering, and validation
Cell Operations: Formatting (fonts, colors, borders, alignment), merge cells, wrap text
Formulas & Calculations: Built-in Excel formulas, custom functions, named ranges
Collaboration: Notes, comments, and threaded discussions
Advanced Features: Charts, images, hyperlinks, conditional formatting, freeze panes, sheet protection, virtualization for large datasets

文件操作： 导入/导出Excel文件（
```
xlsx
```
,
```
xls
```
,
```
xlsb
```
）、CSV文件，以及PDF导出
数据管理： 数据绑定、编辑、排序、筛选和验证
单元格操作： 格式设置（字体、颜色、边框、对齐方式）、合并单元格、文本换行
公式与计算： 内置Excel公式、自定义函数、命名区域
协作功能： 备注、评论和线程式讨论
高级功能： 图表、图片、超链接、条件格式、冻结窗格、工作表保护、大数据集虚拟化

Quick Start Examples

快速入门示例

Example 1: Generate Spreadsheet with Formatting

示例1：生成带格式的电子表格

User: "Create a Spreadsheet with data and apply cell styles"

Result: A TypeScript code snippet is generated that loads provided data into the Spreadsheet and applies basic cell formatting.

用户： "创建一个包含数据并应用单元格样式的电子表格"

结果： 生成一段TypeScript代码片段，将提供的数据加载到电子表格中并应用基础单元格格式。

Example 2: Generate Code for Loading a File

示例2：生成加载文件的代码

User: "Create a Spreadsheet and load an Excel file initially"

Result: A TypeScript code snippet is generated that initializes the Spreadsheet and programmatically opens an Excel file on startup.

用户： "创建一个电子表格并在初始时加载Excel文件"

结果： 生成一段TypeScript代码片段，初始化电子表格并在启动时以编程方式打开Excel文件。

Getting Started — Minimal JavaScript (ES6) Code

快速上手——最简JavaScript（ES6）代码

Minimal JavaScript (ES6) setup for a plain web project:

typescript

import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';

const spreadsheet = new Spreadsheet({
  sheets: [{ rows: [{ cells: [{ value: 'Hello, Spreadsheet!' }] }] }],
  created: () => {
    // All post-initialization code goes here
  }
});
spreadsheet.appendTo('#spreadsheet');

Placeholders:

```
#spreadsheet
```
— HTML element ID where the component renders
```
sheets
```
— array of sheet objects with data

适用于普通Web项目的最简JavaScript（ES6）设置：

typescript

import { Spreadsheet } from '@syncfusion/ej2-spreadsheet';

const spreadsheet = new Spreadsheet({
  sheets: [{ rows: [{ cells: [{ value: 'Hello, Spreadsheet!' }] }] }],
  created: () => {
    // 所有初始化后的代码都写在这里
  }
});
spreadsheet.appendTo('#spreadsheet');

占位符说明：

```
#spreadsheet
```
—— 组件渲染所在的HTML元素ID
```
sheets
```
—— 包含数据的工作表对象数组

Generate TypeScript Code for the User's Project

为用户项目生成TypeScript代码

Trigger keywords: "javascript spreadsheet", "spreadsheet editor", "syncfusion spreadsheet", "excel component", "load excel file", "open excel file", "import excel", "export excel file", "save excel", "export to pdf", "export to csv", "view excel", "configure spreadsheet", "create spreadsheet", "add spreadsheet", "spreadsheet data", "cell formatting", "apply formulas", "insert chart", "data binding", "spreadsheet validation", "freeze panes", "protect sheet"

Workflow:

Identify the requested Spreadsheet feature (data binding, formulas, charts, export, etc.).
Read the relevant
```
references/*.md
```
file(s) to understand the APIs and code patterns for the requested feature.
STOP before generating code. Check if the user has already chosen a delivery mode.
If no delivery mode is chosen yet, you MUST ask the user first using this concise multiple-choice question:

"How would you like to receive the generated Spreadsheet code?"
- Option 1: Replace the code in a specific project file (you'll need to provide the file path and confirm)
- Option 2: Save the code in this skill's output folder at
```
{skill-root}/syncfusion-javascript-spreadsheet-editor/output/app.ts
```
- Option 3: Share the code directly in the chat window
Only after the user selects a delivery mode, proceed to generate TypeScript code using the APIs and snippets from
```
references/*.md
```
, substituting concrete placeholders from the user's project.
Scope implementations within the
created
event handler — All code implementations should be placed within the Spreadsheet's
```
created
```
event unless the user explicitly requests a different event handler (e.g.,
```
beforeSave
```
,
```
cellSaving
```
, etc.).
Do NOT make changes to workspace project files unless the user explicitly chose Option 1 and provided the file path with permission.
Provide complete TypeScript snippets and concise integration steps after delivering the code.

Refer to
## Rules
section for operational constraints (output directory, temporary files, allowed libraries, etc.)

触发关键词： "javascript spreadsheet"、"spreadsheet editor"、"syncfusion spreadsheet"、"excel component"、"load excel file"、"open excel file"、"import excel"、"export excel file"、"save excel"、"export to pdf"、"export to csv"、"view excel"、"configure spreadsheet"、"create spreadsheet"、"add spreadsheet"、"spreadsheet data"、"cell formatting"、"apply formulas"、"insert chart"、"data binding"、"spreadsheet validation"、"freeze panes"、"protect sheet"

工作流程：

识别用户请求的电子表格功能（数据绑定、公式、图表、导出等）。
阅读相关
```
references/*.md
```
文件，了解该功能对应的API和代码模式。
生成代码前请暂停。检查用户是否已选择交付方式。
如果用户尚未选择交付方式，必须先使用以下简洁的选择题询问用户：

"您希望以何种方式接收生成的电子表格代码？"
- 选项1： 替换指定项目文件中的代码（需提供文件路径并确认）
- 选项2： 将代码保存至该Skill的输出文件夹
```
{skill-root}/syncfusion-javascript-spreadsheet-editor/output/app.ts
```
- 选项3： 直接在聊天窗口中分享代码
仅在用户选择交付方式后，再使用
```
references/*.md
```
中的API和代码片段生成TypeScript代码，并替换为用户项目中的具体占位符。
在
created
事件处理器中实现功能——所有代码实现应放置在Spreadsheet的
```
created
```
事件中，除非用户明确要求使用其他事件处理器（如
```
beforeSave
```
、
```
cellSaving
```
等）。
除非用户明确选择选项1并提供了带权限的文件路径，否则请勿修改工作区项目文件。
交付代码后，提供完整的TypeScript片段和简洁的集成步骤。

有关操作限制（输出目录、临时文件、允许使用的库等），请参考
## 规则
章节

Code References

代码参考

All code snippets and examples are in the

references/

folder. Each file contains:

Minimal TypeScript Code — a working, ready-to-use snippet
Placeholders — values the user must customize
Notes — TypeScript best practices and constraints

File	Topic
initialization.md	Basic TypeScript setup and options
data-binding.md	Local arrays, JSON, remote (DataManager)
formulas.md	Formulas, aggregates, named ranges
formatting.md	Cell formatting, borders, wrap text
number-formatting.md	Number formatting, decimals, currency, date
conditional-formatting.md	Rules, highlights based on conditions
data-validation.md	Validation rules, invalid highlights
sorting-filtering.md	Sorting, filtering
find-replace.md	Find, replace
import-export.md	Save (XLSX/CSV/PDF), open, openFromJson
charts.md	Insert, edit, delete charts
images.md	Insert, modify pictures
hyperlink.md	Add, remove hyperlinks
comments.md	Threaded comments, replies, resolve threads
notes.md	Simple cell notes, sticky visibility, add/edit/delete
protection.md	Sheet protection, cell locking, permissions
edit-cell.md	startEdit, endEdit, updateCell, edit modes
freeze-panes.md	Freeze rows/columns, split panes
row-column.md	Insert, delete, resize rows/columns, hide
merge-cells.md	Merge, unmerge cells, spanning
print.md	Page setup, headers/footers, scaling, margins
misc-operations.md	Autofill, clear, sheet management, goTo
clipboard.md	Copy, cut, paste with different paste types
selection.md	Select cells/ranges, multi-select, getSelectedRange
scrolling-virtualization.md	Virtual scrolling, large datasets, performance
wrap.md	Text wrapping, multi-line display, row height
defined-names.md	Named ranges, define names, refersTo format
custom-functions.md	Custom calculation functions, addCustomFunction
ribbon-customization.md	Ribbon tabs, toolbar items, file menu customization
context-menu.md	Right-click context menu, contextMenuBeforeOpen
localization.md	Multi-language, locale, RTL, number/date formats
events.md	Event handling, event properties, event patterns
autofill.md	Autofill patterns, fill types, series

所有代码片段和示例均位于

references/

文件夹中。每个文件包含：

最简TypeScript代码——可直接运行的可用片段
占位符——用户必须自定义的值
说明——TypeScript最佳实践和约束

文件名称	主题
initialization.md	基础TypeScript设置和选项
data-binding.md	本地数组、JSON、远程（DataManager）绑定
formulas.md	公式、聚合函数、命名区域
formatting.md	单元格格式、边框、文本换行
number-formatting.md	数字格式、小数、货币、日期
conditional-formatting.md	规则、基于条件的高亮显示
data-validation.md	验证规则、无效内容高亮
sorting-filtering.md	排序、筛选
find-replace.md	查找、替换
import-export.md	保存（XLSX/CSV/PDF）、打开、openFromJson
charts.md	插入、编辑、删除图表
images.md	插入、修改图片
hyperlink.md	添加、移除超链接
comments.md	线程式评论、回复、标记已解决
notes.md	简单单元格备注、粘性可见性、添加/编辑/删除
protection.md	工作表保护、单元格锁定、权限设置
edit-cell.md	startEdit、endEdit、updateCell、编辑模式
freeze-panes.md	冻结行/列、拆分窗格
row-column.md	插入、删除、调整行/列大小、隐藏
merge-cells.md	合并、取消合并单元格、跨区域合并
print.md	页面设置、页眉/页脚、缩放、边距
misc-operations.md	自动填充、清除、工作表管理、定位到
clipboard.md	复制、剪切、粘贴（支持不同粘贴类型）
selection.md	选择单元格/区域、多选、获取选中区域
scrolling-virtualization.md	虚拟滚动、大数据集、性能优化
wrap.md	文本换行、多行显示、行高调整
defined-names.md	命名区域、定义名称、refersTo格式
custom-functions.md	自定义计算函数、addCustomFunction
ribbon-customization.md	功能区选项卡、工具栏项、文件菜单自定义
context-menu.md	右键上下文菜单、contextMenuBeforeOpen事件
localization.md	多语言、区域设置、RTL、数字/日期格式
events.md	事件处理、事件属性、事件模式
autofill.md	自动填充模式、填充类型、序列

Key Rules for Code Generation (TypeScript-first)

代码生成核心规则（优先TypeScript）

TypeScript-first snippets — All examples and snippets must be written in TypeScript and compile with the current
```
@syncfusion/ej2-spreadsheet
```
npm package.
No inline code in this manifest — Refer to
```
references/*.md
```
for runnable snippets; keep this file as the concise policy and index.
Default event scoping — All implementations must be placed within the Spreadsheet's
```
created
```
event handler unless the user explicitly requests implementation in another event (e.g.,
```
beforeSave
```
,
```
cellSaving
```
, etc.). This ensures all operations occur after the Spreadsheet component is fully initialized.
Reference file requirements — Each reference must include:
- Minimal TypeScript Code (complete, runnable)
- Placeholders (clearly marked values to replace)
- Notes (TypeScript integration steps and best practices)
License handling — Do not hardcode license keys; refer users to env variables or project config.
Preserve data integrity — Preserve existing formulas, references, and formatting when generating or editing sheets.
No hallucinated APIs — Use verified Syncfusion Spreadsheet Editor method names only.
Read references first — For any requested feature, always read the relevant
```
references/*.md
```
file(s) first before generating code.
Build strictly from references — Build TypeScript code strictly from the APIs, methods, properties, events, and snippets found in the reference files. Do NOT invent, guess, or suggest any API, method, property, or event not explicitly present in the reference files.

优先TypeScript片段——所有示例和片段必须使用TypeScript编写，并能与当前
```
@syncfusion/ej2-spreadsheet
```
npm包兼容编译。
本清单中不包含内联代码——请参考
```
references/*.md
```
获取可运行的代码片段；保持本文件为简洁的策略和索引。
默认事件范围——所有实现必须放置在Spreadsheet的
```
created
```
事件处理器中，除非用户明确要求使用其他事件（如
```
beforeSave
```
、
```
cellSaving
```
等）。这确保所有操作在Spreadsheet组件完全初始化后执行。
参考文件要求——每个参考文件必须包含：
- 最简TypeScript代码（完整、可运行）
- 占位符（明确标记的需替换值）
- 说明（TypeScript集成步骤和最佳实践）
许可证处理——请勿硬编码许可证密钥；请引导用户使用环境变量或项目配置。
保留数据完整性——生成或编辑工作表时，保留现有公式、引用和格式。
请勿使用未经验证的API——仅使用已验证的Syncfusion Spreadsheet Editor方法名称。
先阅读参考文件——对于任何请求的功能，必须先阅读相关
```
references/*.md
```
文件，然后再生成代码。
严格基于参考文件构建——严格使用参考文件中的API、方法、属性、事件和代码片段构建TypeScript代码。请勿发明、猜测或建议参考文件中未明确提及的任何API、方法、属性或事件。

Rules

规则

Output files must go in

{skill-root}/syncfusion-javascript-spreadsheet-editor/output/

directory when user selects Option 2

Only use Syncfusion Spreadsheet APIs — never recommend or use alternative spreadsheet libraries (e.g., handsontable, ag-grid, luckysheet)
No temporary files — never create temporary scripts, intermediate files, or scaffolding outside the output directory
TypeScript-only code — all generated code must be valid TypeScript, never generate vanilla JavaScript, jQuery, or framework-specific patterns

当用户选择选项2时，输出文件必须保存至

{skill-root}/syncfusion-javascript-spreadsheet-editor/output/

仅使用Syncfusion Spreadsheet API——绝不推荐或使用其他电子表格库（如handsontable、ag-grid、luckysheet）
禁止创建临时文件——绝不在输出目录外创建临时脚本、中间文件或脚手架
仅生成TypeScript代码——所有生成的代码必须是有效的TypeScript，绝不生成原生JavaScript、jQuery或特定框架的代码模式