shen/KLineChart
1
0
Fork 0
mirror of https://github.com/klinecharts/KLineChart.git synced 2024-11-25 16:22:43 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
📈Lightweight k-line chart that can be highly customized. Zero dependencies. Support mobile.（可高度自定义的轻量级k线图，无第三方依赖，支持移动端）
1,099 Commits 5 Branches 88 Tags 60 MiB
TypeScript 75.2%
JavaScript 16.7%
HTML 8%
755cb573a1
Go to file
liihuu 755cb573a1 chore: logo
2023-12-09 01:48:14 +08:00
.github ci: deploy docs 2023-08-18 01:57:52 +08:00
.husky ci: git commit eslint 2022-07-08 00:41:27 +08:00
docs chore: logo 2023-12-09 01:48:14 +08:00
licenses ci: ci 2023-02-07 00:39:27 +08:00
scripts ci: .js change .cjs 2023-08-14 03:23:58 +08:00
src opt: opt candle.type: 'ohlc' render 2023-12-01 03:46:48 +08:00
tests Add test 2023-06-19 08:48:33 -05:00
.editorconfig ci: ci 2023-02-07 00:39:27 +08:00
.eslintignore docs: sample 2023-10-29 05:31:46 +08:00
.eslintrc.cjs ci: .js change .cjs 2023-08-14 03:23:58 +08:00
.gitignore docs: opt sample #494 2023-11-03 03:26:36 +08:00
CONTRIBUTING.md docs: contributing.md 2022-06-25 23:53:11 +08:00
index.js opt: opt event 2023-02-05 02:51:36 +08:00
LICENSE ci: ci 2023-02-07 00:39:27 +08:00
logo.svg chore: logo 2023-12-09 01:48:14 +08:00
NOTICE ci: ci 2023-02-07 00:39:27 +08:00
package.json docs: update 2023-11-28 02:54:39 +08:00
README.md chore: logo 2023-12-09 01:48:14 +08:00
README.zh-CN.md chore: logo 2023-12-09 01:48:14 +08:00
tsconfig.json fix: fix the introduction of typescript 2023-02-17 00:47:07 +08:00

README.md

KLineChart

English | 简体中文

💹📈 Lightweight k-line chart built with html5 canvas.

GitHub Workflow Status (with branch) Version Size npms.io (maintenance) Typescript LICENSE Docs

Github Issues Github Discussions Telegram Discord Wechat

✨ Features

  • 📦 Out of the box: Simple and fast integration, basically zero cost to get started.
  • 🚀 Lightweight and smooth: Zero dependencies, only 40k under gzip compression.
  • 💪 Powerful functions: Built-in multiple indicators and line drawing models.
  • 🎨 Highly scalable: With rich style configuration and API, the function can be extended as you like.
  • 📱 Mobile: Support mobile, one chart, handle multiple terminals.
  • 🛡 Typescript development: Provide complete type definition files.

⚡ Performance

Similar to chart libraries for performance comparison.

  • Test Scenario: 50000 pieces of data, 5 pane indicators, average 10 runs
  • Device: macOS Ventura, Apple M2 Pro, 16G
  • Browser: Chrome 114.0.5735.106
  • Framework: React@18.2.0

Comparison of time consumption from initialization to full rendering:

klinecharts@9.4.0 night-vision@0.3.2 hqchart@1.1.12147
37ms 36ms 241ms

📦 Install

Using npm

npm install klinecharts --save

Using yarn

yarn add klinecharts

CDNs

unpkg

<script type="text/javascript" src="https://unpkg.com/klinecharts/dist/klinecharts.min.js"></script>

jsDelivr

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/klinecharts/dist/klinecharts.min.js"></script>

📄 Docs

Online

https://www.klinecharts.com

Locale

Execute command in root directory. Node.js is required.

# Install the dependencies
npm install

# Start document service
npm run docs:dev

After successful startup, open in the browser http://localhost:8888 .

🛠️ Build

Execute command in root directory. Node.js is required.

# Install the dependencies
npm install

# Build files
npm run build

The generated files are in the dist folder.

🔗 Links

©️ License

KLineChart is available under the Apache License V2.