Spreadsheet

主要入口类,涉及表格初始化,data 初始化相关

调用方法为:

  1. // instance 你创建的实例,公有方法可以直接调用,私有方法不可以
  2. instance.publicFn(args)

主要实例

统一暴露在 window

  1. // 你可以在 window 上访问
  2. const spreadsheet = (el, options = {}) => new Spreadsheet(el, options);
  3. if (window) {
  4. window.x_spreadsheet = spreadsheet;
  5. window.x_spreadsheet.locale = (lang, message) => locale(lang, message);
  6. }
  7. // 你可以这样创建
  8. const xs = x_spreadsheet(id, config)

也可以将库作为你开发的目录

  1. // index.js 这是默认导出的
  2. export default Spreadsheet;
  3. export {
  4. spreadsheet,
  5. };
  6. // you local main page
  7. // 你可以直接导入本地库引入
  8. import Spreadsheet from '[path]'

公有方法

addSheet(name, active)

功能 添加多表

@param name string 名称

@param active boolean 默认为 true

cell(ri, ci, sheetIndex)

功能 获得单元格内容

@param ri number 行坐标

@param ci number 列坐标

@param sheetIndex number 默认值为:0,当前表格index

cellStyle(ri, ci, sheetIndex)

功能 获得单元格样式属性

@param ri number 行坐标

@param ci number 列坐标

@param sheetIndex number 默认值为:0,当前表格index

cellText(ri, ci, text, sheetIndex)

功能 设置选定表格中的单元格的值

@param ri number 行坐标

@param ci number 列坐标

@param text string

@param sheetIndex number 默认值为:0,当前表格index

reRender()

功能 重新刷新整个表格

deleteSheet()

功能 删除当前表

loadData(data) 加载数据

@param {data} json 数据格式

如何获取数据格式: 请使用 getData() 方法

  1. import Spreadsheet from "x-data-spreadsheet";
  2. const xs = new Spreadsheet("#x-spreadsheet-demo")
  3. // data 是 json 格式
  4. // 加载数据
  5. xs.loadData(data)

getData() 获取数据

获取数据

  1. // 获取数据 d
  2. const d = xs.getData()

change(callback) 变更事件

页面操作或者数据发生变化

  1. // 如
  2. xs.change(function(data){
  3. // 默认会返回整个数据 json
  4. })

locale(lang, message) 本地化

  1. // 加载语言包, 需要cdn 引入汉化文件或者从本地导入
  2. xs.locale('zh-cn');

on(eventName, callback) 绑定事件

监听事件

  1. xs.on('cell-selected', function(cell, ri, ci) {
  2. // to do ...
  3. })