# SC-Reader

**Repository Path**: scofd/SC-Reader

## Basic Information

- **Project Name**: SC-Reader
- **Description**: WEB端OFD阅读赋能，完美与WEB系统的融合，支持本地和服务端OFD文件在线阅读。
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: http://www.scofd.com
- **GVP Project**: No

## Statistics

- **Stars**: 39
- **Forks**: 11
- **Created**: 2021-01-23
- **Last Updated**: 2025-05-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OFD版式文件WEB阅读器



### 介绍
SC-Reader是一款可运行在电脑、平板电脑、智能手机等多终端OFD版式文件阅读器。用户可通过PC端 Web浏览器、微信、QQ、支付宝、小程序浏览器等无差别查阅OFD版式文件，高度精确展现文件原始内容，完全杜绝文档格式错乱、失真等现象。使用便捷、高效，无需安装插件，整体代码小于2M，可与各种业务系统进行无缝融合。
SC-Reader OFD阅读器，文档渲染完美符合《GBT 33190-2016 电子文件存储与交换格式版式文档》规范，可加载本地磁盘、远端URL和业务侧服务端文件，服务端模式支持加密传输，文件不落地，轻松实现各种场景的OFD文档阅读赋能。
SC-Reader OFD阅读器支持、缩略图、大纲、语义树、注释、书签、图层、电子印章、验签、多文档、附件、元数据导出、打印等其他丰富的功能。同时API使用灵活可靠，并且只对对UI界面进行二次开发，满足用户体验。


### 特点

- 支持单包融合
- 无需安装插件
- 支持Retina屏
- 支持前后端文件阅读、使用
- 前端快速渲染，实现“秒开”阅读效果
- 简洁SDK，快速了解接口内容


### 能力清单

- 打印
- 缩略图
- 大纲
- 语义树
- 注释
- 书签
- 图层
- 验签
- 多文档
- 多级附件
- 元数据导出


### 安装教程

1.  引用主包

    `<script src="./SCOFDReader.umd.min.js"></script>`

2.  实例化阅读器，指定渲染容器

    `<div id="ofdview">我是渲染容器</div>`

3.  初始化

```
    let containerID="#ofdview";

    //创建一个阅读器
    //1234567 是授权码，可在文后二维码公号关注后领取，完全free

    let ofd = new SCOFDReader(containerID,'1234567',{options});

    //文件在服务器可设置服务端地址，本地阅读无需设置

    ofd.setFileServURL("http://ip:port/fs/");

```
### 初始化可选配置
```
  * @param {Object} options 配置项 
  * {
  *    //默认配置项
  *    ratio: 2,               //默认渲染倍率
  *    scale: 1,               //默认缩放比,
  *    rotate: 0,
  *    showTools: true,        //显示顶部工具栏 (全局)
  *    showState: true,        //显示状态栏 (全局)
  *    showOpenFile: false,    //无已打开文档时显示打开文件选项
  *    showContextMenu: true,  //显示右键菜单
  *    showDocListBar: true,   //在无打开文档的情况下也显示文件列表工具条
  *    size: {                 //阅读器工作区大小
  *       width: '100%',
  *       height: '100%'
  *    },
  *    mode:{
  *       view: 1,            //显示模式 {1:单页, 2:双页}
  *       scroll: 2,          //翻页模式 {1:单页, 2:连续}
  *       mouse: 1,           //鼠标样式 {1:默认, 2:抓手}
  *    },
  *    visibleOffset: 50,      //判定显示区域的偏移量(单位px)
  *    hclass: void 0,         //页面高亮层class名称
  * }
  * @return {void}
  */
```

**[在线体验](http://fp.scofd.com)** 

遇到任何问题，请加下方官方QQ群反馈，谢谢。

![avatar](QQ群二维码.png)

### 授权码免费领取

![avatar](领取License.jpg)

Copyright © 2021 youhong All Rights Reserved. [**友虹（北京）科技有限公司**](http://www.scofd.com/) 版权所有