https://github.com/nativescript-community/ui-chart
A powerful chart / graph plugin, supporting line, bar, pie, radar, bubble, and candlestick charts as well as scaling, panning and animations.
https://github.com/nativescript-community/ui-chart
Last synced: about 2 months ago
JSON representation
A powerful chart / graph plugin, supporting line, bar, pie, radar, bubble, and candlestick charts as well as scaling, panning and animations.
- Host: GitHub
- URL: https://github.com/nativescript-community/ui-chart
- Owner: nativescript-community
- License: apache-2.0
- Created: 2019-12-28T20:53:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-22T14:40:23.000Z (over 1 year ago)
- Last Synced: 2025-03-30T18:08:22.986Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://nativescript-community.github.io/ui-chart/
- Size: 16.3 MB
- Stars: 34
- Watchers: 5
- Forks: 11
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-nativescript - UI Chart - A powerful chart / graph plugin, supporting line, bar, pie, radar, bubble, and candlestick charts as well as scaling, panning and animations. (Plugins / UI Plugins)
README
[](https://www.npmjs.com/package/@nativescript-community/ui-chart)
[](https://www.npmjs.com/package/@nativescript-community/ui-chart)
[](https://github.com/nativescript-community/ui-chart/network)
[](https://github.com/nativescript-community/ui-chart/stargazers)
[](#installation)
## Installation
- `tns plugin add @nativescript-community/ui-chart`
---
[](#migration-to-2x)
## Migration to 2.x
In 2.x most methods like `setColor`/`getColor` have been changed to properties like `color`
You can either to it manually and update them all (you should get tsc errors for removed or renamed methods), or you can use a regexp like `/set([A-Z])(\w*?)\(/` to search and replace (first group should be lowercase in the replace) with something like `\L$1$2=(`
Then use typings to fix potential name change
[](#usage)
## Usage
For gestures to work, make sure to add the following code block inside main application file (e.g. app.ts):
```typescript
import { install } from '@nativescript-community/ui-chart';
install();
```
You can also check [Wiki](https://github.com/nativescript-community/ui-chart/wiki) for any useful material.
[](#plain-nativescript)
## Plain NativeScript
IMPORTANT: Make sure you include `xmlns:ch="@nativescript-community/ui-chart"` on the Page element.
### XML
```XML
```
### TypeScript
```typescript
import { LineChart } from '@nativescript-community/ui-chart/charts/LineChart';
import { LineDataSet } from '@nativescript-community/ui-chart/data/LineDataSet';
import { LineData } from '@nativescript-community/ui-chart/data/LineData';
export function onLineChartLoaded(args) {
const chart = args.object as LineChart;
chart.dragEnabled = true;
chart.scaleEnabled = true;
const data = new Array(500).fill(0).map((v, i) => ({
index: i,
value: Math.random() * 1,
}));
const sets = [];
const set = new LineDataSet(data, 'Legend Label', 'index', 'value');
set.color = 'blue';
sets.push(set);
// Create a data object with the data sets
const ld = new LineData(sets);
// Set data
chart.data = ld;
}
```
[](#nativescript--vue)
## NativeScript + Vue
```javascript
Vue.registerElement('LineChart', () => require('@nativescript-community/ui-chart').LineChart);
```
```html
```
```javascript
import { LineChart } from '@nativescript-community/ui-chart/charts/LineChart';
import { LineDataSet } from '@nativescript-community/ui-chart/data/LineDataSet';
import { LineData } from '@nativescript-community/ui-chart/data/LineData';
```
```javascript
onChartLoaded() {
const chart = this.$refs.chart['nativeView'] as LineChart;
chart.backgroundColor = 'white';
chart.drawGridBackground = false;
// enable scaling and dragging
chart.dragEnabled = true;
chart.scaleEnabled = true;
// force pinch zoom along both axis
chart.petPinchZoomEnabled = true;
// disable dual axis (only use LEFT axis)
chart.axisRight.enabled = false;
const myData = new Array(500).fill(0).map((v, i) => ({
index: i,
value: Math.random() * 1,
}));
const sets = [];
const set = new LineDataSet(myData, 'Legend Label', 'index', 'value');
set.setColor('blue');
sets.push(set);
// Create a data object with the data sets
const ld = new LineData(sets);
// Set data
chart.data = ld;
}
```
[](#nativescript--angular)
## NativeScript + Angular
Register the element in app.module.ts
```javascript
registerElement('LineChart', () => require('@nativescript-community/ui-chart').LineChart);
```
```html
```
```javascript
import { LineChart } from '@nativescript-community/ui-chart/charts/LineChart';
import { LineDataSet } from '@nativescript-community/ui-chart/data/LineDataSet';
import { LineData } from '@nativescript-community/ui-chart/data/LineData';
```
```javascript
onChartLoaded(args) {
const chart = args.object as LineChart;
chart.backgroundColor = 'white';
chart.drawGridBackground = false;
// enable scaling and dragging
chart.dragEnabled = true;
chart.scaleEnabled = true;
// force pinch zoom along both axis
chart.petPinchZoomEnabled = true;
// disable dual axis (only use LEFT axis)
chart.axisRight.enabled = false;
const myData = new Array(500).fill(0).map((v, i) => ({
index: i,
value: Math.random() * 1,
}));
const sets = [];
const set = new LineDataSet(myData, 'Legend Label', 'index', 'value');
set.color = 'blue';
sets.push(set);
// Create a data object with the data sets
const ld = new LineData(sets);
// Set data
chart.data = ld;
}
```
[](#about)
## About
This plugin is based on [MPAndroidChart](https://github.com/PhilJay/MPAndroidChart), a powerful & easy to use chart library. Therefore, special thanks goes to Philipp Jahoda, the creator of [MPAndroidChart](https://github.com/PhilJay/MPAndroidChart) and the rest of his team.
Instead of directly importing existing native libraries, this library has been rewritten in TypeScript, using [@nativescript-community/ui-canvas](https://github.com/nativescript-community/ui-canvas) plugin API as a basis. Plugin 'ui-canvas' is an extremely powerful tool that converts Android Native Canvas API to a cross-platform API for NativeScript framework. In few words, 'ui-chart' has the same code-base for both Android and iOS.
Additionally, [@nativescript-community/gesturehandler](https://github.com/nativescript-community/gesturehandler) plugin is used for handling chart gestures.
In short, these are the benefits of rewriting library into a NativeScript plugin:
- Same codebase for Android and iOS. Makes maintaining the library very easy.
- Smaller apps size because there are no native libs or native frameworks to consume space. All done with the power of {N}
Originally, the main goal was to prevent the need for marshalling all datasets. This is extremely heavy, costly and unnecessary!
Upon running demo samples, one can conclude it is the fastest drawing library, in comparison to `nativescript-ui-chart` and `nativescript-mpchart`.
That is because:
- It does not marshal or recreate any subset of the data sets, but directly uses the provided array instead
- It can share the same data array between multiple datasets
- It can still use the power of native arrays to NOT marshal arrays of positions while drawing lines with [@nativescript-community/ui-canvas](https://github.com/nativescript-community/ui-canvas)
[](#documentation)
## Documentation
The NativeScript 'ui-chart' plugin is based on the [MPAndroidChart](https://github.com/PhilJay/MPAndroidChart) library.
In few words, its API is identical. The possibility to add API reference will be considered in the future.
[](#demos-and-development)
## Demos and Development
### Repo Setup
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
```
git submodule update --init
```
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
To develop and test:
if you use `yarn` then run `yarn`
if you use `pnpm` then run `pnpm i`
**Interactive Menu:**
To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
### Build
```bash
npm run build.all
```
WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
### Demos
```bash
npm run demo.[ng|react|svelte|vue].[ios|android]
npm run demo.svelte.ios # Example
```
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
You can start from the `install.ts` of each flavor to see how to register new demos
[](#contributing)
## Contributing
### Update repo
You can update the repo files quite easily
First update the submodules
```bash
npm run update
```
Then commit the changes
Then update common files
```bash
npm run sync
```
Then you can run `yarn|pnpm`, commit changed files if any
### Update readme
```bash
npm run readme
```
### Update doc
```bash
npm run doc
```
### Publish
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
Simply run
```shell
npm run publish
```
### modifying submodules
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
One easy solution is t modify `~/.gitconfig` and add
```
[url "ssh://git@github.com/"]
pushInsteadOf = https://github.com/
```
[](#questions)
## Questions
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).