Skip to content

samsonamosu/lightweight-charts

Repository files navigation

Lightweight Charts

TradingView Lightweight Chart is one of the smallest and high performative financial HTML5 charts.

Installing

es6 via npm

npm install --save lightweight-charts
import { createChart } from 'lightweight-charts';

const chart = createChart(document.body, { width: 400, height: 300 });
const lineSeries = chart.addLineSeries();
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 puts all exports from esm version to window.LightweightCharts:

const chart = LightweightCharts.createChart(document.body, { width: 400, height: 300 });
const lineSeries = chart.addLineSeries();
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 },
]);

Development

Compiling

  • npm run tsc - compiles source code only (without tests)
  • npm run tsc-watch - runs the TypeScript compiler in watch mode for source code (the same as tsc, but in watch mode)
  • npm run tsc-all - compiles everything (source code and tests)
  • npm run tsc-all-watch - runs the TypeScript compiler in watch mode for source code and tests (the same as tsc-all, but in watch mode)

Bundling

  • npm run rollup - runs Rollup to bundle code
  • npm run build - compiles source code and bundles it (a short-hand for npm run tsc && npm run rollup)

Note: by default only dev version is bundled. To bundle a production builds (minified) too just set NODE_ENV variable to production and run bundling. For example: NODE_ENV=production npm run rollup.

Testing

  • npm run lint - runs lint for the code
  • npm run test - runs unit-tests

Tips

To make sure that your local copy passed all (almost) checks, you can use a verify npm script: npm run verify.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file 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 the the Apache License, Version 2.0.

This license requires specifying TradingView as the product creator. You can use one of the following methods to do it:

  • do not disable the TradingView branding displaying;
  • add the "attribution notice" from the NOTICE file and a link to our website (https://www.tradingview.com/) to the page of your website or mobile application that is available to your users;

Packages

No packages published

Languages

  • TypeScript 89.3%
  • JavaScript 10.0%
  • Other 0.7%