# 整体配置

# 基础结构

如下是一个简洁的配置案例:

// 配置项
const settings = {
    data: [{ name: 'Sheet1', celldata: [{ r: 0, c: 0, v: null }] }], // 表格数据
    onChange: (data) => {}, // onChange 事件
    lang: 'zh' // 设定表格语言
    // 更多其他设置...
}

// 渲染工作表
<Workbook {...settings} />

Workbook的配置项会作用于整个表格,单个sheet的配置则需要在settings.data数组中,分别设置对应更详细的参数,参考工作表配置

针对个性化的需求,除了允许配置工具栏(showToolbar)、公示栏(showFormulaBar)、底部sheet页(showSheetTabs)之外, FortuneSheet开放了更细致的自定义配置选项,分别有

# 配置项

以下为所有支持的设置参数

# lang

  • 类型:String
  • 默认值:"zh"
  • 作用:国际化设置,允许设置表格的语言,支持简体中文("zh")、英文("en")、繁体中文("zh_tw")和西班牙文("es")

# data

  • 类型:Array
  • 默认值:undefined
  • 作用:详细参数设置参见工作表配置

# onChange

  • 类型: Function
  • 默认值: undefined
  • data改变时触发

# column

  • 类型:Number
  • 默认值:60
  • 作用:空表格默认的列数量

# row

  • 类型:Number
  • 默认值:84
  • 作用:空表格默认的行数据量

# showToolbar

  • 类型:Boolean
  • 默认值:true
  • 作用:是否显示工具栏

# toolbarItems

  • 类型:Array
  • 默认值:[]
  • 作用:自定义配置工具栏,可以与showtoolbar配合使用,toolbarItems拥有更高的优先级。
  • 格式: 对象格式可以很方便控制显示隐藏,使用数组形式可轻松控制按钮顺序和位置, 以下为工具栏按钮和分隔符的默认配置。
    [
    	"undo",
    	"redo",
    	"format-painter",
    	"clear-format",
    	"|",
    	"currency-format",
    	"percentage-format",
    	"number-decrease",
    	"number-increase",
    	"format",
    	"font-size",
    	"|",
    	"bold",
    	"italic",
    	"strike-through",
    	"underline",
    	"|",
    	"font-color",
    	"background",
    	"border",
    	"merge-cell",
    	"|",
    	"horizontal-align",
    	"vertical-align",
    	"text-wrap",
    	"text-rotation",
    	"|",
    	"freeze",
    	"sort",
    	"image",
    	"comment",
    	"quick-formula",
    ]
    

# showSheetTabs

  • 类型:Boolean
  • 默认值:true
  • 作用:是否显示底部sheet页按钮

# devicePixelRatio

  • 类型:Number
  • 默认值:window.devicePixelRatio
  • 作用:设备比例,比例越大表格分辨率越高

# cellContextMenu

  • 类型:Array
  • 默认值:[]
  • 作用:自定义配置单元格右击菜单
  • 格式:
    [
    	"copy", // 复制
    	"paste", // 粘贴
    	"|",
    	"insert-row", // 插入行
    	"insert-column", // 插入列
    	"delete-row", // 删除选中行
    	"delete-column", // 删除选中列
    	"delete-cell", // 删除单元格
    	"hide-row", // 隐藏选中行和显示选中行
    	"hide-column", // 隐藏选中列和显示选中列
    	"clear", // 清除内容
    	"sort", // 排序选区
    	"filter", // 筛选选区
    	"chart", // 图表生成
    	"image", // 插入图片
    	"link", // 插入链接
    	"data", // 数据验证
    	"cell-format" // 设置单元格格式
    ]
    

# sheetTabContextMenu

  • 类型:Object
  • 作用:自定义配置sheet页右击菜单
  • 格式:
    [
    	"delete",
    	"copy",
    	"rename",
    	"color",
    	"hide",
    	"|",
    	"move"
    ]
    
    

# rowHeaderWidth

  • 类型:Number
  • 默认值:46
  • 作用:行标题区域的宽度,如果设置为0,则表示隐藏行标题

# columnHeaderHeight

  • 类型:Number
  • 默认值:20
  • 作用:列标题区域的高度,如果设置为0,则表示隐藏列标题

# showFormulaBar

  • 类型:Boolean
  • 默认值:true
  • 作用:是否显示公式栏

# defaultFontSize

  • 类型:Number
  • 默认值:11
  • 作用:初始化默认字体大小