2dcJqgrid 技术文档

1. 安装指南

1.1 环境要求

• Ruby on Rails 框架
• jQuery

1.2 安装步骤

1. 在 Rails 项目的 Gemfile 中添加以下内容：

   gem '2dc_jqgrid'
   

2. 运行以下命令安装 gem：

   bundle install
   

3. 运行生成器以创建一个示例网格：

   ./script/generate jqgrid user id pseudo email firstname
   

2. 项目的使用说明

2.1 基本功能

• Ajax 支持：网格数据通过 Ajax 加载。
• 排序：支持列排序功能。
• 分页：支持分页显示数据。
• 搜索：支持在网格中进行搜索。
• CRUD 操作：支持添加、编辑、删除操作。
• 多选：支持通过复选框进行多选。
• 主从关系：支持主从关系的显示。
• 主题：支持多种主题风格。

2.2 示例代码

以下是一个简单的示例代码，展示如何在 Rails 项目中使用 2dcJqgrid：

class UsersController < ApplicationController
  def index
    @users = User.all
    respond_to do |format|
      format.html
      format.json { render json: @users }
    end
  end
end

3. 项目API使用文档

3.1 生成网格

使用以下命令生成一个网格：

./script/generate jqgrid user id pseudo email firstname

3.2 配置选项

• url：指定数据源的 URL。
• datatype：指定数据类型（如 json）。
• colNames：指定列名。
• colModel：指定列模型。

3.3 示例配置

$("#grid").jqGrid({
  url: '/users',
  datatype: 'json',
  colNames: ['ID', 'Pseudo', 'Email', 'Firstname'],
  colModel: [
    {name: 'id', index: 'id', width: 50},
    {name: 'pseudo', index: 'pseudo', width: 150},
    {name: 'email', index: 'email', width: 200},
    {name: 'firstname', index: 'firstname', width: 150}
  ],
  rowNum: 10,
  rowList: [10, 20, 30],
  pager: '#pager',
  sortname: 'id',
  viewrecords: true,
  sortorder: "desc",
  caption: "Users"
});

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Rails 项目的 Gemfile 中添加以下内容：

gem '2dc_jqgrid'

然后运行：

bundle install

4.2 手动安装

1. 下载 2dcJqgrid 插件。
2. 将插件文件放置在 Rails 项目的 vendor/plugins 目录下。
3. 运行生成器以创建一个示例网格：

   ./script/generate jqgrid user id pseudo email firstname
   

通过以上步骤，您可以成功安装并使用 2dcJqgrid 插件，为您的 Rails 应用程序添加强大的 jQuery 数据网格功能。