rubyXL 项目技术文档

1. 安装指南

安装步骤

1. 打开终端或命令行工具。
2. 输入以下命令安装 rubyXL gem：

   gem install rubyXL
   

3. 等待安装完成。

2. 项目的使用说明

基本使用

1. 在你的 Ruby 项目中引入 rubyXL：

   require 'rubyXL'
   

2. 如果你需要使用便捷方法来操作 Excel 文件，可以引入以下文件：

   require 'rubyXL/convenience_methods/cell'
   require 'rubyXL/convenience_methods/color'
   require 'rubyXL/convenience_methods/font'
   require 'rubyXL/convenience_methods/workbook'
   require 'rubyXL/convenience_methods/worksheet'
   

   或者一次性引入所有便捷方法：

   require 'rubyXL/convenience_methods'
   

解析现有工作簿

workbook = RubyXL::Parser.parse("path/to/Excel/file.xlsx")

创建新工作簿

workbook = RubyXL::Workbook.new

访问工作表

workbook.worksheets[0]  # 返回第一个工作表
workbook[0]             # 返回第一个工作表
workbook['Sheet1']      # 查找并返回名为 "Sheet1" 的工作表

访问行和单元格

worksheet = workbook[0]
worksheet.sheet_data[0]  # 返回工作表的第一行
worksheet[0][0]          # 返回工作表的 A1 单元格

修改单元格内容

worksheet[0][0].change_contents("", worksheet[0][0].formula)  # 设置 A1 单元格的值为空字符串，保留公式

3. 项目API使用文档

工作簿操作

• 解析现有工作簿：

  workbook = RubyXL::Parser.parse("path/to/Excel/file.xlsx")
  

• 创建新工作簿：

  workbook = RubyXL::Workbook.new
  

工作表操作

• 添加工作表：

  worksheet = workbook.add_worksheet('Sheet2')
  

• 重命名工作表：

  worksheet.sheet_name = 'Cool New Name'
  

单元格操作

• 添加单元格：

  worksheet.add_cell(0, 0, 'A1')  # 设置 A1 单元格的值为 "A1"
  

• 修改单元格内容：

  worksheet[0][0].change_contents("", worksheet[0][0].formula)
  

字体和样式操作

• 修改字体：

  worksheet.sheet_data[0][0].change_font_bold(true)  # 设置 A1 单元格为粗体
  

• 修改填充颜色：

  worksheet.sheet_data[0][0].change_fill('0ba53d')  # 设置 A1 单元格的填充颜色为 #0ba53d
  

行和列操作

• 插入行：

  worksheet.insert_row(1)
  

• 删除行：

  worksheet.delete_row(1)
  

• 插入列：

  worksheet.insert_column(1)
  

• 删除列：

  worksheet.delete_column(1)
  

4. 项目安装方式

使用 RubyGems 安装

gem install rubyXL

在项目中引入

require 'rubyXL'

通过以上步骤，你可以轻松安装并使用 rubyXL 来操作 Excel 文件。