lightweight-charts README

The project's README from github.com/tradingview/lightweight-charts. As one markdown file: README.md.

Lightweight Charts logo

Lightweight Charts™

CircleCI npm version npm bundle size Dependencies count Downloads pkg.pr.new

Demos | Documentation | Reddit

TradingView Lightweight Charts™ are one of the smallest and fastest financial HTML5 charts.

The Lightweight Charts™ library is the best choice for you if you want to display financial data as an interactive chart on your web page without affecting your web page loading speed and performance.

It is the best choice for you if you want to replace static image charts with interactive ones. The size of the library is close to static images but if you have dozens of image charts on a web page then using this library can make the size of your web page smaller.

Take a look at awesome-tradingview for related projects created by our community members.

The library provides a rich set of charting capabilities out of the box, but developers can also extend its functionality by building custom plugins. See the interactive plugin examples here, or check out plugin-examples/README.md for more details.

Installing

es6 via npm

npm install lightweight-charts

Latest master build

To try the latest master build without waiting for a release (powered by pkg.pr.new):

npm install https://pkg.pr.new/lightweight-charts@master

The import and usage below applies to both npm installation options:

import { createChart, LineSeries } from 'lightweight-charts';

const chart = createChart(document.body, { width: 400, height: 300 });
const lineSeries = chart.addSeries(LineSeries);
lineSeries.setData([
    { time: '2019-04-11', value: 80.01 },
    { time: '2019-04-12', value: 96.63 },
    { time: '2019-04-13', value: 76.64 },
    { time: '2019-04-14', value: 81.89 },
    { time: '2019-04-15', value: 74.43 },
    { time: '2019-04-16', value: 80.01 },
    { time: '2019-04-17', value: 96.63 },
    { time: '2019-04-18', value: 76.64 },
    { time: '2019-04-19', value: 81.89 },
    { time: '2019-04-20', value: 74.43 },
]);

CDN

You can use unpkg:

https://unpkg.com/lightweight-charts/dist/lightweight-charts.standalone.production.js

The standalone version creates window.LightweightCharts object with all exports from esm version:

const chart = LightweightCharts.createChart(document.body, { width: 400, height: 300 });
const lineSeries = chart.addSeries(LightweightCharts.LineSeries);
lineSeries.setData([
    { time: '2019-04-11', value: 80.01 },
    { time: '2019-04-12', value: 96.63 },
    { time: '2019-04-13', value: 76.64 },
    { time: '2019-04-14', value: 81.89 },
    { time: '2019-04-15', value: 74.43 },
    { time: '2019-04-16', value: 80.01 },
    { time: '2019-04-17', value: 96.63 },
    { time: '2019-04-18', value: 76.64 },
    { time: '2019-04-19', value: 81.89 },
    { time: '2019-04-20', value: 74.43 },
]);

Build Variants

Dependencies included Mode ES module IIFE (window.LightweightCharts)
No PROD lightweight-charts.production.mjs N/A
No DEV lightweight-charts.development.mjs N/A
Yes (standalone) PROD lightweight-charts.standalone.production.mjs lightweight-charts.standalone.production.js
Yes (standalone) DEV lightweight-charts.standalone.development.mjs lightweight-charts.standalone.development.js

AI coding assistants

This repository ships an Agent Skill that teaches AI coding assistants how to work with Lightweight Charts™ - the v5 API conventions, the mental model, and the common time, scale, marker, plugin, and wrapper foot-guns.

Install it into your project with the skills CLI:

npx skills add https://github.com/tradingview/lightweight-charts

This makes the skill available to compatible assistants (such as Claude Code, Codex, etc.), streamlining your workflow: they scaffold charts, wire up series and data, and answer API questions against the current v5 conventions out of the box - instead of relying on outdated snippets and stumbling into common foot-guns.

Development

See BUILDING.md for instructions on how to build lightweight-charts from source.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at LICENSE file. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

This software incorporates several parts of tslib (https://github.com/Microsoft/tslib, (c) Microsoft Corporation) that are covered by BSD Zero Clause License.

This license requires specifying TradingView as the product creator. You shall add the "attribution notice" from the NOTICE file and a link to https://www.tradingview.com/ to the page of your website or mobile application that is available to your users. As thanks for creating this product, we'd be grateful if you add it in a prominent place. You can use the attributionLogo chart option for displaying an appropriate link to https://www.tradingview.com/ on the chart itself, which will satisfy the link requirement.

lightweight-charts (tradingview/lightweight-charts)

Searching Database…

这是什么?TradingView Lightweight Charts 是一个开源库,提供用 HTML5 canvas 绘制的非常小巧、快速的金融图表,用于在网页上以交互式图表的形式展示金融数据。
这是完整的 TradingView 平台,还是只是图表部分?只是图表部分:一个可以嵌入你自己网页的 JavaScript/TypeScript 库,不是 TradingView 终端,也不是托管服务。另外也提供独立的浏览器构建版本。
我怎么把它添加到网页上?通过 npm 安装(es6 导入),或从 unpkg 加载独立构建版本,后者会暴露 window.LightweightCharts 全局变量;生产和开发两种变体分别有自带依赖和不带依赖的版本。
Apache 2.0 许可证可以免费无限制地使用吗?基本可以:但你必须在页面上注明 TradingView 的出处,即添加 NOTICE 文件中的归属声明和一个指向 TradingView 的链接——图表选项里的 attributionLogo 会直接在图表上绘制标识,用它就能满足链接要求。
这个库到底有多大?它的体积接近静态图片图表,而且一个包含几十个图片图表的页面,换成这个库之后体积反而可能更小。
除了内置功能,我还能自定义图表吗?可以。它开箱即带丰富的图表功能,开发者还可以通过自定义插件来扩展——仓库的 plugin-examples 文件夹里有可交互的插件示例。
随附的面向 AI 编程助手的 Agent Skill 是干什么的?仓库自带一个技能,用来教 Claude Code 和 Codex 这类 AI 助手掌握 v5 API 的约定,以及时间、刻度、标记、插件和封装方面常见的坑,让它们生成能直接运行的图表代码,而不是套用过时的片段。用 skills CLI 即可安装。
我可以试用还没正式发布的改动吗?可以——最新的 master 构建会通过 pkg.pr.new 发布,所以你不用等官方发版就能试用最新版本。
What are similar projects?Chart.js, Vela, uPlot, d3, echarts, victory, plotly.js, bokeh
Size
204 MB
Stars
17.6K
Age
7y
Commits · 90 Days