Kline

> 本项目扒了某网站的K线插件做了一些封装和二次开发,使其更加便于使用和修改,方便后来的开发者. 修改主要涉及以下几个点:

• 使用 webpack 打包 css/images/html
• 使用 ES6 + Babel 对原有代码进行了拆分和重构
• 删除了一些不必要的逻辑
• 把源码中可配置的部分抽出来
• 添加了对 websocket(stomp over websocket) 连接方式的支持
• 增加对外接口及事件回调(2.0版新增)
• 增加对左右方向键的响应(2.0版新增)
• 增加对移动端的支持(2.1版新增)
• 支持由服务器端控制刷新间隔(2.1.3新增)

Features

✅ 支持两种主题配色切换
✅ 支持简体中文,英文,繁体中文三种语言
✅ 可配置的时间聚合方式
✅ 支持多种画线工具
✅ 支持多种画图算法
✅ 支持深度图数据及最近成交数据展示
✅ 支持普通轮询和Websocket Over Stomp两种连接方式
✅ 支持动态更新数据，支持读取历史数据
✅ 支持键盘事件
✅ 支持手势

ScreenShot!

Requirements

• jquery
• jquery.mousewheel
• sockjs (仅stomp方式需要)
• stomp (仅stomp方式需要)

Install & Load

安装

$ npm install kline

• 使用标签引入, 在HTML页面头部加入

• OR RequireJS

    require.config({
        paths: {
            "jquery": "../lib/jquery",
            "jquery.mousewheel": "../lib/jquery.mousewheel",
            "sockjs": "../lib/sockjs",
            "stomp": "../lib/stomp",
            "kline": "../js/kline"
        },
        shim: {
            "jquery.mousewheel": {
                deps: ["jquery"]
            },
            "kline": {
                deps: ["jquery.mousewheel", "sockjs", "stomp"]
            }
        }
    });

    require(['kline'], function () {
       // ...
    });

• OR CommonJS

    var Kline = require('kline');

• OR ES6

    import Kline from 'kline';

• 在页面中加入

  <div id="kline_container"></div>

Examples

• Poll(轮询)

    var kline = new Kline({
        element: "#kline_container",
        symbol: "BTC",
        symbolName: "比特币",
        type: "poll", // poll/stomp
        url: "./mock.json"
    });
    kline.draw();

• Stomp Over Websocket

   var kline = new Kline({
        element: "#kline_container",
        symbol: "BTC",
        symbolName: "比特币",
        type: "stomp", // poll/stomp
        url: 'https://127.0.0.1:8088/socket',
        subscribePath: "/kline/subscribe",
        sendPath: "/kline/send"
    });
    kline.draw();

Support Options

Methods

• draw()

  画K线图

kline.draw();

• resize(int width, int height)

  设置画布大小（可设置为0来自动获取窗口的宽度或高度）

kline.resize(1200, 550);

• setSymbol(string symbol, string symbolName)

  设置交易品种

kline.setSymbol('usd/btc', 'USD/BTC');

• setTheme(string style)

  设置主题

kline.setTheme('dark');  // dark/light

• setLanguage(string lang)

  设置语言

kline.setLanguage('en-us');  // en-us/zh-ch/zh-tw

• setShowTrade: function (isShow)

  设置展示是否展示交易模块

kline.setShowTrade(false);  // true/false

• toggleTrade: function ()

  切换展示是否展示交易模块

kline.toggleTrade();

• setIntervalTime: function (intervalTime)

  设置请求间隔时间(ms)

kline.setIntervalTime(5000);

• connect: function ()

  建立socket连接

kline.connect();

• disconnect: function ()

  断开socket连接

kline.disconnect();

• pause: function ()

  暂停请求数据

kline.pause();

• resend: function ()

  重新请求数据

kline.resend();

• switchIndic :function(status)

  开启或关闭监视器,本操作必须放在draw()之后

kline.switchIndic(true);
kline.switchIndic(false);
```javascript

* switchToolbar :function(status)

    开启或关闭工具栏,本操作必须放在draw()之后

kline.switchToolbar(true); kline.switchToolbar(false);

* sizeKline :function(isFullScreen)

    是否显示为全屏

kline.sizeKline(true); kline.sizeKline(false);

* switchRotate :function(rotate)

    设置翻转的角度，rotate是取值0~3,取值每增加1，就多翻转90度。

kline.switchRotate(0); kline.switchRotate(3);

* adjustScale :function(newScale)

    调整数据显示的缩放比例，正数为放大，负数为缩小

kline.adjustScale(-10); kline.adjustScale(10);

* switchMainChartStyle :function(newStyle)

    设置主图样式,可用的取值为：0~2，或样式名称如：CandleStick

kline.switchMainChartStyle(0); kline.switchMainChartStyle("CandleStick");

### Events

| 事件函数                 |   说明
|:-----------------------|:------------
| `onResize: function(width, height)`   | 画布尺寸改变时触发
| `onLangChange: function(lang)`   | 语言改变时触发
| `onSymbolChange: function(symbol, symbolName)`   | 交易品种改变时触发
| `onThemeChange: function(theme)`   | 主题改变时触发
| `onRangeChange: function(range)`   | 聚合时间改变时触发


> Example

```javascript
    var kline = new Kline({
        element: "#kline_container",
        symbol: "BTC",
        symbolName: "比特币",
        type: "poll", // poll/stomp
        url: "https://127.0.0.1:8080/mock.json",
        onResize: function(width, height) {
            console.log("chart resized: " + width + " " + height);
        }
    });

Request

• 表单的字段如下：
• symbol 标识符，用于指定币种或股票
• range 刷新的周期
• since 请求数据的起始时间（13位时间戳）（本字段与before互斥，取决于type）
• before 请求数据的最末时间（13位时间戳）（本字段与since互斥，取决于type）
• type 决定请求的类型，可选值为：history,realtime(区分大小写)
• prevTradeTime 最后一次交易的时间（13位时间戳）

Response

> Example

{
  "success": true,
  "data": {
    "lines": [
      [
        1.50790476E12,
        99.30597249871,
        99.30597249871,
        99.30597249871,
        99.30597249871,
        66.9905449283
      ]
    ],
    "trades": [
      {
        "amount": 0.02,
        "price": 5798.79,
        "tid": 373015085,
        "time": 1508136949000,
        "type": "buy"
      }
    ],
    "depths": {
      "asks": [
        [
          500654.27,
          0.5
        ]
      ],
      "bids": [
        [
          5798.79,
          0.013
        ]
      ]
    },
    "next": 3000
  }
}

• 响应参数说明:

• lines: K线图, 依次是: 时间(ms), 开盘价, 最高价, 最低价, 收盘价, 成交量

• depths(可选, 行情侧边栏显示): 深度图数据,  asks:一定比例的卖单列表, bids:一定比例的买单列表, 其中每项的值依次是 成交价, 成交量

• trades(可选, 行情侧边栏显示): 最近成交记录,  amount: 成交量, price:单价, tid:订单ID, time:成交时间(ms), type:成交类型 buy/sell

• next(可选（开启autoIntervalTime时必须有），下一次发起请求之前的等待事件，单位：毫秒)